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": "f0d11e25-3838-412c-85e4-6baf398e974c",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "55986503-2c86-4ce1-94ff-ba4473a77ae8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e3e2f562-d018-4d87-aa3d-9687ab0640cf",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "bf4bf08e-2615-4644-85c6-00c231174c94",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "93a6baef-9f5c-4de0-a88e-87e8143c9359",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f893c7a-54b4-4d2a-8deb-f04362fd0c42",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e37c912b-fabc-43e0-952a-8476c9d5d579",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-17T03:22:50.5444544-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:22:50.5444544-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "875f2592-4918-4159-9dfd-4c74107ef996",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1edf6e5a-6143-4119-af7b-09bfc9aff936",
"EffectiveDate": "2025-04-17T03:22:50.5444544-07:00",
"StateType": {
"StateTypeId": "c5835527-89b9-499f-9e1f-a76567617645",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "93a6baef-9f5c-4de0-a88e-87e8143c9359",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f893c7a-54b4-4d2a-8deb-f04362fd0c42",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "af7447dc-cab7-4d8b-9544-9d928d361e44",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1ef93988-d371-475a-845b-dec845099a8f",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fc9fbb89-9153-4ba4-98a9-77beef67b1d5",
"EffectiveDate": "2025-04-17T03:22:50.5444544-07:00",
"StatusType": {
"StatusTypeId": "551de46c-c7c9-4fbf-b9a4-439f9f93856d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "93a6baef-9f5c-4de0-a88e-87e8143c9359",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f893c7a-54b4-4d2a-8deb-f04362fd0c42",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3ea8641e-2f7a-44dd-8fe0-fa75034b4658",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d3a7251c-52c5-4918-9201-4fe8a41fa503",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6567aba0-7f7a-493b-9d03-03747470aaea",
"EffectiveDate": "2025-04-17T03:22:50.5444544-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "76df3d7e-e761-4240-8afe-b8f71a9f7f82",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8ceb9656-f2c3-4e68-869b-f42ae1f08a5f",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "509676e9-1992-47b9-a4d9-053f4f5b2ddc",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-17T03:22:50.5444544-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:22:50.5444544-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e0415c09-b452-4adc-88bd-ce944f6ba0a5",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-04-17T03:22:50.5444544-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "3ee527c8-d7dd-4a05-9d00-8b1c15eda8e2",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-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": "198de07c-f159-4126-8336-6456d4fa42af",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "5daf2879-a8f0-403f-be22-0f787c4ccda2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "37c98531-7fda-430a-8c73-369b373e7718",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "62da8ac9-2ddb-478b-92ff-2f2a4ec45d35",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b7fe7bb5-86be-41f7-b744-cf23b5dbc5d2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "841894ac-bba8-4d59-935d-d00739f634b9",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "065afddd-6616-4dfe-b15d-782971d453b0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-17T03:22:50.5444544-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:22:50.5444544-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2a684c47-69e3-4cce-9481-91e323fda646",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "952d9189-f656-41e3-a006-ed2233410ccd",
"EffectiveDate": "2025-04-17T03:22:50.5444544-07:00",
"StateType": {
"StateTypeId": "6639c50f-dd4a-4c2a-873b-1f4fb07c2d6a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b7fe7bb5-86be-41f7-b744-cf23b5dbc5d2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "841894ac-bba8-4d59-935d-d00739f634b9",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d8ed2709-b42e-42c0-bb9c-e50de0d0df48",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c8a49f61-e9f5-4f4b-be47-cbe9e26e21b3",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5747e98f-c72e-4133-b81f-182adce98ba8",
"EffectiveDate": "2025-04-17T03:22:50.5444544-07:00",
"StatusType": {
"StatusTypeId": "9a9e7a3f-fc86-439a-a098-9c9b9e2baa2c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b7fe7bb5-86be-41f7-b744-cf23b5dbc5d2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "841894ac-bba8-4d59-935d-d00739f634b9",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "232f8335-42d1-4793-aaf8-147b38a98728",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1dcd5896-f031-41a5-b3ee-d4573d2849cf",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5b0737b8-6692-453c-9be8-f055e326f630",
"EffectiveDate": "2025-04-17T03:22:50.5444544-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c056315c-3f54-433e-8135-0a946050a282",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a3bc7fa6-138b-4f5d-82ab-700a2614e720",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ae8aa237-3c36-4bca-ba31-3b5da2d7321a",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-17T03:22:50.5444544-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:22:50.5444544-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "be1c0e29-52be-4d1a-9c01-a2ddcd53c770",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-04-17T03:22:50.5444544-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "27e7ed75-3841-4bd4-ab54-aef18a395df9",
"CreateDate": "2025-04-17T03:22:50.5444544-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:22:50.5444544-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}