GET Attachments?assetId={assetId}&includeContent={includeContent}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves attachments for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
includeContent |
Include the file contents of the attachments |
boolean |
Default value is False |
take |
Number of attachments to retrieve. Default is all attachments |
integer |
None. |
skip |
Number of attachments to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the attachments before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of attachments.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Attachment |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "AttachmentId": "1a6e0072-4f50-422d-a7e2-a07c1b1bd3ba", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "f5f01c73-3f38-40c9-b4b7-1f95f1830832", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "9cd01284-aba4-4f03-9810-3cba24264f2c", "CreateDate": "2025-03-18T13:05:15.5024934-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-03-18T13:05:15.5024934-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "dfb1a03e-0b1a-4823-b41f-726ac6e4783d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "46f43f4e-33da-4831-a8e2-1122fb724f44", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4e0e0a34-b4e9-45a3-bffd-18ac3dd8552e", "CreateDate": "2025-03-18T13:05:15.5024934-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T13:05:15.5024934-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "91a60da0-9b77-47dd-97ca-72f875f7501b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-18T13:05:15.5024934-07:00", "MeasurementValueNeededDate": "2025-03-18T13:05:15.5024934-07:00", "SourceSystemId": "sample string 3", "CompanyId": "87c75e06-216b-4015-9c20-687219a921fd", "CreateDate": "2025-03-18T13:05:15.5024934-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T13:05:15.5024934-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-03-18T13:05:15.5181695-07:00", "MeasurementValueNeededDate": "2025-03-18T13:05:15.5181695-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "73750fd5-0ac5-4d19-922e-8440add6984f", "CreateDate": "2025-03-18T13:05:15.5181695-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-18T13:05:15.5181695-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-03-18T13:05:15.5181695-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "03ce0a56-1aab-495f-99dd-c557c49bdadc", "CreateDate": "2025-03-18T13:05:15.5181695-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T13:05:15.5181695-07:00", "LastModifiedUser": "sample string 7" }, { "AttachmentId": "1a6e0072-4f50-422d-a7e2-a07c1b1bd3ba", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "f5f01c73-3f38-40c9-b4b7-1f95f1830832", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "9cd01284-aba4-4f03-9810-3cba24264f2c", "CreateDate": "2025-03-18T13:05:15.5024934-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-03-18T13:05:15.5024934-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "dfb1a03e-0b1a-4823-b41f-726ac6e4783d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "46f43f4e-33da-4831-a8e2-1122fb724f44", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4e0e0a34-b4e9-45a3-bffd-18ac3dd8552e", "CreateDate": "2025-03-18T13:05:15.5024934-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T13:05:15.5024934-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "91a60da0-9b77-47dd-97ca-72f875f7501b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-18T13:05:15.5024934-07:00", "MeasurementValueNeededDate": "2025-03-18T13:05:15.5024934-07:00", "SourceSystemId": "sample string 3", "CompanyId": "87c75e06-216b-4015-9c20-687219a921fd", "CreateDate": "2025-03-18T13:05:15.5024934-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T13:05:15.5024934-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-03-18T13:05:15.5181695-07:00", "MeasurementValueNeededDate": "2025-03-18T13:05:15.5181695-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "73750fd5-0ac5-4d19-922e-8440add6984f", "CreateDate": "2025-03-18T13:05:15.5181695-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-18T13:05:15.5181695-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-03-18T13:05:15.5181695-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "03ce0a56-1aab-495f-99dd-c557c49bdadc", "CreateDate": "2025-03-18T13:05:15.5181695-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T13:05:15.5181695-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }