GET Attachment/{id}

Some tooltip text!

• 3 minutes to read

 • 3 minutes to read

GET /api/v1/Attachment/{id}

Gets a AttachmentEntity object.

Calls the Ticket agent service GetAttachmentEntity. NsApiSlow threshold: 5000 ms.

Path Part	Type	Description
id	int32	The id of the AttachmentEntity to return. Required

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.

GET /api/v1/Attachment/{id}?$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
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.

Response:

AttachmentEntity found.

Response	Description
200	AttachmentEntity found.
404	Not Found.

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

GET /api/v1/Attachment/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 AttachmentEntity found.
Content-Type: application/json; charset=utf-8

{
  "AttachmentId": 978,
  "Name": "Bosco-Bradtke",
  "ContentType": "consectetur",
  "AttSize": 602,
  "InlineImage": false,
  "ContentId": "optio",
  "AuthKey": "alias",
  "IsSafeFileExtension": false,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 817
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}