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": "f4a5c9e2-339b-4245-8099-b6a94b1aa586", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "843ee158-b8af-40da-bff3-6331092ceadb", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "d83a8a97-a425-4955-bab0-68257c986294", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "bf8cb7d6-844b-40d4-a5be-850b0a0ddb64", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4aaa7758-9b76-42e0-8a0f-a069babf1399", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d79ff1bf-3c76-4162-a255-766bb2ce9e0d", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "9119dec4-a723-47b7-b2b1-474e8289ed0f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T07:21:08.6701109-07:00", "MeasurementValueNeededDate": "2025-06-27T07:21:08.6701109-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3436e943-eb51-4f57-85a2-e2bbd0ac52c1", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "004d7c8a-adc2-451b-9eda-c7942d423455", "EffectiveDate": "2025-06-27T07:21:08.6701109-07:00", "StateType": { "StateTypeId": "9cdb8a5f-41f9-49ec-aa3b-d38d90863696", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "4aaa7758-9b76-42e0-8a0f-a069babf1399", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d79ff1bf-3c76-4162-a255-766bb2ce9e0d", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "d4520f5d-3aa3-4f60-bd3f-4f222235e1c7", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c8fd4fe1-6e77-4fd9-8fb7-ed3c7362c791", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "8ed68553-2767-4aef-a99f-b6601b69197c", "EffectiveDate": "2025-06-27T07:21:08.6701109-07:00", "StatusType": { "StatusTypeId": "f9f3537d-e6b6-4d8d-a27c-8bc1d689598c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "4aaa7758-9b76-42e0-8a0f-a069babf1399", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d79ff1bf-3c76-4162-a255-766bb2ce9e0d", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "8d0d258d-7494-4777-ad73-45726e188f4a", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "58d4fa32-fb88-410c-831a-8f6d6e6fa94d", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "ce99d628-1c42-440f-aebc-9c63a2fa393a", "EffectiveDate": "2025-06-27T07:21:08.6701109-07:00", "WellPurposeType": { "WellPurposeTypeId": "a19eb6d5-e4f1-49c8-96fa-510ffdd55ecb", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "65679d13-dc5f-4c7f-b110-4b16ecaed1a5", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a9408c0d-2856-49ff-b481-6356b190c68f", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-27T07:21:08.6701109-07:00", "MeasurementValueNeededDate": "2025-06-27T07:21:08.6701109-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "068b9c7c-bb8f-41cc-b64f-6effa6a31f99", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-06-27T07:21:08.6701109-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "08c52081-1d63-4dd1-8513-f4a5aea68095", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:21:08.6701109-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": "222564b0-15b7-4493-8b84-9714b09d42a0", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "ca6f7c41-3b9f-4b47-989b-da008c8fcb6a", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "e981d2c2-97f5-46d4-93a2-3ef893ddb870", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "3e6bd5ec-16f6-4a10-bede-352a1ab6564a", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a764fa0c-cc23-435e-bd62-5219b37b661c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5c26b3d9-1fe7-44b8-953d-85539884b881", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "fdd70b00-1133-487f-b39e-92313ade5736", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T07:21:08.6701109-07:00", "MeasurementValueNeededDate": "2025-06-27T07:21:08.6701109-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6a14b388-42e5-4ec7-a45d-e7b619b1baba", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "beb20df4-69f7-4a71-b91c-dd486bf0c124", "EffectiveDate": "2025-06-27T07:21:08.6701109-07:00", "StateType": { "StateTypeId": "dfd9a521-2201-4c53-a6a5-c66561445b6f", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a764fa0c-cc23-435e-bd62-5219b37b661c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5c26b3d9-1fe7-44b8-953d-85539884b881", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "28a384b8-d4b7-419a-b96e-14d8121f35bc", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "700a899c-3539-42de-8a11-1eacf3df2840", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "86e58946-778c-4f22-b55f-a2aaad706865", "EffectiveDate": "2025-06-27T07:21:08.6701109-07:00", "StatusType": { "StatusTypeId": "eacdd977-9766-4344-8cfa-e652891353d4", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "a764fa0c-cc23-435e-bd62-5219b37b661c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5c26b3d9-1fe7-44b8-953d-85539884b881", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "6aa3c887-9d0e-4929-94d2-28c427040162", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "e6ad72c0-924d-4756-b6f8-3d779a433aba", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "8ca14353-5b4d-4ede-bd6d-9128ba40d0fb", "EffectiveDate": "2025-06-27T07:21:08.6701109-07:00", "WellPurposeType": { "WellPurposeTypeId": "7e59ae1a-fcf3-49d6-a368-5822bfd61c42", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7ca0a632-56b9-4c94-b2af-54d6cce50702", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "889e6a88-2a6c-482e-a681-69fc93a28589", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-27T07:21:08.6701109-07:00", "MeasurementValueNeededDate": "2025-06-27T07:21:08.6701109-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "dc522a73-166b-411b-a7b3-db1d56ba2836", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-06-27T07:21:08.6701109-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "5fa7db3b-576e-419b-ad4f-68f84ad7d6d6", "CreateDate": "2025-06-27T07:21:08.6701109-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:21:08.6701109-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }