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": "f708ea49-e486-4068-a3dc-cdf64652363d", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "90c9c4d5-d11a-420a-8ab1-ea2a055097cb", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "6eb98260-179e-4ea9-9800-d3dc7f7ead54", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "463d4eed-6d96-49c6-8ca7-878a6356d332", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6d0d9aa9-afdd-40d4-a9c1-40a8f820315e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22647aa0-bb2c-49cc-80e6-3fafc99f49ac", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "c775a6b4-3809-4372-88ce-70372d13dbba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T15:10:40.8065645-07:00", "MeasurementValueNeededDate": "2025-06-02T15:10:40.8065645-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8c8f57db-2140-41a1-98ed-381984447a1b", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "5c692110-e7c2-491b-ad80-d659ed688de2", "EffectiveDate": "2025-06-02T15:10:40.8065645-07:00", "StateType": { "StateTypeId": "be20fb26-36e0-40d5-bf3a-59a124f18ed4", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6d0d9aa9-afdd-40d4-a9c1-40a8f820315e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22647aa0-bb2c-49cc-80e6-3fafc99f49ac", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e88d3826-c9be-481d-91a7-768326bed688", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "25d8e6dd-0230-448a-b38a-abc9479567bd", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "c3086274-721f-4bde-b509-49c230dd0c58", "EffectiveDate": "2025-06-02T15:10:40.8065645-07:00", "StatusType": { "StatusTypeId": "b36dac42-63c1-475a-98ed-a8fcd59919b3", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6d0d9aa9-afdd-40d4-a9c1-40a8f820315e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "22647aa0-bb2c-49cc-80e6-3fafc99f49ac", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1bdcad2a-09c0-4e63-928a-aa12372894eb", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "cc574754-b844-4223-8cbf-33247736938c", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "fabdbbc6-9207-4682-822b-79427cc3d5c7", "EffectiveDate": "2025-06-02T15:10:40.8065645-07:00", "WellPurposeType": { "WellPurposeTypeId": "6f5d51b5-8294-4f6d-89b0-6b12b6d1bcf6", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "175159e5-46fb-4d7e-8a50-ce5cddb55788", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "5a8cf4ef-0246-447a-97d8-3fa7842fdb0d", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T15:10:40.8065645-07:00", "MeasurementValueNeededDate": "2025-06-02T15:10:40.8065645-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d6e116c4-9c1b-42dd-8913-f619c564e299", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-06-02T15:10:40.8065645-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "c472c7e6-60a4-49c7-821e-d34f64306f10", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:10:40.8065645-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": "16458eaf-fb6d-4c63-b4d9-667f85a41ea5", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "fd7bdb4d-40bc-4a33-93fc-843ac28ac7c3", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "e14b369c-3e75-4722-bd96-e6b48cabd621", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "dc91cac8-8582-447b-93d0-388e9a153f76", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d1374a50-2325-49a4-b39c-6ae6fedd16d6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a6e22281-b327-413a-97e9-7633686e3d06", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "619b9ed3-9a33-42d9-b351-aea5854bf78f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T15:10:40.8065645-07:00", "MeasurementValueNeededDate": "2025-06-02T15:10:40.8065645-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d1d49542-3511-4c90-9078-9a4533cea179", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "950e1701-b75f-471c-9372-ee8f137336ac", "EffectiveDate": "2025-06-02T15:10:40.8065645-07:00", "StateType": { "StateTypeId": "6664ee23-32b7-4c24-b523-b40878fec13f", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d1374a50-2325-49a4-b39c-6ae6fedd16d6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a6e22281-b327-413a-97e9-7633686e3d06", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "a1d3603c-1713-4350-b222-a02113a12b5a", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "ded82847-4164-4274-aef5-9dfd40592aab", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "2c781af8-d8e6-4e1f-8769-1eefe09e9d97", "EffectiveDate": "2025-06-02T15:10:40.8065645-07:00", "StatusType": { "StatusTypeId": "718bc557-1444-41e0-af07-d640b20d9309", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d1374a50-2325-49a4-b39c-6ae6fedd16d6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a6e22281-b327-413a-97e9-7633686e3d06", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "04eed043-33ac-42eb-89a4-9a26ec96dada", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d16a1719-b6ba-4e68-837e-c0cb9f6cff2e", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "692e542b-5c5a-4a43-80d5-212aef464df4", "EffectiveDate": "2025-06-02T15:10:40.8065645-07:00", "WellPurposeType": { "WellPurposeTypeId": "51e12b9f-b32d-470b-b983-00496b19ad19", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c2ea4e52-4494-4cdd-ac52-3ea2ead7e3c2", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f2d26828-618c-4a11-9ab9-b7fcfc7c7608", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T15:10:40.8065645-07:00", "MeasurementValueNeededDate": "2025-06-02T15:10:40.8065645-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b60dcc54-100d-4d94-acf4-ce11b504e8bf", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-06-02T15:10:40.8065645-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "385b827e-02bb-41ab-ac4e-af6dd843db5f", "CreateDate": "2025-06-02T15:10:40.8065645-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:10:40.8065645-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }