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
AttachmentName | 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": "e24436fb-e65b-480e-8bf7-d75a31aa10d5", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "8ae39d99-79d3-4ea7-8cd5-82791311c90d", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "d2dff6a0-09d3-41a1-8065-6bd9c5481135", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "7476558b-ff74-40f7-b7ce-b84fb6a5e6ea", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "080dc324-328c-423e-be06-b5e00869be5d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9873527a-da94-43e3-aa12-8d8269cac8b1", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "1b7cff9b-ebec-4baf-ab6d-3152d93ae572", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T02:50:19.633858-07:00", "MeasurementValueNeededDate": "2025-07-19T02:50:19.633858-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36db3b3e-5403-4956-981b-4a08bda466c1", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "fef084f3-6d8b-493a-94c0-943082d0a341", "EffectiveDate": "2025-07-19T02:50:19.633858-07:00", "StateType": { "StateTypeId": "02b11527-9e08-4b1e-b5bc-014a79c9e436", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "080dc324-328c-423e-be06-b5e00869be5d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9873527a-da94-43e3-aa12-8d8269cac8b1", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "b61ae560-6cb2-44ff-aa80-5391bae4786e", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "75935bf1-a055-43c6-9ef9-d77c201a552c", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "d08ca69f-7ed1-4c95-87bb-f4def451c5c6", "EffectiveDate": "2025-07-19T02:50:19.633858-07:00", "StatusType": { "StatusTypeId": "c56d1f5b-bc72-4dbb-a344-7f23735d849f", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "080dc324-328c-423e-be06-b5e00869be5d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9873527a-da94-43e3-aa12-8d8269cac8b1", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "b67ae56f-348d-44c5-9549-b588c581d2f3", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "e49f4b10-4ca4-4e61-803c-cd16852541ba", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "6ef37967-9891-4cda-a625-3bda0d2eb014", "EffectiveDate": "2025-07-19T02:50:19.633858-07:00", "WellPurposeType": { "WellPurposeTypeId": "307f6ccf-2824-40bb-afc1-f160cf8edb33", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5898aa86-4610-4d30-a192-32a9c5e97876", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d01eac90-5e78-41a7-ae39-e4e16bf849a8", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T02:50:19.633858-07:00", "MeasurementValueNeededDate": "2025-07-19T02:50:19.633858-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "96f233af-aae7-4f02-9b6e-4d178be4d217", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-19T02:50:19.633858-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "1b056708-1038-47f8-aa4a-64429f4a1f5c", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:50:19.633858-07: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": "c605fcb8-7179-4efc-b646-69bc50f4d5e0", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "4568d144-221f-4f2b-9c8f-c15861f33234", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "1fc2b232-1ea2-43d8-9a4b-acf20ee645f6", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "0dbe674c-7674-4615-b5ed-21edc1efb748", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "cdb08475-a644-4649-a8e7-af890d66b2e0", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5df656f8-ac3a-44f3-a1af-0c4a9ffae4a2", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "1f747af8-fed5-43f8-abbe-ec81be1ffbbe", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T02:50:19.633858-07:00", "MeasurementValueNeededDate": "2025-07-19T02:50:19.633858-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6bc11310-7cb2-4909-a1fe-310a013238d4", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "0616c140-d749-42eb-bfb1-c24a1d1247d9", "EffectiveDate": "2025-07-19T02:50:19.633858-07:00", "StateType": { "StateTypeId": "86796c9a-1032-4d92-9b71-c5cb2591b7af", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "cdb08475-a644-4649-a8e7-af890d66b2e0", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5df656f8-ac3a-44f3-a1af-0c4a9ffae4a2", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "b872f969-583b-4045-bb79-022615a5649e", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "5359d5d0-3388-4e1a-8954-0784b2f97d61", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "b94410ca-3e16-440b-8d67-1d99542a784f", "EffectiveDate": "2025-07-19T02:50:19.633858-07:00", "StatusType": { "StatusTypeId": "936555fc-1028-4ab8-b071-44cd3d962ad0", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "cdb08475-a644-4649-a8e7-af890d66b2e0", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5df656f8-ac3a-44f3-a1af-0c4a9ffae4a2", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "196e2bf1-6d93-49ad-b40f-25ac7b49add2", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9a1b759f-6475-426b-a293-6295ea737d6f", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "14d68364-0b4c-425e-bbdf-bdebc0626352", "EffectiveDate": "2025-07-19T02:50:19.633858-07:00", "WellPurposeType": { "WellPurposeTypeId": "1e15a7ba-e3fa-471c-a8c1-b721b5efd04e", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4101455d-da6f-4922-86a5-c4dd3b11e62f", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "afae40f0-92d9-4570-9839-0c8515d60ed9", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T02:50:19.633858-07:00", "MeasurementValueNeededDate": "2025-07-19T02:50:19.633858-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "c23132d4-481d-47ed-b796-a5c86542b347", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-19T02:50:19.633858-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "410db9c5-3822-4567-8902-bdf26e43631d", "CreateDate": "2025-07-19T02:50:19.633858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:50:19.633858-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }