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": "88d1765c-133b-416e-ae2f-d26086947e75",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "0c9b428b-3d22-4972-9014-8930428b0f06",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f58b25f2-fc2d-4396-91b7-8daa0fb93710",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "fcba7970-1423-4c92-9eaa-a12121b1d729",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ed169430-5da7-439b-b071-c28d538411e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc8fd479-ded8-47c3-a7b2-394bbebc433f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c1b64696-73fd-49cd-bf45-f04ac8848101",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-19T00:05:01.4709732-07:00",
"MeasurementValueNeededDate": "2025-07-19T00:05:01.4709732-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bcc53a3a-35c9-4275-a6bd-aff78c9b4654",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8c279d87-6fcb-44f1-a31a-58bae3d1d963",
"EffectiveDate": "2025-07-19T00:05:01.4709732-07:00",
"StateType": {
"StateTypeId": "3be52318-4c90-454b-88bb-a4134497fe56",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ed169430-5da7-439b-b071-c28d538411e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc8fd479-ded8-47c3-a7b2-394bbebc433f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d4c829b6-1591-4caf-806e-ef4bc3239fe4",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ce0716e9-2a42-4e64-abda-6a3ddb0b459f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b26a7c3e-fe05-43f6-84da-2f504904d8d3",
"EffectiveDate": "2025-07-19T00:05:01.4709732-07:00",
"StatusType": {
"StatusTypeId": "ddf29b77-e21f-4759-a1c1-937663882b00",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ed169430-5da7-439b-b071-c28d538411e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc8fd479-ded8-47c3-a7b2-394bbebc433f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c8ac01aa-1cc8-4215-94b5-a49517964c57",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0c4d0b77-bb2f-451b-a87e-adde9f930f8b",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "41c51f8d-6e72-4155-a189-83d181230a5a",
"EffectiveDate": "2025-07-19T00:05:01.4709732-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "000c06c4-a04c-4ded-8efc-b63e0038990f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ccee10a1-0aa3-40cc-952f-758f8c176fe1",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fead2420-8993-4e7e-a8a0-6f43a3283651",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-19T00:05:01.4709732-07:00",
"MeasurementValueNeededDate": "2025-07-19T00:05:01.4709732-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "933db575-b8e0-4ae0-98eb-6d8984edd1e2",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-07-19T00:05:01.4709732-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "eec5a2ce-73c8-4b64-97c8-f33edd01e23f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 7"
},
{
"AttachmentId": "88d1765c-133b-416e-ae2f-d26086947e75",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "0c9b428b-3d22-4972-9014-8930428b0f06",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f58b25f2-fc2d-4396-91b7-8daa0fb93710",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "fcba7970-1423-4c92-9eaa-a12121b1d729",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ed169430-5da7-439b-b071-c28d538411e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc8fd479-ded8-47c3-a7b2-394bbebc433f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c1b64696-73fd-49cd-bf45-f04ac8848101",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-19T00:05:01.4709732-07:00",
"MeasurementValueNeededDate": "2025-07-19T00:05:01.4709732-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bcc53a3a-35c9-4275-a6bd-aff78c9b4654",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8c279d87-6fcb-44f1-a31a-58bae3d1d963",
"EffectiveDate": "2025-07-19T00:05:01.4709732-07:00",
"StateType": {
"StateTypeId": "3be52318-4c90-454b-88bb-a4134497fe56",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ed169430-5da7-439b-b071-c28d538411e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc8fd479-ded8-47c3-a7b2-394bbebc433f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d4c829b6-1591-4caf-806e-ef4bc3239fe4",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ce0716e9-2a42-4e64-abda-6a3ddb0b459f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b26a7c3e-fe05-43f6-84da-2f504904d8d3",
"EffectiveDate": "2025-07-19T00:05:01.4709732-07:00",
"StatusType": {
"StatusTypeId": "ddf29b77-e21f-4759-a1c1-937663882b00",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ed169430-5da7-439b-b071-c28d538411e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc8fd479-ded8-47c3-a7b2-394bbebc433f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c8ac01aa-1cc8-4215-94b5-a49517964c57",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0c4d0b77-bb2f-451b-a87e-adde9f930f8b",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "41c51f8d-6e72-4155-a189-83d181230a5a",
"EffectiveDate": "2025-07-19T00:05:01.4709732-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "000c06c4-a04c-4ded-8efc-b63e0038990f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ccee10a1-0aa3-40cc-952f-758f8c176fe1",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fead2420-8993-4e7e-a8a0-6f43a3283651",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-19T00:05:01.4709732-07:00",
"MeasurementValueNeededDate": "2025-07-19T00:05:01.4709732-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "933db575-b8e0-4ae0-98eb-6d8984edd1e2",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-07-19T00:05:01.4709732-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "eec5a2ce-73c8-4b64-97c8-f33edd01e23f",
"CreateDate": "2025-07-19T00:05:01.4709732-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T00:05:01.4709732-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}