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": "0b2117c3-0d95-451d-8571-da23b08de446",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "c3949283-c7cc-412b-ae18-cb66b4d79fd3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8b813d6e-43ad-469c-9969-09e71a3b8686",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T20:33:30.777531-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "a3459701-89f4-4b5e-ba65-8b12cd8e2a5d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "79d4040a-b85d-4388-9fab-8d479d683300",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "eed50c6b-6ef0-4447-bf79-95d1764cff62",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:33:30.777531-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a5af3eb1-1f6e-4bbd-8b6e-26d46324866a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:30.777531-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:30.777531-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e1cd11f8-fd1c-45f4-a5ff-dfb62d111a86",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:30.777531-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-27T20:33:30.777531-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:30.777531-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "08a55804-cea1-4928-ae89-f0ebf50205fd",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T20:33:30.777531-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-04-27T20:33:30.777531-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "77accdfa-0459-43c8-818e-1ee966e212c3",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:33:30.777531-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": "7e077fa7-9677-4629-a94a-fca9e7a82b79",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "693c0d2a-2899-442c-bb80-885df6961592",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1278358b-296c-42e2-82f7-08be14945d8f",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T20:33:30.777531-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "50f7b264-7f56-4472-a193-4c74206720d4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bf4ca759-4bfc-40aa-9f65-49c8c6608113",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ba0951c4-c916-41c8-96bd-4536faab5a80",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:33:30.777531-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4574ddea-9192-4c4b-9ca0-520b544bda5e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:30.777531-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:30.777531-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ae975569-0961-4e0f-9561-f4984829f488",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:30.777531-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-27T20:33:30.777531-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:30.777531-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "284f854e-cf8b-415c-ae29-31de0605fb91",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T20:33:30.777531-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-04-27T20:33:30.777531-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "41eef44d-ec05-4d87-a429-c570c34d2c28",
"CreateDate": "2026-04-27T20:33:30.777531-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:33:30.777531-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}