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": "a7850d84-09fd-4010-8298-7b4891a7d3a9", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "42096382-e476-428d-805c-203472d054ec", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "d07e6f27-657d-49c5-92cf-72214b96757c", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "345b9ae6-a702-4b73-82a1-f5b951d590e6", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4716f727-60bf-4a2b-9e66-b52cdcfb0fec", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "12d46055-2695-4640-b3a2-347de9cf291d", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "d320cd3e-acfd-451f-872d-b14846cc3318", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:23:32.4913068-07:00", "MeasurementValueNeededDate": "2025-07-30T23:23:32.4913068-07:00", "SourceSystemId": "sample string 3", "CompanyId": "cc79d8cc-8308-4e09-9dc2-387e46f05c64", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "737d372c-7004-48e5-b481-3cc3aad04bba", "EffectiveDate": "2025-07-30T23:23:32.4913068-07:00", "StateType": { "StateTypeId": "4076ddcc-99f7-470a-9769-7021714d55df", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "4716f727-60bf-4a2b-9e66-b52cdcfb0fec", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "12d46055-2695-4640-b3a2-347de9cf291d", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "a57d0fe1-0193-497e-810d-f069506e1acb", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "6d707b3e-98af-4e92-a6dc-e7f9ea2dd90d", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "f0fd5825-1d26-4a8e-8cf6-2c79bace9931", "EffectiveDate": "2025-07-30T23:23:32.4913068-07:00", "StatusType": { "StatusTypeId": "80da4a83-7840-4ee9-b6a1-04b06d07fdf5", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "4716f727-60bf-4a2b-9e66-b52cdcfb0fec", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "12d46055-2695-4640-b3a2-347de9cf291d", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "231b1f25-d5a4-4dae-a547-0f583254062a", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "53a6f44a-bd68-4702-9787-018b7b038c74", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "ee555a8d-7e15-4ab6-860c-169702e28ad8", "EffectiveDate": "2025-07-30T23:23:32.4913068-07:00", "WellPurposeType": { "WellPurposeTypeId": "7e32542a-741b-4c85-8bcf-e879a776a49f", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7c81ce19-84d4-45b8-87b0-9db7a7ea4543", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "cfc86d6c-160b-4ffe-b781-73ea4b68bcaa", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:23:32.4913068-07:00", "MeasurementValueNeededDate": "2025-07-30T23:23:32.4913068-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a0df6f34-ecc6-4bfa-9bb5-4f37c9316249", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-30T23:23:32.4913068-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "e1e7301c-69fa-4926-a851-3a1a0549cba3", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:32.4913068-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": "63da7b94-d0db-4526-953f-312b786ccda7", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "a7b51083-f6e3-476c-8d93-d819b5495c6e", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "3163b1ae-96c0-4ca9-a8df-a8f8b5f9c101", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "24c77207-0f90-4808-8b77-496ffbb5a6a2", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "3b8a5776-e797-4b87-b7e2-3a7d32ac62cf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9b9098a4-eef9-4ae7-9df2-b73aef776206", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e50ae905-f8ee-49ba-b54a-42ae0d9174b5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:23:32.4913068-07:00", "MeasurementValueNeededDate": "2025-07-30T23:23:32.4913068-07:00", "SourceSystemId": "sample string 3", "CompanyId": "522fdf92-5a1d-4f56-a087-0c30f22ee427", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "9102ca19-947e-4cef-8a28-625e410bc727", "EffectiveDate": "2025-07-30T23:23:32.4913068-07:00", "StateType": { "StateTypeId": "8da8a86a-c977-4361-89ac-184b8a091854", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "3b8a5776-e797-4b87-b7e2-3a7d32ac62cf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9b9098a4-eef9-4ae7-9df2-b73aef776206", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ad297c82-58e4-4bfc-ac0e-8fc9c1279fb3", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "524f1b63-4ef5-45c7-bfe5-beb0b2d6de74", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "f7dec2ae-2823-46cf-bf9a-8899ff2b3a1d", "EffectiveDate": "2025-07-30T23:23:32.4913068-07:00", "StatusType": { "StatusTypeId": "0ae04c68-d73e-4c02-adc3-c1bd2af40d8d", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "3b8a5776-e797-4b87-b7e2-3a7d32ac62cf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9b9098a4-eef9-4ae7-9df2-b73aef776206", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "05930182-1c43-4900-9404-8f6238971058", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3bc182ff-9446-498e-bfe0-d09ec76c019a", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "00b1f3b4-cd3c-4501-8773-4ca89df0d74c", "EffectiveDate": "2025-07-30T23:23:32.4913068-07:00", "WellPurposeType": { "WellPurposeTypeId": "3676cef5-29dd-4bce-8c6b-be03b1e32194", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9b1c562c-f09f-42f9-9e83-85106211c059", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ce10326b-4374-4fa3-ad65-1e51ff350fa2", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:23:32.4913068-07:00", "MeasurementValueNeededDate": "2025-07-30T23:23:32.4913068-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b6d83fb0-0bab-41cc-8b98-ca7f5c29a82e", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-30T23:23:32.4913068-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "3e4a35a8-c235-4888-812f-ccbcfecfde1a", "CreateDate": "2025-07-30T23:23:32.4913068-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:32.4913068-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }