Skip to content

Get Attachment List

Method: GET

Url: /Attachments
Header: DPApiAuthenticationToken={YOUR_API_TOKEN}

Query String:

Parameter NameData TypeDescription
IncidentID (required)IntegerThe ID of the Incident to get attachments for
AttachmentID (optional)IntegerTo filter attachments by specific AttachmentID
Default: -1
FileName (optional)StringTo filter attachments by File Name
Default: Empty String
ShortDescription (optional)StringTo filter attachments by Short Description
Default: Empty String
DateCreatedFrom (optional)DateTimeTo filter attachments by DateCreated starting from
Default: Null
DateCreatedTo (optional)DateTimeTo filter attachments by DateCreated ending with
Default: Null
JMS_Query (optional)StringAny SQL-compliant string to filter the records as explained here.

If the query contains any special or reserved characters, it must be properly escaped

Default: Empty string
Example: FileName^=^”Test.jpg”
PageNumber (optional)IntegerThe number of page to retrieve considering the PageSize parameter.

Default: 1
Example: 4
PageSize (optional)IntegerThe number of records to retrieve per request.

The page size cannot exceed the limit set for your account by Dataprise, which is usually around 100 records per request.

Default: 20
Example: 25
SortBy (optional)StringThe field name to sort the response by.

Default: Empty string
Example: FirstName
SortOrder (optional)StringSort order. Can be either “ASC” or “DESC” or empty string denoting “ASC”.

Default: Empty string
Example: DESC
tbl_columns (optional)StringA comma separated string containing the names of the columns to retrieve, instead of all columns.

Default: Empty string
Example: FirstName, LastName, EmailAddress
Request Examples:
Using Filter Parameters:
GET “ “DPApiAuthenticationToken=abcxyz0123456789”
Using JMS_Query:
GET “^=^”Test.jpg””Header: “DPApiAuthenticationToken=abcxyz0123456789”
Paging & Sorting:
GET “”Header: “DPApiAuthenticationToken=abcxyz0123456789”


The API will return the list of matching attachments for the incidents for your organization in JSON format. The response will by default contain the following fields for each record, however you can change that using the “tbl_columns” request parameter as mentioned above.

Column NameData TypeRemarks
AttachmentIDIntegerThe unique ID of the record.
IncidentIDIntegerThe ID of the incident
FileNameStringThe file name
FileTypeStringThe file type
FileUrlStringThe URL of the file
ShortDescriptionStringShort description of the attachment
ImageThumbnailStringA base64 string containing the image thumbnail if the file type is an image
TotalCountIntegerTotal number of records available for the specified query
CustomFieldsList<CustomField>List of custom fields (key-value pair) for this record
Sample Response:
{ “TotalCount”: 14, “Rows”: [ { “AttachmentID”: 710, “FileName”: “Test Orange.jpg”, “DateCreated”: “2020-01-02T16:19:41.447”, “CreatedBy”: “Eisner, D.”, “File”: “”, “IncidentID”: 342510, “ImageThumbnail”: “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYAooooA/9k=”, “FileType”: “image/jpeg”, “FileURL”: “”, “ShortDescription”: “Test orange by object from API”, “TotalCount”: 5, “CustomFields”: null }, { “AttachmentID”: 709, “FileName”: “Test Orange.jpg”, “DateCreated”: “2020-01-02T16:15:58.917”, “CreatedBy”: “Eisner, D.”, “File”: “”, “IncidentID”: 342510, “ImageThumbnail”: “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAooooA/9k=”, “FileType”: “image/jpeg”, “FileURL”: “”, “ShortDescription”: “Test orange by object from API”, “TotalCount”: 5, “CustomFields”: null }, { “AttachmentID”: 708, “FileName”: “Test Blue.jpg”, “DateCreated”: “2020-01-02T16:14:36.79”, “CreatedBy”: “Bhatt, S.”, “File”: “”, “IncidentID”: 342510, “ImageThumbnail”: “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBAooooA/9k=”, “FileType”: “image/jpeg”, “FileURL”: “”, “ShortDescription”: “Test Blue.jpg”, “TotalCount”: 5, “CustomFields”: null } ] }