POST Agents/Ticket/GetAttachmentPreview

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Ticket/GetAttachmentPreview

Retrieve an attachment from ticket message.

The returned data is intended to be used for a preview. The returned data is sanitized. NsApiSlow threshold: 2000 ms.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Ticket/GetAttachmentPreview?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

AttachmentId

Property Name Type Description
AttachmentId Integer

Response:

OK

Response Description
200 OK

Response body: AttachmentPreview

Property Name Type Description
Name string Name of the attachment file
MimeType string The mimetype of the attachment
Size int32 Size of the attachment in bytes
Content byte Attachment data
EmailSubject string Subject of the attached RFC822 email. Null for non-RFC822 attachment
EmailFrom string From field of the attached RFC822 email. Null for non-RFC822 attachment
EmailTo string To field of the attached RFC822 email. Null for non-RFC822 attachment
EmailCc string Cc field of the attached RFC822 email. Null for non-RFC822 attachment
EmailDate date-time Date of the attached RFC822 email. Default DateTime value for non-RFC822 attachment
EmailAttachmentsInfo array The attachments inside the attached RFC822 email. Empty array for non-RFC822 attachment
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Ticket/GetAttachmentPreview
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "AttachmentId": 658
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Name": "Walker Inc and Sons",
  "MimeType": "ipsum",
  "Size": 562,
  "Content": "GIF89....File contents as raw bytes...",
  "EmailSubject": "jordy@parisian.ca",
  "EmailFrom": "beverly@wiza.uk",
  "EmailTo": "ruthie.schuster@hills.com",
  "EmailCc": "elbert.padberg@kiehnmoore.biz",
  "EmailDate": "2011-06-07T02:30:48.0538071+02:00",
  "EmailAttachmentsInfo": [
    {
      "AttachmentId": 811,
      "Name": "Bradtke, Schmeler and Ratke",
      "ContentType": "alias",
      "AttSize": 930,
      "InlineImage": true,
      "ContentId": "rerum",
      "AuthKey": "excepturi",
      "IsSafeFileExtension": false,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 158
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 627
    }
  }
}