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": "c585dadc-98a5-4c0f-8608-00ab420a4aea",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "21cfef31-7c0f-4b6c-85bf-05b3ae1eb2d4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "44291d86-3cc8-4443-ac8a-056624a08759",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "5e3d7288-d76d-4dd1-a9e2-8f415503c9f9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "46e4233a-6b1a-4ad2-9ce9-2d6f15ef9ba0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f60aa01-825b-44cd-bd46-9049140aabaf",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9284643e-2e40-4fe0-9c5c-68a55fd13d9f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T06:48:56.86969-08:00",
"MeasurementValueNeededDate": "2026-02-23T06:48:56.86969-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "45a68175-d39f-4799-831f-b1895b6495cc",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2a01aed3-38a8-4485-93b5-b52ed37cbff4",
"EffectiveDate": "2026-02-23T06:48:56.86969-08:00",
"StateType": {
"StateTypeId": "542e9292-af7a-41b9-a777-506c238001eb",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "46e4233a-6b1a-4ad2-9ce9-2d6f15ef9ba0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f60aa01-825b-44cd-bd46-9049140aabaf",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7e10d371-8379-4c3f-9d85-6d941b603000",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5b0556ce-507e-4622-9ab0-eb7a0f9a992f",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d09069d0-e34a-4265-b273-7a4ec5774dd3",
"EffectiveDate": "2026-02-23T06:48:56.86969-08:00",
"StatusType": {
"StatusTypeId": "1c6cc2b7-55fe-4ffc-a8cc-2d359471de48",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "46e4233a-6b1a-4ad2-9ce9-2d6f15ef9ba0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f60aa01-825b-44cd-bd46-9049140aabaf",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cf9c0479-a0c2-4d4a-b51e-eb50e5175526",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f90d223c-bee0-4c68-ad04-786ce56fe3b7",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8c5865ea-c639-4b91-abc1-a2fc9c213aad",
"EffectiveDate": "2026-02-23T06:48:56.86969-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "11aa5b7f-e05f-41e3-9c52-ec0fe19e911e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "610520a6-a1c8-4ee4-b687-6e4b06dfaa74",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e1d4fe89-3cd0-471e-80cd-b0bb0b21527f",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-23T06:48:56.86969-08:00",
"MeasurementValueNeededDate": "2026-02-23T06:48:56.86969-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0b88e5ee-4dd6-47b0-868c-2b38c1cd69a1",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-02-23T06:48:56.86969-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "2e9bbd13-d549-4828-b954-37fa6969fc31",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08: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": "88864169-b3cd-4a1f-aa11-c12642787256",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "66f8a711-91dd-4419-aa9d-2919d3d8bd6f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fb0fa701-8fea-4206-abbc-42dd4497210b",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "ba41bbc9-5c32-49fe-9e42-573bf31dfa06",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ff0793b0-45bc-48de-ac90-b4aa7e84a48b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ca4cc0e3-cae7-456e-873a-29eb613c782b",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "45facfdf-e491-4948-a31a-d192905aff34",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T06:48:56.86969-08:00",
"MeasurementValueNeededDate": "2026-02-23T06:48:56.86969-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "31b2ea50-2b22-416c-86f1-3e7a5c97903e",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "0ab3b93a-85aa-423a-8254-fb2ca6c26943",
"EffectiveDate": "2026-02-23T06:48:56.86969-08:00",
"StateType": {
"StateTypeId": "ec0c7ab2-ee94-46d0-be4c-6fa11062c001",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ff0793b0-45bc-48de-ac90-b4aa7e84a48b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ca4cc0e3-cae7-456e-873a-29eb613c782b",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "71a28d02-42db-48d9-8ea0-5f3e42cf0668",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "99aeee64-dae4-44f7-9675-d9d875966451",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ce3fa2ae-ecbd-48c6-bcd2-08d14a31ccb0",
"EffectiveDate": "2026-02-23T06:48:56.86969-08:00",
"StatusType": {
"StatusTypeId": "3523806b-c04b-46df-b905-aa5bb16a0ec1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ff0793b0-45bc-48de-ac90-b4aa7e84a48b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ca4cc0e3-cae7-456e-873a-29eb613c782b",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "08f2328e-6d30-4e55-a85b-91ce1893e316",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2964bc7f-05c3-416b-a97f-a42a3e18317f",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "68ebee8a-32e9-499a-bd53-fdc01009ef60",
"EffectiveDate": "2026-02-23T06:48:56.86969-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "2383e07c-abe4-4606-a857-b6dc59862c05",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0cc776c8-0fe1-4e1a-93e2-68641c268fb0",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "910c80aa-df24-4f6d-8238-4eaecd767f32",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-23T06:48:56.86969-08:00",
"MeasurementValueNeededDate": "2026-02-23T06:48:56.86969-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3a3d1565-b4b2-4ae9-94e4-7bdd54eed200",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-02-23T06:48:56.86969-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "335baa50-3d45-491e-a479-b2f8b447d2d8",
"CreateDate": "2026-02-23T06:48:56.86969-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T06:48:56.86969-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}