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": "818fd7a8-5900-4afe-8ab2-9f7bdd33e560",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "7f72d77b-f786-4a16-96ea-cc0563c226c5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d8cd5e03-10d6-4b22-9c1c-8fe7eb0e9a3f",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "3fc76a11-762e-4180-a272-34e532c81da6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e851d915-7885-4315-85f2-b068c4a5dab9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "85bf2dc0-b918-492a-85c0-013ea3298e1c",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "cc8c5eeb-7b0f-4604-bc8e-dbb79ddc2e02",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-04T12:35:21.3432304-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:35:21.3432304-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "93a3aa24-e0ce-4f83-9351-b1d2a0a230ee",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-04T12:35:21.3432304-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:35:21.3432304-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "313ed0e6-1728-4f5f-bdb0-a7a16c9beea5",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-05-04T12:35:21.3432304-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "6ceb259c-dc65-4e76-a903-f98166acd6e4",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-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": "c6c49cfd-8ffe-4e84-b059-a30e5f68b6f4",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "e3517c57-4dd1-4db4-8d4b-ac7b4b64a7da",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "92737eb2-a30a-4cf7-a5e5-b7ccf44bf15d",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "b5a98d6f-0a86-4099-9829-873f4695425b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5a9fd260-bf5f-4519-a930-3bbc04832a48",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b45fce6f-4e8f-4c01-ab3b-d7e397e70aa7",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fe40a1cf-e071-4f39-8b46-a5b2d23e454a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-04T12:35:21.3432304-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:35:21.3432304-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c651a8a9-aaaf-4986-8394-3db7f8dfb537",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-04T12:35:21.3432304-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:35:21.3432304-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "655904d5-fc83-4b37-8953-e3dd928d7e9b",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-05-04T12:35:21.3432304-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "36b70bb6-7d86-414d-bf37-cc216e92592e",
"CreateDate": "2026-05-04T12:35:21.3432304-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:35:21.3432304-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}