PUT Attachments
Updates the given attachment. Only the Name and Description of the attachment may be updated.
Request Information
URI Parameters
None.
Body Parameters
The attachment to update
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": "48334f3d-5db9-4ad6-b95c-9a45ff6ac4c1",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "ab514366-419b-45c3-b940-b1a51bdc8136",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2d8e323e-f3f0-4239-927a-4e471d8ef173",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "e58d46ce-3015-4d4e-96aa-e4bf55d67780",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "de1bb7b8-396a-4c06-bc48-d478277b9c02",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74ff9722-06ad-4a1f-a109-109ba6800e9f",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f894d19f-9162-4b63-85f6-67761ac5f11f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T11:57:11.3906223-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:11.3906223-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bada8803-840a-4abf-b5aa-2ec28b91c4ef",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fb03a4e3-f388-4406-81f4-34240a600ec9",
"EffectiveDate": "2026-11-21T11:57:11.3906223-08:00",
"StateType": {
"StateTypeId": "de8dfa81-9a3a-4a32-9388-80539a4cbeb0",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "de1bb7b8-396a-4c06-bc48-d478277b9c02",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74ff9722-06ad-4a1f-a109-109ba6800e9f",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0ed9f82e-f50d-4610-bece-84708b1c49c6",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "534f7d23-576f-444c-a47b-04b4ef634c7c",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ee58d4e1-2891-4c6a-82c6-437f0825e28d",
"EffectiveDate": "2026-11-21T11:57:11.3906223-08:00",
"StatusType": {
"StatusTypeId": "7cbfa890-713b-44a0-a527-e995e689fd48",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "de1bb7b8-396a-4c06-bc48-d478277b9c02",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "74ff9722-06ad-4a1f-a109-109ba6800e9f",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8479b276-9171-404a-9ddb-87effc1360f2",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "964cfa95-9dfd-4dc1-a9be-c2f233469254",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "7fbdc478-0586-4c7f-862e-83c8121eca8d",
"EffectiveDate": "2026-11-21T11:57:11.3906223-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "32d3ca68-502e-4e04-92b0-a511026ae0f5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a3040fa6-ebd6-4a38-b066-ea932113801d",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f5115a9b-3a96-469c-8d59-e0d2ede4ca12",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T11:57:11.3906223-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:11.3906223-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "89742569-3aa7-4586-b05e-0475042dcc26",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-11-21T11:57:11.3906223-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "aec037f6-a2a3-49da-a092-bc84de331c75",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 7"
}
Response Information
Resource Description
On success, the updated 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": "fa7727b2-abee-4abc-b90b-08b43486b051",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "ec5fd238-6e02-4276-828c-9b131e786bea",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1d832a06-fd28-4c94-87a1-f53dcb520357",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "59931979-2aac-47f1-84cc-18c3cdbf2ebd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "01177ceb-8fff-41f8-825a-87e54ab20af0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "64bfbb42-d740-42b6-93a5-69ece829c0f9",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5ed999cc-4990-452c-814d-d461f2898dde",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T11:57:11.3906223-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:11.3906223-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3ce97d23-0eb3-4056-a51e-70825fdc988a",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4375ef13-2dd3-4d6d-9e40-05bdc01ab43f",
"EffectiveDate": "2026-11-21T11:57:11.3906223-08:00",
"StateType": {
"StateTypeId": "fc457145-88bd-495c-9b07-99058cf24cf5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "01177ceb-8fff-41f8-825a-87e54ab20af0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "64bfbb42-d740-42b6-93a5-69ece829c0f9",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b3ed46fb-054e-497e-a58f-c974807b1d9f",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4d46a2e3-f500-4c57-802d-f417335c96b0",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b8866499-160d-412b-b4fc-9d068bf8166f",
"EffectiveDate": "2026-11-21T11:57:11.3906223-08:00",
"StatusType": {
"StatusTypeId": "78a42649-502a-49ed-a4a2-d77cbeb0ec9a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "01177ceb-8fff-41f8-825a-87e54ab20af0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "64bfbb42-d740-42b6-93a5-69ece829c0f9",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8e0e4f84-2bb8-46e4-8790-67a04886f688",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "90ee40a1-08ec-4f05-89fa-25cf7f4e9c8e",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d1d01353-daf8-47f1-9326-2df97335effe",
"EffectiveDate": "2026-11-21T11:57:11.3906223-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "eba0b881-d344-42b7-b24e-e894ac28c793",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b7d83d4f-b33d-49c5-8516-18e46f395227",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "906a9e40-0c9c-4bac-a169-d3a2344c4199",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T11:57:11.3906223-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:11.3906223-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ddbad858-748f-4815-a357-a6371efd86f7",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-11-21T11:57:11.3906223-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "409ea1b2-0fd9-4e05-9762-358e4e8f8ce2",
"CreateDate": "2026-11-21T11:57:11.3906223-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:11.3906223-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}