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": "7a851eba-4ba6-4b7b-b765-0ae116ea2c26",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "309656cb-0a22-4bf9-86f9-1f5330e29047",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0f2a3c53-02d2-4929-a6fd-8771e7a0ac49",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "effa8382-4b27-44eb-b5ad-2ede71bd9fe2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "717e2be6-f124-4c8d-ab2b-5d9d19dee684",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5bb82b30-3cbe-4cc8-91e8-84eae0e42e03",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5bdd8eab-7665-4f56-b88c-8d9a522e3f79",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-16T16:21:21.5988682-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:21:21.5988682-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9d5ee188-1942-47f0-b9d7-1180d333774c",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-16T16:21:21.5988682-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:21:21.5988682-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5b86f14a-921a-460f-91b7-c76c834b9e0c",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-01-16T16:21:21.5988682-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "01a6ae42-35ae-4847-a5b2-69a9d02a52aa",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08: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": "1a7625a9-2eab-4f39-92e3-78cd3dd1564b",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "0792f261-6ca1-409e-8055-58206716225d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c3119172-79e1-480e-be10-deeba8dedc66",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "7579d38c-28ef-4e53-9bc9-2b343a62c597",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "42105682-575f-4fec-8e20-0b373adbf0af",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "99a76135-060c-482b-9362-534afa70d9c1",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "63071cab-6743-443a-9060-d8b329373f92",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-16T16:21:21.5988682-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:21:21.5988682-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "62946d5b-e24c-4bb8-a5b3-b13b89429bd0",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-16T16:21:21.5988682-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:21:21.5988682-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "031385ed-f10c-4c3a-9756-fca7253ef44e",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-01-16T16:21:21.5988682-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "8089f1e5-4bad-4406-a026-4540a4f7b112",
"CreateDate": "2026-01-16T16:21:21.5988682-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.5988682-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}