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": "459cf4a2-18c1-4c6a-a5a8-1baeff4aaa13",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "3beb5484-e8be-4468-b64c-41a93cd34778",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bbf2cdee-f78d-4884-be6b-e42d9e205a11",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "8d384bd3-fdf7-4cfe-9e91-c44c067f77e9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "36e93699-0abd-4139-9e01-35187a2aeb37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8f631872-8679-4af8-9670-ceae66c5a2ed",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9fc8e920-1129-4d43-b87d-4617b83c4d43",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-15T11:44:03.0284075-08:00",
"MeasurementValueNeededDate": "2026-02-15T11:44:03.0284075-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "48c534b1-be99-4219-a6b9-c10130e5e9eb",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "faf3d011-06ef-486e-9226-ef904c9e16ea",
"EffectiveDate": "2026-02-15T11:44:03.0284075-08:00",
"StateType": {
"StateTypeId": "f5b57d21-eab1-44d2-ae87-f923931f99b5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "36e93699-0abd-4139-9e01-35187a2aeb37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8f631872-8679-4af8-9670-ceae66c5a2ed",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "11ce640f-14b4-4e16-9140-2462cc3f4790",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "77441a3d-8b65-4186-a60f-edd4b641f34a",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fcb3d1eb-da83-4ec0-baa1-2235274f51f2",
"EffectiveDate": "2026-02-15T11:44:03.0284075-08:00",
"StatusType": {
"StatusTypeId": "c34f37b3-aebd-4bce-98b7-2c8561e56449",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "36e93699-0abd-4139-9e01-35187a2aeb37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8f631872-8679-4af8-9670-ceae66c5a2ed",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a4c36379-35ce-45ac-a333-8d82f5ae3216",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "86feec42-3b9c-464e-9383-3376388f344c",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ed4bd6f8-72f0-40e7-b03d-fdbc1baaa9a0",
"EffectiveDate": "2026-02-15T11:44:03.0284075-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "e51c29cb-9a51-4f98-9eea-84285b052838",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dc381559-b103-45c1-85a6-acf6e0d53f16",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9f36059a-1510-4614-a5fc-56cde7f2f325",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-15T11:44:03.0284075-08:00",
"MeasurementValueNeededDate": "2026-02-15T11:44:03.0284075-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8174c78d-9157-455e-ab4e-1b51b8b65ed6",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-02-15T11:44:03.0284075-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "736347d5-2068-4ce4-a319-53fff4541e16",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 7"
},
{
"AttachmentId": "459cf4a2-18c1-4c6a-a5a8-1baeff4aaa13",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "3beb5484-e8be-4468-b64c-41a93cd34778",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bbf2cdee-f78d-4884-be6b-e42d9e205a11",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "8d384bd3-fdf7-4cfe-9e91-c44c067f77e9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "36e93699-0abd-4139-9e01-35187a2aeb37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8f631872-8679-4af8-9670-ceae66c5a2ed",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9fc8e920-1129-4d43-b87d-4617b83c4d43",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-15T11:44:03.0284075-08:00",
"MeasurementValueNeededDate": "2026-02-15T11:44:03.0284075-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "48c534b1-be99-4219-a6b9-c10130e5e9eb",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "faf3d011-06ef-486e-9226-ef904c9e16ea",
"EffectiveDate": "2026-02-15T11:44:03.0284075-08:00",
"StateType": {
"StateTypeId": "f5b57d21-eab1-44d2-ae87-f923931f99b5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "36e93699-0abd-4139-9e01-35187a2aeb37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8f631872-8679-4af8-9670-ceae66c5a2ed",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "11ce640f-14b4-4e16-9140-2462cc3f4790",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "77441a3d-8b65-4186-a60f-edd4b641f34a",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fcb3d1eb-da83-4ec0-baa1-2235274f51f2",
"EffectiveDate": "2026-02-15T11:44:03.0284075-08:00",
"StatusType": {
"StatusTypeId": "c34f37b3-aebd-4bce-98b7-2c8561e56449",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "36e93699-0abd-4139-9e01-35187a2aeb37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8f631872-8679-4af8-9670-ceae66c5a2ed",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a4c36379-35ce-45ac-a333-8d82f5ae3216",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "86feec42-3b9c-464e-9383-3376388f344c",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ed4bd6f8-72f0-40e7-b03d-fdbc1baaa9a0",
"EffectiveDate": "2026-02-15T11:44:03.0284075-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "e51c29cb-9a51-4f98-9eea-84285b052838",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dc381559-b103-45c1-85a6-acf6e0d53f16",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9f36059a-1510-4614-a5fc-56cde7f2f325",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-15T11:44:03.0284075-08:00",
"MeasurementValueNeededDate": "2026-02-15T11:44:03.0284075-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8174c78d-9157-455e-ab4e-1b51b8b65ed6",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-02-15T11:44:03.0284075-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "736347d5-2068-4ce4-a319-53fff4541e16",
"CreateDate": "2026-02-15T11:44:03.0284075-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-15T11:44:03.0284075-08:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}