| GET,OPTIONS | /v1/Attachment/{TableName}/{FieldName}/{RecordId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TableName | path | string | No | |
| FieldName | path | string | No | |
| RecordId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Attachment | form | List<Attachment> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttachmentId | form | Guid | No | |
| TableName | form | string | No | |
| FieldName | form | string | No | |
| RecordId | form | int | No | |
| AttachmentName | form | string | No | |
| MimeType | form | string | No | |
| AttachmentData | form | byte[] | No | |
| FileSizeInKB | form | double | No | |
| CreatedDate | form | DateTime | No | |
| CreatedBy | form | string | No | |
| NeedsOCR | form | bool | No | |
| OCRDate | form | DateTime | No | |
| IsSecurities | form | bool | No | |
| AWSKey | form | string | No | |
| PresignedUrl | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/Attachment/{TableName}/{FieldName}/{RecordId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Attachment:
[
{
AttachmentId: 00000000000000000000000000000000,
TableName: String,
FieldName: String,
RecordId: 0,
AttachmentName: String,
MimeType: String,
AttachmentData: AA==,
FileSizeInKB: 0,
CreatedDate: 0001-01-01,
CreatedBy: String,
NeedsOCR: False,
OCRDate: 0001-01-01,
IsSecurities: False,
AWSKey: String,
PresignedUrl: String
}
]
}