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}

export class Attachment
{
    public AttachmentId: string;
    public TableName: string;
    public FieldName: string;
    public RecordId: number;
    public AttachmentName: string;
    public MimeType: string;
    public AttachmentData: string = [];
    public FileSizeInKB: number;
    public CreatedDate: string;
    public CreatedBy: string;
    public NeedsOCR: boolean;
    public OCRDate: string;
    public IsSecurities: boolean;
    public AWSKey: string;
    public PresignedUrl: string;

    public constructor(init?: Partial<Attachment>) { (Object as any).assign(this, init); }
}

export class AttachmentResponse
{
    public ResponseStatus: ResponseStatus;
    public Attachment: Attachment[] = [];

    public constructor(init?: Partial<AttachmentResponse>) { (Object as any).assign(this, init); }
}

export class RecordAttachmentRequest
{
    public TableName: string;
    public FieldName: string;
    public RecordId: number;

    public constructor(init?: Partial<RecordAttachmentRequest>) { (Object as any).assign(this, init); }
}

TypeScript RecordAttachmentRequest DTOs

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AttachmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Attachment>
    <Attachment>
      <AWSKey>String</AWSKey>
      <AttachmentData>AA==</AttachmentData>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedBy>String</CreatedBy>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <FieldName>String</FieldName>
      <FileSizeInKB>0</FileSizeInKB>
      <IsSecurities>false</IsSecurities>
      <MimeType>String</MimeType>
      <NeedsOCR>false</NeedsOCR>
      <OCRDate>0001-01-01T00:00:00</OCRDate>
      <PresignedUrl>String</PresignedUrl>
      <RecordId>0</RecordId>
      <TableName>String</TableName>
    </Attachment>
  </Attachment>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AttachmentResponse>