MessageAttachment

Create MessageAttachment

Creates a new MessageAttachment

SecurityapiKeyAuth
Request
header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Request Body schema:
required
messageAttachment_Key
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

file_Name
string or null <= 128 characters
file_Type
string or null <= 32 characters
message_Attachment
string or null <byte>
message_Key
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/messageAttachments
Request samples
{
  • "messageAttachment_Key": 0,
  • "file_Name": "string",
  • "file_Type": "string",
  • "message_Attachment": "string",
  • "message_Key": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MessageAttachment

Lists all MessageAttachment

SecurityapiKeyAuth
Request
query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/messageAttachments
Request samples 
Response samples 
No sample
Get MessageAttachment
Gets MessageAttachment


SecurityapiKeyAuth 
Request 
path Parameters
MessageAttachment_Key
required
integer <int32> 
MessageAttachment Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/messageAttachments/{MessageAttachment_Key}
Request samples 
Response samples 
No sample
Update MessageAttachment
Updates a specific MessageAttachment.


SecurityapiKeyAuth 
Request 
path Parameters
MessageAttachment_Key
required
integer <int32> 
MessageAttachment Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
messageAttachment_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
file_Name
string or null  <= 128 characters 
 
file_Type
string or null  <= 32 characters 
 
message_Attachment
string or null <byte> 
 
message_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/messageAttachments/{MessageAttachment_Key}
Request samples 
{
  • "messageAttachment_Key": 0,
  • "file_Name": "string",
  • "file_Type": "string",
  • "message_Attachment": "string",
  • "message_Key": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MessageAttachment
Deletes an MessageAttachment


SecurityapiKeyAuth 
Request 
path Parameters
MessageAttachment_Key
required
integer <int32> 
MessageAttachment Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/messageAttachments/{MessageAttachment_Key}
Request samples 
Create or Update Batch MessageAttachment
Create or Update multiple MessageAttachment at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth 
Request 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
 Array 
messageAttachment_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
file_Name
string or null  <= 128 characters 
 
file_Type
string or null  <= 32 characters 
 
message_Attachment
string or null <byte> 
 
message_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


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