POST Agents/EMail/GetPreviewAttachmentFromDocId

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/EMail/GetPreviewAttachmentFromDocId

Retrieve an attachment from an e-mail stored in the document archive.

The returned data is intended to be use for a preview.

Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered.

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/EMail/GetPreviewAttachmentFromDocId?$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

DocId, AttachmentId

Property Name Type Description
DocId Integer
AttachmentId String

Response:

OK

Response Description
200 OK

Response body: EMailAttachment

Property Name Type Description
Description string Name/description
Filename string Filename
Size int32 Size of attachment
Type string Attachment Content-Type
Encoding string Content-Transfer-Encoding
Id string Content-ID
Disposition string Content-Disposition
IsSafeFileExtension bool If the user should be allowed to download and perform other actions on the attachment.
Stream byte Binary stream for outgoing attachments. This property will not be populated for existing e-mail items.
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/EMail/GetPreviewAttachmentFromDocId
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "DocId": 343,
  "AttachmentId": "magni"
}

Sample response

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

{
  "Description": "Vision-oriented demand-driven capacity",
  "Filename": "temporibus",
  "Size": 509,
  "Type": "quis",
  "Encoding": "numquam",
  "Id": "nostrum",
  "Disposition": "nemo",
  "IsSafeFileExtension": false,
  "Stream": "GIF89....File contents as raw bytes...",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 305
    }
  }
}