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": "0ed96a0c-bf16-4c2a-bc02-97a41e1f0876",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "88a92ea9-28bf-4c36-8a85-cc5df2dda101",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4bf1f9da-e3e8-4767-b9a7-e06898448d61",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "c47792e4-67e0-4ce7-9f72-bff7432be6bc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ca5d4ca3-879a-446e-8e74-68cba662ca4d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "19724373-94d6-4dce-99c2-92cd0a3da03d",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "fa339fb5-f549-4b4f-b116-247ba6cb05b0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T12:40:25.0345537-08:00",
"MeasurementValueNeededDate": "2026-11-22T12:40:25.0345537-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "53af7a01-308d-4921-bec0-62536b1f9919",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7c794850-7a1e-4115-bf20-7009154122a9",
"EffectiveDate": "2026-11-22T12:40:25.0345537-08:00",
"StateType": {
"StateTypeId": "061078dc-3f10-4c28-8f7f-e950678ef3b3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ca5d4ca3-879a-446e-8e74-68cba662ca4d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "19724373-94d6-4dce-99c2-92cd0a3da03d",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e1ec4056-fca0-4c35-a65a-70f64f6c7647",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c3c9951b-e384-4533-b595-45fd6eca36f2",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1ffed08a-713f-43f8-ab78-e99307189327",
"EffectiveDate": "2026-11-22T12:40:25.0345537-08:00",
"StatusType": {
"StatusTypeId": "1e1a2620-c140-490f-af0d-b8a29e249384",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ca5d4ca3-879a-446e-8e74-68cba662ca4d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "19724373-94d6-4dce-99c2-92cd0a3da03d",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fac2364e-8ef5-4e7c-ba44-5b826e3598de",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ccc3da23-36d2-497f-bf9c-ed5cd9ff32ab",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "16473133-f526-410e-8eb7-473f253b8743",
"EffectiveDate": "2026-11-22T12:40:25.0345537-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "0c214ce2-7750-4072-8211-84ac25907288",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9bbf1665-a179-4e6b-b507-f21efb83481b",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9fe00727-36b8-4899-b917-a5c0e9050a2b",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T12:40:25.0345537-08:00",
"MeasurementValueNeededDate": "2026-11-22T12:40:25.0345537-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "87ee0f26-7989-4ee5-96fe-4d4e664ce6fc",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-11-22T12:40:25.0345537-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "a131b2f2-1bf4-4402-afa6-192c7d5bd476",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-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": "a8429c40-55fc-4064-b554-ccc5b1b1a671",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "7b433609-f928-48a4-a4ae-78f5ff4704fb",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e2292a02-2992-4e29-bb50-6f54daa03984",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "e6a29b1b-767d-45e9-8291-dbee0c1bba6f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "dfd335fc-585f-4063-b592-66f120dd84f2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "97cc1541-d2ac-4395-924d-7785a1696b53",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b40c1ef6-29c8-4731-ad05-b9f88a55c676",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T12:40:25.0345537-08:00",
"MeasurementValueNeededDate": "2026-11-22T12:40:25.0345537-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f5262a4a-c47c-46c1-b918-db1bb953b7f8",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3b5ce668-e2e7-4968-b3f3-54a5b6bf796a",
"EffectiveDate": "2026-11-22T12:40:25.0345537-08:00",
"StateType": {
"StateTypeId": "db171837-42a3-4536-a635-72b41010bf8b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "dfd335fc-585f-4063-b592-66f120dd84f2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "97cc1541-d2ac-4395-924d-7785a1696b53",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6ccfed98-727a-459d-bcc0-98f2f97813b0",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dd71ce09-bf27-4b0d-9e06-2c7169da09bb",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5afa9d0f-8cb9-4391-b893-0cd7cd4562a4",
"EffectiveDate": "2026-11-22T12:40:25.0345537-08:00",
"StatusType": {
"StatusTypeId": "3677392d-13dd-46a2-89f5-04a493f83a7e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "dfd335fc-585f-4063-b592-66f120dd84f2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "97cc1541-d2ac-4395-924d-7785a1696b53",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "334aa9d1-4591-4327-b5e4-402b9bcdce42",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "99050c6a-f14e-4289-a1b3-585b77c091d9",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "924f20f1-f4f7-4130-9893-d10e4d44afd9",
"EffectiveDate": "2026-11-22T12:40:25.0345537-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "5ddd9564-d2c2-4f18-8b0c-a012d1218b8d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0a9fd23e-6293-4cfe-84b9-4ed11a8cad5f",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "503319ff-5389-4031-857d-f8009f33a46d",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T12:40:25.0345537-08:00",
"MeasurementValueNeededDate": "2026-11-22T12:40:25.0345537-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c3c78e0e-edb0-45af-9dff-710ca4966f40",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-11-22T12:40:25.0345537-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "d289ab63-9bdf-466f-b7d3-3e9afec7e317",
"CreateDate": "2026-11-22T12:40:25.0345537-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:40:25.0345537-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}