POST Attachments
Creates a new attachment.
Request Information
URI Parameters
None.
Body Parameters
The attachment to create. AttachmentId should not be filled in.
Attachment| Name | Description | Type | Additional information |
|---|---|---|---|
| AttachmentId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| AttachmentCategory | AttachmentCategory |
None. |
|
| Asset | Asset |
None. |
|
| FileType | string |
None. |
|
| FileSize | integer |
None. |
|
| UploadDate | date |
None. |
|
| Content | Collection of byte |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"AttachmentId": "01c2a443-c336-420b-b764-3b1cdb6b2be8",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "d97e3497-747c-413b-826e-4118e4580dc9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f03e8df3-9335-4a08-b090-8fa9c8568e1a",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "65e21d77-ba18-4b51-87fc-94db25b06687",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8fc21d26-909d-4fa8-8a11-6b26cbc71824",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2e3db2bb-ddd4-4331-a6de-746797b3d283",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "722a02a6-68bc-49b0-9d3d-bd381c0a32ff",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-17T03:57:20.8775663-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:57:20.8775663-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e28d6a4a-a2f9-4712-b362-6b26346d2c60",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a7bdd3a7-33c6-4479-a335-657be2c08763",
"EffectiveDate": "2025-04-17T03:57:20.8775663-07:00",
"StateType": {
"StateTypeId": "6ccf8723-cb41-4b3c-97fb-5c317183abe6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8fc21d26-909d-4fa8-8a11-6b26cbc71824",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2e3db2bb-ddd4-4331-a6de-746797b3d283",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f5411c5c-9d96-4713-8b3e-65acf09b5f19",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "23a2a550-e13a-4b5a-a264-968e78dfa4f4",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "da1878b5-0c44-4efa-9047-e6961830c15e",
"EffectiveDate": "2025-04-17T03:57:20.8775663-07:00",
"StatusType": {
"StatusTypeId": "f23a532c-c176-4528-9377-66972550a640",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8fc21d26-909d-4fa8-8a11-6b26cbc71824",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2e3db2bb-ddd4-4331-a6de-746797b3d283",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ca31a884-2794-432e-9625-a63518c677c2",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "921c7c77-6830-4877-895d-671953709efe",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "bc771534-1c28-47ed-af98-b8da454b3934",
"EffectiveDate": "2025-04-17T03:57:20.8775663-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "dc92829b-4c03-410e-be71-d21c5e3dac11",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5fbd6292-10c5-44d8-b7c3-340be3b48c53",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "54d62565-541f-4edd-8692-9a7b4aca089e",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-17T03:57:20.8775663-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:57:20.8775663-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3b3dc461-3cfe-4564-9906-ba9f0daacc3a",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-04-17T03:57:20.8775663-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "666db610-3782-422c-a170-ebc9c296a212",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 7"
}
Response Information
Resource Description
On success, the created attachment. The Content of the attachment will not be filled in.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Attachment |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"AttachmentId": "7de7feeb-911d-42f1-b734-0b1bde6eb9d1",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "84d678cd-9831-4a35-bdc8-1fa46a093990",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "194f0bc3-bc8b-4f75-9eeb-306226530a3b",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "5d48760f-1f27-4144-9936-314670671779",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "87d991f8-9e19-4935-bf67-0e890ce67a54",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4399eb45-62c2-46a5-8620-27e13f7d9ab4",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "eda7330b-6f3e-4959-bdf7-19566c3f3d74",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-17T03:57:20.8775663-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:57:20.8775663-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a8823f82-1e3d-4b61-9bfb-2e9de9cf0f5f",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fcffbf7e-030e-4cc9-9750-d8f999c38827",
"EffectiveDate": "2025-04-17T03:57:20.8775663-07:00",
"StateType": {
"StateTypeId": "53eb2fbe-ae24-419d-917f-81560bca7037",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "87d991f8-9e19-4935-bf67-0e890ce67a54",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4399eb45-62c2-46a5-8620-27e13f7d9ab4",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8b4b145c-b30c-4693-a4ac-402ff28266df",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1121f9cb-caa5-47c2-9e1c-b79e1cd6eeb8",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "47bdeea1-da8e-4d6c-8686-dc48a0a4df0f",
"EffectiveDate": "2025-04-17T03:57:20.8775663-07:00",
"StatusType": {
"StatusTypeId": "0b07111b-3e1a-402d-a3f6-758536e32588",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "87d991f8-9e19-4935-bf67-0e890ce67a54",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4399eb45-62c2-46a5-8620-27e13f7d9ab4",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "00281d71-1ceb-40e6-8b5e-042f9f42bddd",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fd8f2c9a-5647-494e-a817-fc1a5fb7c8fe",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6839f84a-5d02-42b6-ab71-bd9383d9710c",
"EffectiveDate": "2025-04-17T03:57:20.8775663-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a1211acb-5c4c-42fa-ac7e-1367097124c6",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0b98f6a8-eac8-4126-89b4-00cae42b4b55",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f7d020d8-8ac7-4cce-a3d6-af7d08f70c14",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-17T03:57:20.8775663-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:57:20.8775663-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "088ea867-56e7-4754-972e-dda4cf04e1a1",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-04-17T03:57:20.8775663-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "2a12797b-3207-4b69-a24e-36dff8f5804b",
"CreateDate": "2025-04-17T03:57:20.8775663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:57:20.8775663-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}