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": "759665d8-17eb-492d-b4d3-4aec306d6837",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "137737b8-b4ee-464e-a611-aa240fa65fc2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5817befc-ccc5-4577-954a-c671bf004c6b",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "ca6f9a20-6337-458c-8183-4d8f319071e7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e1b4f054-209b-4df9-a69a-b5e927242175",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a70d69a0-2c5e-4466-a050-0f57422b3a90",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "717d7710-2d8d-4891-804f-2660a97f08b2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:38:57.4317363-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:38:57.4317363-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9866e06c-1aea-4107-a7e6-87f4271a83a3",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4e4c4533-1182-4905-852a-aec4b5ebf90b",
"EffectiveDate": "2026-03-09T20:38:57.4317363-07:00",
"StateType": {
"StateTypeId": "ef71ed45-be8c-4d8c-89ba-d07538245fbf",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e1b4f054-209b-4df9-a69a-b5e927242175",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a70d69a0-2c5e-4466-a050-0f57422b3a90",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "20cc51d9-2870-487d-a7ce-ce8cedf95bf4",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "87f00c89-616a-41fd-a10d-2d41e4de2743",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "52df2508-a8ec-43ee-9468-091972cd0d4e",
"EffectiveDate": "2026-03-09T20:38:57.4317363-07:00",
"StatusType": {
"StatusTypeId": "880ad2f1-cf00-40e3-84e1-80afc0bed7a9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e1b4f054-209b-4df9-a69a-b5e927242175",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a70d69a0-2c5e-4466-a050-0f57422b3a90",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8ffe10a0-bb66-472b-8227-bf4ccb9bce0c",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8b06a160-f0ee-4d16-aa5d-571544618650",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "cadd97e1-83f6-4021-bc19-521afe22d6e8",
"EffectiveDate": "2026-03-09T20:38:57.4317363-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "ffa572d8-25e7-45ed-99f7-bd1db672f8f8",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "26e6ca94-6800-4612-a821-ba84d36cf1b8",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6a94bebe-67d0-4849-999e-49ba54050df7",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-09T20:38:57.4317363-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:38:57.4317363-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "124f158a-112f-48f2-82a8-36a5b2483a23",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-03-09T20:38:57.4317363-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "4dbeef7b-0fc3-400d-a846-615d08853bce",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-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": "fb94afa5-cc73-4d5e-ba57-c004a76785e0",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "9b1406bf-ca85-4f7e-897c-0b159ded0459",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "782fead3-6871-4a99-b5a1-26ba97077549",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "1c0a96b1-a058-45a3-8ddb-58c27d570f87",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8561cbdd-df45-434e-a461-75873d4ee4ac",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "49fbe851-bf05-4493-910e-78f2e3043f28",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5230114d-c560-43e8-9e7d-40098618e510",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:38:57.4317363-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:38:57.4317363-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2a04b31e-a72b-4067-8f28-982e60b1138e",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "24369c5c-9592-4c9d-a813-cffddb01b6be",
"EffectiveDate": "2026-03-09T20:38:57.4317363-07:00",
"StateType": {
"StateTypeId": "75610e6f-77f7-440e-95af-efeb2eb5a9fa",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8561cbdd-df45-434e-a461-75873d4ee4ac",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "49fbe851-bf05-4493-910e-78f2e3043f28",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "366d52e9-62f5-43f9-8403-2a6a6fd89c44",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7249c5b0-151a-4304-a9d1-21a79e32f3fa",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "bd7dc03c-c8d9-427f-b74d-e8736347a54c",
"EffectiveDate": "2026-03-09T20:38:57.4317363-07:00",
"StatusType": {
"StatusTypeId": "b1218ed5-c877-4e01-8841-079d6cdfb633",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8561cbdd-df45-434e-a461-75873d4ee4ac",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "49fbe851-bf05-4493-910e-78f2e3043f28",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9b7e5bed-189d-4517-8bb1-8a5cf83db779",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d24df5a2-b5c1-452b-af54-3c11e5523708",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e59051d3-9265-4cab-a072-919907ab7c23",
"EffectiveDate": "2026-03-09T20:38:57.4317363-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e6ffcfd8-e892-4dc2-9a57-948d008e1756",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "41c40770-5a8a-48cb-ac14-51c223a0a009",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a6bd029b-e8a2-4064-9b95-018e99e3e0fa",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-09T20:38:57.4317363-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:38:57.4317363-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e48dcf4e-dabc-4f24-80e3-d1a9bd0c715d",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-03-09T20:38:57.4317363-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "f4814990-ebaa-494c-a474-d6fb5b7a41dc",
"CreateDate": "2026-03-09T20:38:57.4317363-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T20:38:57.4317363-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}