POST Attachment

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Attachment

Creates a new AttachmentEntity

Calls the Ticket agent service SaveAttachmentEntity.

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/Attachment?$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: newEntity

The AttachmentEntity to be saved.

Property Name Type Description
AttachmentId Integer The primary key (auto-incremented)
Name String The filename for the attachment.
ContentType String The content type for the attachment (e.g. 'applaction/octet-stream' or 'application/vnd.openxmlformats-officedocument.wordprocessingml.document').
AttSize Integer The size (in bytes) for the attachment.
InlineImage Boolean True if this attachment is inlined in the html_body.
ContentId String The content_id of this attachment, used for inline images
AuthKey String The key used for authenticating access to this attachment.
IsSafeFileExtension Boolean Is file considered to be safe (based on extension and settings)

Response:

OK

Response Description
200 OK

Response body: AttachmentEntityWithLinks

Property Name Type Description
AttachmentId int32 The primary key (auto-incremented)
Name string The filename for the attachment.
ContentType string The content type for the attachment (e.g. 'applaction/octet-stream' or 'application/vnd.openxmlformats-officedocument.wordprocessingml.document').
AttSize int32 The size (in bytes) for the attachment.
InlineImage bool True if this attachment is inlined in the html_body.
ContentId string The content_id of this attachment, used for inline images
AuthKey string The key used for authenticating access to this attachment.
IsSafeFileExtension bool Is file considered to be safe (based on extension and settings)
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.
_Links object

Sample request

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

{
  "AttachmentId": 927,
  "Name": "Mosciski Group",
  "ContentType": "corporis",
  "AttSize": 664,
  "InlineImage": false,
  "ContentId": "est",
  "AuthKey": "praesentium",
  "IsSafeFileExtension": false
}

Sample response

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

{
  "AttachmentId": 899,
  "Name": "Reichert, Kuhic and Stroman",
  "ContentType": "est",
  "AttSize": 398,
  "InlineImage": false,
  "ContentId": "dolores",
  "AuthKey": "et",
  "IsSafeFileExtension": true,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 430
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/contact/321",
    "Archive": "https://www.example.com/api/v1/contact"
  }
}