Note Attachments

Create NoteAttachment

Creates a new NoteAttachment

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
attachment_Key
required
integer <int32>

Key value identifying an attachment to a note Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

attachment
string or null <byte>

Attachment data assocaited with a note

attachment_File
string or null <= 255 characters

Name of the file that has been uploaded as an attachment.

attachment_Path
string or null <= 500 characters

Path of the file that has been uploaded as an attachment.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

note_Key
required
integer <int32>

Key value identifying the note that attachment is associated with Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/note-attachments
Request samples
{
  • "attachment_Key": 0,
  • "attachment": "string",
  • "attachment_File": "string",
  • "attachment_Path": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List NoteAttachment

Lists all NoteAttachment for the given noteKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
noteKey
required
integer <int32>

Note Key

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/note-data/{noteKey}/note-attachments
Request samples 
Response samples 
No sample
Get NoteAttachment
Gets NoteAttachment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
attachmentKey
required
integer <int32> 
Attachment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/note-attachments/{attachmentKey}
Request samples 
Response samples 
No sample
Update NoteAttachment
Updates a specific NoteAttachment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
attachmentKey
required
integer <int32> 
Attachment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
attachment_Key
required
integer <int32> 
Key value identifying an attachment to a note  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
attachment
string or null <byte> 
Attachment data assocaited with a note


 
attachment_File
string or null  <= 255 characters 
Name of the file that has been uploaded as an attachment.


 
attachment_Path
string or null  <= 500 characters 
Path of the file that has been uploaded as an attachment.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
note_Key
required
integer <int32> 
Key value identifying the note that attachment is associated with  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/note-attachments/{attachmentKey}
Request samples 
{
  • "attachment_Key": 0,
  • "attachment": "string",
  • "attachment_File": "string",
  • "attachment_Path": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete NoteAttachment
Deletes an NoteAttachment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
attachmentKey
required
integer <int32> 
Attachment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/note-attachments/{attachmentKey}
Request samples 
Create or Update Batch NoteAttachment
Create or Update multiple NoteAttachment at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
attachment_Key
required
integer <int32> 
Key value identifying an attachment to a note  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
attachment
string or null <byte> 
Attachment data assocaited with a note


 
attachment_File
string or null  <= 255 characters 
Name of the file that has been uploaded as an attachment.


 
attachment_Path
string or null  <= 500 characters 
Path of the file that has been uploaded as an attachment.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
note_Key
required
integer <int32> 
Key value identifying the note that attachment is associated with  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/note-attachments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}