Trendsic Platform Service

<back to all web services

RecordAttachmentRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Attachment/{TableName}/{FieldName}/{RecordId}
RecordAttachmentRequest Parameters:
NameParameterData TypeRequiredDescription
TableNamepathstringNo
FieldNamepathstringNo
RecordIdpathintNo
AttachmentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AttachmentformList<Attachment>No
Attachment Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdformGuidNo
TableNameformstringNo
FieldNameformstringNo
RecordIdformintNo
AttachmentNameformstringNo
MimeTypeformstringNo
AttachmentDataformbyte[]No
FileSizeInKBformdoubleNo
CreatedDateformDateTimeNo
CreatedByformstringNo
NeedsOCRformboolNo
OCRDateformDateTimeNo
IsSecuritiesformboolNo
AWSKeyformstringNo
PresignedUrlformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	]
}