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": "0d45a38d-905f-4284-8c52-d9a35d5de851",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "c52c5b1d-8f1c-4d1b-ada1-43129bef4408",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0b3b44aa-7631-429d-9109-3693dadc79d0",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "39d31c37-aaff-49d1-91aa-77a939e65383",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5319e8e0-db91-4a92-9a41-878ce0f83381",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "01e9d53e-47cc-4d7e-a848-38f0258b4028",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c66d7df8-ce73-4ccd-81c1-6b5eef4f29ec",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T08:40:57.7158482-08:00",
"MeasurementValueNeededDate": "2026-02-02T08:40:57.7158482-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d2b9791c-c81e-48f6-96c9-fc1438f2d9e6",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "6ee318d9-0e40-4895-8225-3d0f05de2bbf",
"EffectiveDate": "2026-02-02T08:40:57.7158482-08:00",
"StateType": {
"StateTypeId": "886192d8-17ee-435b-817f-ab53b1ce12b9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5319e8e0-db91-4a92-9a41-878ce0f83381",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "01e9d53e-47cc-4d7e-a848-38f0258b4028",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "94f523cb-a176-4517-9d61-378ef527f9a1",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6ca8c027-3dcc-4489-916c-74dd0aefa637",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e0977a08-7e9b-4863-b8b9-2fcf30fbaea3",
"EffectiveDate": "2026-02-02T08:40:57.7158482-08:00",
"StatusType": {
"StatusTypeId": "e0660d0d-af6d-4901-a6db-ad19e65b8f2c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5319e8e0-db91-4a92-9a41-878ce0f83381",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "01e9d53e-47cc-4d7e-a848-38f0258b4028",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1b3a58d5-fd8a-4020-99bb-4ad06719191c",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e57ec7e4-4fec-4375-897c-87f7c8a164dd",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "81daf0e7-9556-48fd-ae77-f189936defb6",
"EffectiveDate": "2026-02-02T08:40:57.7158482-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "ccb45ea8-eda7-450f-9f8e-af68723131e8",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "91771307-80b4-4e31-9f1f-55ae35737b60",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7f4bb2b0-40b3-40e3-840f-4846a26be61f",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T08:40:57.7158482-08:00",
"MeasurementValueNeededDate": "2026-02-02T08:40:57.7158482-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d85fef2f-251b-42f5-b61b-46c45b800027",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-02-02T08:40:57.7158482-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "3e630379-5033-4c4b-9149-7b3bd1519bed",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-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": "b712bd26-4193-410a-af12-5a6240047dcc",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "88fb8c15-f558-4739-a2a6-57d69a4caf4c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e4f9f7da-0046-4148-b4cf-ece28b77c6da",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "d61ab724-5e83-4207-a034-6ac58d2fc9e4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2a62ddbd-0039-4638-a6d0-3f712f64565e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "95db8a04-b5ae-4278-be88-e85650bb4f9d",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d14d7cc4-104a-4527-a35f-f053a91c61e8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T08:40:57.7158482-08:00",
"MeasurementValueNeededDate": "2026-02-02T08:40:57.7158482-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "674099e0-1290-45ff-a9fd-4769f98aed11",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7b86b857-9a96-4481-a68d-e8a2feb40d0f",
"EffectiveDate": "2026-02-02T08:40:57.7158482-08:00",
"StateType": {
"StateTypeId": "1525c71c-699a-45a4-a3c3-8f48428ac8b5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2a62ddbd-0039-4638-a6d0-3f712f64565e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "95db8a04-b5ae-4278-be88-e85650bb4f9d",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c02b2b18-42e2-4f19-98bf-23db5a4d7d35",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a5fd4bf8-9158-4406-a9cf-a4cb60c95824",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1089d933-c983-48d4-aa46-88e8ffb549a7",
"EffectiveDate": "2026-02-02T08:40:57.7158482-08:00",
"StatusType": {
"StatusTypeId": "5cc323fe-96ac-4c06-8ba8-6d76aeaa75cb",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2a62ddbd-0039-4638-a6d0-3f712f64565e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "95db8a04-b5ae-4278-be88-e85650bb4f9d",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2de3968b-7706-4e70-9b40-c3534dc857a4",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5ba8d3ad-53b6-429b-8b58-88afd19711ac",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6af3c8cf-1b97-4e04-8146-8ab059a47c63",
"EffectiveDate": "2026-02-02T08:40:57.7158482-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "ffd738b0-30b5-49c5-b459-a81e29ad069b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "28df30a8-f038-471c-8d01-db908b26d3cc",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dd157042-8300-446e-a422-6d0272036887",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T08:40:57.7158482-08:00",
"MeasurementValueNeededDate": "2026-02-02T08:40:57.7158482-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1fd1cf91-bb8b-4593-8259-5b878b84a4d1",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-02-02T08:40:57.7158482-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "3057420d-fbd7-4f4b-9237-cc8bd4652608",
"CreateDate": "2026-02-02T08:40:57.7158482-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T08:40:57.7158482-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}