Case Attachments

Create CaseAttachment

Creates a new CaseAttachment

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
caseAttachment_Key
required
integer <int32>

Identifier for the Case Attachment 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>

Where the Attachment is stored within the database

attachment_File
string or null <= 255 characters

the File Name for the Case Attachment

attachment_Path
string or null <= 500 characters

The Path for the Case Attachment

caseAttachment_Type
string or null <= 256 characters

What type of Attachment this is

case_Key
required
integer <int32>

Identifier of the case. This is the Case that has the attachment 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.

comment
string or null <= 2048 characters

User Managed field that displays the Comment for this 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

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/case-attachments
Request samples
{
  • "caseAttachment_Key": 0,
  • "attachment": "string",
  • "attachment_File": "string",
  • "attachment_Path": "string",
  • "caseAttachment_Type": "string",
  • "case_Key": 0,
  • "comment": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CaseAttachment

Lists all CaseAttachment

SecurityapiKeyAuth and bearerAuth
Request
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/case-attachments
Request samples 
Response samples 
No sample
Get CaseAttachment
Gets CaseAttachment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CaseAttachment_Key
required
integer <int32> 
CaseAttachment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/case-attachments/{CaseAttachment_Key}
Request samples 
Response samples 
No sample
Update CaseAttachment
Updates a specific CaseAttachment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CaseAttachment_Key
required
integer <int32> 
CaseAttachment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
caseAttachment_Key
required
integer <int32> 
Identifier for the Case Attachment  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> 
Where the Attachment is stored within the database


 
attachment_File
string or null  <= 255 characters 
the File Name for the Case Attachment


 
attachment_Path
string or null  <= 500 characters 
The Path for the Case Attachment


 
caseAttachment_Type
string or null  <= 256 characters 
What type of Attachment this is


 
case_Key
required
integer <int32> 
Identifier of the case. This is the Case that has the attachment  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.


 
comment
string or null  <= 2048 characters 
User Managed field that displays the Comment for this 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


 
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/case-attachments/{CaseAttachment_Key}
Request samples 
{
  • "caseAttachment_Key": 0,
  • "attachment": "string",
  • "attachment_File": "string",
  • "attachment_Path": "string",
  • "caseAttachment_Type": "string",
  • "case_Key": 0,
  • "comment": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CaseAttachment
Deletes an CaseAttachment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CaseAttachment_Key
required
integer <int32> 
CaseAttachment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/case-attachments/{CaseAttachment_Key}
Request samples 
Create or Update Batch CaseAttachment
Create or Update multiple CaseAttachment 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 
caseAttachment_Key
required
integer <int32> 
Identifier for the Case Attachment  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> 
Where the Attachment is stored within the database


 
attachment_File
string or null  <= 255 characters 
the File Name for the Case Attachment


 
attachment_Path
string or null  <= 500 characters 
The Path for the Case Attachment


 
caseAttachment_Type
string or null  <= 256 characters 
What type of Attachment this is


 
case_Key
required
integer <int32> 
Identifier of the case. This is the Case that has the attachment  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.


 
comment
string or null  <= 2048 characters 
User Managed field that displays the Comment for this 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


 
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/case-attachments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}