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
Attachment| Name | 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": "de6772a5-ff1e-478b-b1d7-a0af62c38a74",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "3fdf686d-1124-4ad8-a49e-9d7e905eb68a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "13db145a-942a-4123-af25-eaf878d72e08",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "5c1aed95-1f6f-4fee-af45-e7650dfb9393",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bb2a6049-ac09-48ac-963b-7302c3d156e4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f78e261a-8ad6-4dd0-9ac5-3d232a0d8981",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "306e543d-fc77-43de-9ce2-424a83e20367",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-19T00:26:34.4808232-07:00",
"MeasurementValueNeededDate": "2024-04-19T00:26:34.4808232-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3581a948-af68-42b6-9d4f-e7a656dafcb2",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "553cab5a-827e-47fd-bc92-3ea50a2fd448",
"EffectiveDate": "2024-04-19T00:26:34.4808232-07:00",
"StateType": {
"StateTypeId": "96ec207e-c51c-411f-9bf4-eb7db8d24c88",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bb2a6049-ac09-48ac-963b-7302c3d156e4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f78e261a-8ad6-4dd0-9ac5-3d232a0d8981",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "093be6ee-4fd5-4325-afd8-206baa2428b3",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0fb27241-d23b-4718-8527-03245971bc57",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4024df0a-0599-4521-af31-6d4620e09ea9",
"EffectiveDate": "2024-04-19T00:26:34.4808232-07:00",
"StatusType": {
"StatusTypeId": "41891629-146d-42b3-ae95-9a13204a971a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bb2a6049-ac09-48ac-963b-7302c3d156e4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f78e261a-8ad6-4dd0-9ac5-3d232a0d8981",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "bae9a94b-c890-4746-8e61-491ebce27731",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2a97ae5f-6330-4c42-a200-c05c3e1a18da",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ea5360fd-b2f1-46cd-8c68-442e5dbfac6d",
"EffectiveDate": "2024-04-19T00:26:34.4808232-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "2fb9a2ec-9aed-4990-ae13-d8fbbff9d93d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c8a549e6-1320-4b27-ab78-6c9bc7764c34",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2459d9da-f207-42fc-9c56-79c563df457a",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-19T00:26:34.4808232-07:00",
"MeasurementValueNeededDate": "2024-04-19T00:26:34.4808232-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "017791e6-bc59-4aa1-ad0b-36763aaca6eb",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2024-04-19T00:26:34.4808232-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "b1945255-10fb-4506-915b-a2c817b36610",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-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": "72068e7c-3d2e-4b1e-bf67-766c076bc310",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "a3bf0f4a-b901-4e10-a703-324dbc03d0e3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "36202ced-fd4f-42e3-8754-d37c2bc369fe",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "46510466-0d2c-4c99-841f-7b42b0f814e9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1a03ded0-1e73-48df-8346-2aa52d4366a5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f5c5c17-5c3c-42e8-826b-b2d3ae98ad67",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e526ccf9-4ae1-4282-9db5-fdf6dbb4d067",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-19T00:26:34.4808232-07:00",
"MeasurementValueNeededDate": "2024-04-19T00:26:34.4808232-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "779f58f1-887f-4f6d-a854-c6c72f986316",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "29d198fe-109f-4792-a4fd-053be3c5bb3c",
"EffectiveDate": "2024-04-19T00:26:34.4808232-07:00",
"StateType": {
"StateTypeId": "2a790216-bccc-4f88-9474-5dae32604ca8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1a03ded0-1e73-48df-8346-2aa52d4366a5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f5c5c17-5c3c-42e8-826b-b2d3ae98ad67",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "910142ae-c3ed-4b20-83b8-0ba978b58479",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "43c9692b-c261-4300-b150-008ee81c17f7",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f73d0853-c7dd-48ee-9e50-10311a7681aa",
"EffectiveDate": "2024-04-19T00:26:34.4808232-07:00",
"StatusType": {
"StatusTypeId": "73f0811b-37cf-4562-8227-bda62a7530e1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1a03ded0-1e73-48df-8346-2aa52d4366a5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f5c5c17-5c3c-42e8-826b-b2d3ae98ad67",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "988e0c2f-8288-44b8-876f-480287b4dabb",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e1177713-2991-4544-8004-4992c00d08fc",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "39edbf4a-5b74-47f9-8eb6-1be9211d07c4",
"EffectiveDate": "2024-04-19T00:26:34.4808232-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d5063948-fee3-46ac-8cab-a95a5df1b788",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5cb0ab1c-7b8d-4139-be46-696aca912822",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ac70566b-7d12-43a9-b3af-15bdb267bb2f",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-19T00:26:34.4808232-07:00",
"MeasurementValueNeededDate": "2024-04-19T00:26:34.4808232-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6a461f1a-030e-46cc-8520-39198cee2dc4",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2024-04-19T00:26:34.4808232-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "c50dbb3d-6732-439d-8f11-6f80cdc041b8",
"CreateDate": "2024-04-19T00:26:34.4808232-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-19T00:26:34.4808232-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}