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": "99741544-01b4-43cf-a423-1babcc3df1e2", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "4cf26c4d-d642-4654-b688-15ba51e654ee", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "200fd940-6c42-4456-95e9-f35754190df3", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "7daa5c00-5539-4f79-9312-740ef795a8d9", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b43433a2-4974-49cb-a361-2ef97a8a92bb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3f7f8fa4-cb98-4f24-9ba9-49348d7554b4", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fb381faa-cd5c-494d-baab-2f74918698e9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-08T16:10:43.2172848-08:00", "MeasurementValueNeededDate": "2024-12-08T16:10:43.2172848-08:00", "SourceSystemId": "sample string 3", "CompanyId": "605202a7-9db6-4e29-80ad-284bee2e3bb0", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-12-08T16:10:43.2172848-08:00", "MeasurementValueNeededDate": "2024-12-08T16:10:43.2172848-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "31115ef7-0f08-480b-822d-dc5a1fbbb7de", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-12-08T16:10:43.2172848-08:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "7de7f443-7c5c-4fd8-bca6-8127d69664cd", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 7" }, { "AttachmentId": "99741544-01b4-43cf-a423-1babcc3df1e2", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "4cf26c4d-d642-4654-b688-15ba51e654ee", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "200fd940-6c42-4456-95e9-f35754190df3", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "7daa5c00-5539-4f79-9312-740ef795a8d9", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b43433a2-4974-49cb-a361-2ef97a8a92bb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3f7f8fa4-cb98-4f24-9ba9-49348d7554b4", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fb381faa-cd5c-494d-baab-2f74918698e9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-08T16:10:43.2172848-08:00", "MeasurementValueNeededDate": "2024-12-08T16:10:43.2172848-08:00", "SourceSystemId": "sample string 3", "CompanyId": "605202a7-9db6-4e29-80ad-284bee2e3bb0", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-12-08T16:10:43.2172848-08:00", "MeasurementValueNeededDate": "2024-12-08T16:10:43.2172848-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "31115ef7-0f08-480b-822d-dc5a1fbbb7de", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-12-08T16:10:43.2172848-08:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "7de7f443-7c5c-4fd8-bca6-8127d69664cd", "CreateDate": "2024-12-08T16:10:43.2172848-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T16:10:43.2172848-08:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }