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": "2230b99d-1396-4b07-bc40-a03405d80022",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "c481ec8c-9da7-49e1-9415-0c184e8038db",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "86c1b1fb-8753-40ae-8709-beab740b4e0d",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "1a7606a3-c946-48d3-85f0-df149c0add1b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7c7e5516-e023-4a53-bd14-58a42b7ecf27",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e846877a-3a8c-4522-9336-b34714070bf2",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "544ec2fc-5c11-4bff-bc08-933f6ce6edb6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-24T15:02:32.4727808-07:00",
"MeasurementValueNeededDate": "2026-05-24T15:02:32.4727808-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2cc9eca8-da45-42a5-9060-4bb6a569fe5d",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-24T15:02:32.4727808-07:00",
"MeasurementValueNeededDate": "2026-05-24T15:02:32.4727808-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1a000ad6-9e88-438b-8311-0330a8e50d26",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-05-24T15:02:32.4727808-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "4ca4e400-7e10-4775-99c5-243e05163bbd",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-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": "a90e267b-c005-46ba-aef9-ec68d1e7e628",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "5b319097-d9c3-4c4b-b403-02f591983c8b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "514545ad-74c2-4a01-bb0b-5e0a5a8d89fe",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "b39ac353-7612-42d8-a917-913f085dc99f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "363c94d0-3f70-4de5-9034-7fcc65f1e88c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e6c8fa00-e5b5-4da4-8704-4b9cfba21df1",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f0d7fad2-52dc-4c23-9aef-36b30cc253ac",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-24T15:02:32.4727808-07:00",
"MeasurementValueNeededDate": "2026-05-24T15:02:32.4727808-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1054abdf-3201-4a8e-9ad6-54fa1f2c8c3f",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-24T15:02:32.4727808-07:00",
"MeasurementValueNeededDate": "2026-05-24T15:02:32.4727808-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2b758950-5fd4-4612-8b27-cf06486c9f33",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-05-24T15:02:32.4727808-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "277ca07e-1e86-43e0-92c2-acc23ec999c4",
"CreateDate": "2026-05-24T15:02:32.4727808-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T15:02:32.4727808-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}