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": "6f1f06c8-d0fa-40b0-b765-45cb49b718f5",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "bded548e-1e32-4528-bb11-c59a95a8efd0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f5c9db78-14c6-4c17-ae32-d51e4e97341d",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "3d9b1dc4-bdff-4d38-9af5-c9f84dd6ffd9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "33762ff4-1768-41be-9c28-0506ef90180f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5b62b7d2-2e2b-4122-b0ba-9fc2cf3f9ef4",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c23c1ee1-b912-477d-b36d-12860e9a1a50",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-19T02:31:00.6122272-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:31:00.6122272-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "519af84b-4389-46a7-969b-f1bf402936c1",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-19T02:31:00.6122272-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:31:00.6122272-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "13fa2518-73c7-410b-9ef7-23ae0ce8dd5c",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-10-19T02:31:00.6122272-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "9879dadc-7cae-4407-9838-e76f88046abd",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-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": "02d1a100-59f7-4b19-9ae6-10a10375d4c5",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "a82840e1-2546-453b-b5d0-c026aa63c76a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "17d6a4e8-5082-46af-ab20-631cd0884578",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-07:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "b54a1b24-7b20-4f25-8b8a-149240ba2be1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2a3c6430-9921-4eeb-837a-093c847ddd7f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3409cff9-16f0-4dd5-94b2-a127a2879d41",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5f4a28f2-0736-439c-95cf-29d80a330e23",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-19T02:31:00.6122272-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:31:00.6122272-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "57f9ccc8-439c-49d7-9bb5-b26cc9177c01",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-19T02:31:00.6122272-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:31:00.6122272-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "08ae1b54-5144-42ba-8bcc-dc2b2a7e49d1",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-07:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2026-10-19T02:31:00.6122272-07:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "66ad6332-68b0-4070-86d0-670bc22af2e6",
"CreateDate": "2026-10-19T02:31:00.6122272-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T02:31:00.6122272-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}