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": "559f7334-0599-4e08-abc0-46194a54081c", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "1237b415-7d39-4614-81be-cc581d08cd04", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "ba8ca9bd-aa57-4892-9c73-da908d47dd69", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "6b45ad00-b2a4-4a24-9d29-9fb54042286c", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d2e80a19-2387-4e48-bf39-9c225ae166a8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c3120b70-26c8-4221-bfaa-7f33396ae5d1", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "adfebdf7-8bf1-419d-b377-a69a0b2872f4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T21:39:16.1080865-07:00", "MeasurementValueNeededDate": "2024-04-28T21:39:16.1080865-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c2bac10d-54b3-47da-9e94-e86dac9cde2a", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "dc35e3c8-8dda-4b3d-abb6-6ec6c8d2f569", "EffectiveDate": "2024-04-28T21:39:16.1080865-07:00", "StateType": { "StateTypeId": "fb25521d-207b-4527-9c60-c3ad197ee2d9", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d2e80a19-2387-4e48-bf39-9c225ae166a8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c3120b70-26c8-4221-bfaa-7f33396ae5d1", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "4cca3d0b-aa4c-4a1c-a69d-c9b4617783b9", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "24347aa7-0732-440b-97b9-c7fba700cde9", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "08d17871-0284-4646-8f17-05da493aef3a", "EffectiveDate": "2024-04-28T21:39:16.1080865-07:00", "StatusType": { "StatusTypeId": "750b1d68-a965-4053-9d11-4d753fc40278", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d2e80a19-2387-4e48-bf39-9c225ae166a8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c3120b70-26c8-4221-bfaa-7f33396ae5d1", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "c73859d4-6c0c-4fb8-883e-00ccbffbbb36", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c02d378d-f17d-4520-92fe-4fcfe9ec1e84", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "ed2788a9-a59a-44ef-bb50-00a874d8d4ad", "EffectiveDate": "2024-04-28T21:39:16.1080865-07:00", "WellPurposeType": { "WellPurposeTypeId": "79b0dc41-b488-4aa0-bbd7-2a3c71a030f8", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2dc9c235-259e-4cd0-8aec-2a3929a13c3c", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c17c73cd-416f-48c5-b68f-8ae6ded216a0", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T21:39:16.1080865-07:00", "MeasurementValueNeededDate": "2024-04-28T21:39:16.1080865-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "613f0a55-1999-4c16-aed1-dff3fdf205ab", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-04-28T21:39:16.1080865-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "891c4691-faf3-44e8-8b3e-6f749eddc1a2", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:39:16.1080865-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": "469b3986-4379-486e-bb26-e2594d6a4584", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "1a1e4d04-2fcc-4f7f-94fb-6873c43e37a0", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "d54e9537-b6f2-42d5-b1dd-b4de8d70f77f", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "8569ae43-f5da-41b7-9ac9-b05ba565ce8e", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "fd594bb5-b5a6-4290-8f3d-2ee7c950b9ff", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "78ce57c0-2b74-40a0-a5ef-48ef7bbd78a0", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "cfcdda02-d99f-4e62-8573-4f0587fbe39a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T21:39:16.1080865-07:00", "MeasurementValueNeededDate": "2024-04-28T21:39:16.1080865-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5cddc354-393b-46b0-9765-c17713f76d47", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "9e1763d1-9bc0-4387-90b9-0fd9059ae931", "EffectiveDate": "2024-04-28T21:39:16.1080865-07:00", "StateType": { "StateTypeId": "deb51edd-ef3a-4079-a06a-d10280b676a6", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "fd594bb5-b5a6-4290-8f3d-2ee7c950b9ff", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "78ce57c0-2b74-40a0-a5ef-48ef7bbd78a0", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "81b9fc8d-1489-4c4b-b790-cfedc051c14b", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c4ceb872-60eb-4bb4-afdc-f301012919fd", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "4d5ab156-de67-432c-a0d2-5e9abb49faf4", "EffectiveDate": "2024-04-28T21:39:16.1080865-07:00", "StatusType": { "StatusTypeId": "9e03c1a3-e19f-4f07-9487-5bf848114164", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "fd594bb5-b5a6-4290-8f3d-2ee7c950b9ff", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "78ce57c0-2b74-40a0-a5ef-48ef7bbd78a0", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "3722ace1-2d84-4e80-915d-48dbb5b0c361", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "8ed4e480-d62a-4342-a61c-5deaef21d62a", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "cf054e20-c617-4f3e-a65a-1f3ed3494eca", "EffectiveDate": "2024-04-28T21:39:16.1080865-07:00", "WellPurposeType": { "WellPurposeTypeId": "fbcc7c10-6826-42b9-b40b-fac300312854", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b4a9dc34-fde0-4049-a378-05b3943d555c", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7fcc0ed4-a2c7-4b56-8b58-f0bb73874baa", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T21:39:16.1080865-07:00", "MeasurementValueNeededDate": "2024-04-28T21:39:16.1080865-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "305a4781-bbdd-40a1-9418-9415e85a27c2", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-04-28T21:39:16.1080865-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "4357199f-770f-474e-8a07-b4431cff433c", "CreateDate": "2024-04-28T21:39:16.1080865-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:39:16.1080865-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }