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": "0385b897-e90c-49a7-93b9-ed6392001d78",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "6fb023c3-ab9b-4bc9-ad04-006b63b8b186",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a31282e4-d70a-4dad-a25b-200f9f2ec3d5",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "bfca8585-ebb1-488b-9e15-8515856d29db",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "58b14b4d-0998-4796-a530-07d1c5e72197",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c4f4140d-e613-4ee1-b79c-96177b044e64",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "bf1811cb-2c24-401c-9811-635ab0fe685f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-12T17:06:32.4294287-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:06:32.4294287-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0a14e2fa-dafb-4fa3-a1c3-49069f1f4e6a",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dd74b40b-55ca-460a-a72b-e0872638552f",
"EffectiveDate": "2026-05-12T17:06:32.4294287-07:00",
"StateType": {
"StateTypeId": "74f86ba7-bf91-4c34-9aca-8c50628dd155",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "58b14b4d-0998-4796-a530-07d1c5e72197",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c4f4140d-e613-4ee1-b79c-96177b044e64",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e962a7c6-7c3e-4ddc-b3fc-a7450564aa0c",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "35952e78-983f-48a8-a00d-159bb0a4ea01",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "a482e6e8-7ada-4667-a432-26be4e5addb4",
"EffectiveDate": "2026-05-12T17:06:32.4294287-07:00",
"StatusType": {
"StatusTypeId": "e3215b21-e44c-4b1f-a884-e09bae97672b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "58b14b4d-0998-4796-a530-07d1c5e72197",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c4f4140d-e613-4ee1-b79c-96177b044e64",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "639d18ea-b9bc-40ca-9094-4683e98983bb",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a48d93ce-5b70-4bdc-8e8f-5bdbdf13cd6a",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a079e142-6157-415a-99b9-11bd4c1afb79",
"EffectiveDate": "2026-05-12T17:06:32.4294287-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a3465538-85e4-48a7-8aea-91d945fb1f05",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "183a9785-4889-4018-a2d4-07c691dc7845",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e1dd11cc-051d-45bc-ba12-6cc07733744d",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-12T17:06:32.4294287-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:06:32.4294287-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "944ceced-3b74-490e-a58e-d597b5456fea",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-05-12T17:06:32.4294287-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "13618fd7-2f50-4c19-b763-0ade2caabc93",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-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": "054e6c45-60ec-408c-afdf-514ce82395b0",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "609a6bf6-17be-4682-bd77-c8e72c651ba4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3b89a8ef-fd60-4934-98f2-a556e9c260b8",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "ca52a5ab-227b-4385-87f3-d0f5692b8ca6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0eea3aee-76a0-48b2-a5f3-7231e424f0ef",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "677387e0-445e-4cb0-be25-3eb1a87317fa",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a4afa0c7-fe78-4914-96c7-3b9ffcde5436",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-12T17:06:32.4294287-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:06:32.4294287-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "986b4b0b-75bd-4c7f-a625-57d3fabfe838",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "16d9b9c5-4d09-4c8d-a5ef-f9765be800b9",
"EffectiveDate": "2026-05-12T17:06:32.4294287-07:00",
"StateType": {
"StateTypeId": "dc2e50cc-c84c-41a3-a414-2854195c5c76",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0eea3aee-76a0-48b2-a5f3-7231e424f0ef",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "677387e0-445e-4cb0-be25-3eb1a87317fa",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7b9d3365-dcf6-4b87-a5e9-78e18bca1fe4",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fe2b490c-4af1-477b-8033-abfe94e4de6c",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "bfbbabd3-e089-4f41-a741-64eb3d2bdccb",
"EffectiveDate": "2026-05-12T17:06:32.4294287-07:00",
"StatusType": {
"StatusTypeId": "fa10a4a5-387d-4312-90b0-fbf79b515c93",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0eea3aee-76a0-48b2-a5f3-7231e424f0ef",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "677387e0-445e-4cb0-be25-3eb1a87317fa",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7958a66c-3105-4252-a101-5381ca6c8951",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b8b74559-bcf8-4971-b5ca-7cd377aa9a5d",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "871c688c-6c4b-4bab-ba84-41a2f06b1d44",
"EffectiveDate": "2026-05-12T17:06:32.4294287-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b33d5c8e-a976-4c9e-aea8-339101d249bd",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6a06a61e-1f1d-4ff7-aa08-a89172a66546",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1f4fb353-0015-4b35-8d6c-a67c35403726",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-12T17:06:32.4294287-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:06:32.4294287-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "63c11552-0f2d-417f-b8fd-248d772b27dc",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-05-12T17:06:32.4294287-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "76c59af6-26ed-47c4-8fac-9f69b3c096bc",
"CreateDate": "2026-05-12T17:06:32.4294287-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:06:32.4294287-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}