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": "cbebe250-2d8c-4db3-8362-a592ddca966a", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "ebe1a356-eb81-4f43-87ba-79204b643d98", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "f97d91d7-0f09-4ffc-9541-e1eb47b39173", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "737900ea-1118-4c7e-8a48-53d240643f74", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b9743cf3-b3fc-4dfd-84f4-2810b14d51bd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "23145a09-8d42-49f0-bca8-69172b569ab3", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "e89bb283-0031-45b6-b101-7c6edb82d36e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-10T15:21:27.9434194-07:00", "MeasurementValueNeededDate": "2024-10-10T15:21:27.9434194-07:00", "SourceSystemId": "sample string 3", "CompanyId": "25bc6cb0-79ff-45e0-af41-a86a8c8d503a", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-10T15:21:27.9434194-07:00", "MeasurementValueNeededDate": "2024-10-10T15:21:27.9434194-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3dfc9c75-f7ec-42d4-b341-7992287e0eca", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-10-10T15:21:27.9434194-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "3be9703a-237a-4231-bcbb-a1031a3a8574", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 7" }, { "AttachmentId": "cbebe250-2d8c-4db3-8362-a592ddca966a", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "ebe1a356-eb81-4f43-87ba-79204b643d98", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "f97d91d7-0f09-4ffc-9541-e1eb47b39173", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "737900ea-1118-4c7e-8a48-53d240643f74", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b9743cf3-b3fc-4dfd-84f4-2810b14d51bd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "23145a09-8d42-49f0-bca8-69172b569ab3", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "e89bb283-0031-45b6-b101-7c6edb82d36e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-10T15:21:27.9434194-07:00", "MeasurementValueNeededDate": "2024-10-10T15:21:27.9434194-07:00", "SourceSystemId": "sample string 3", "CompanyId": "25bc6cb0-79ff-45e0-af41-a86a8c8d503a", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-10T15:21:27.9434194-07:00", "MeasurementValueNeededDate": "2024-10-10T15:21:27.9434194-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3dfc9c75-f7ec-42d4-b341-7992287e0eca", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-10-10T15:21:27.9434194-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "3be9703a-237a-4231-bcbb-a1031a3a8574", "CreateDate": "2024-10-10T15:21:27.9434194-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T15:21:27.9434194-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }