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": "2b76205c-7f15-4216-9357-f691475faa43",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "ce555356-3473-447d-ad68-339120d2e573",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "47dcc539-f995-4424-827c-4a4f5988ada5",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "b18cc781-8d43-466b-80fa-eb46b59d8b8f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "dee9b5d0-13ef-4bd2-a191-b5f9b1267312",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4336a238-b243-41ee-8ace-4ded8b2ba134",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "88cc706d-79fe-4b93-98e0-3f45a80e3d98",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-02T14:36:21.3539928-08:00",
"MeasurementValueNeededDate": "2025-11-02T14:36:21.3539928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "99a49932-f6e5-4f21-868a-95249d341379",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-02T14:36:21.3539928-08:00",
"MeasurementValueNeededDate": "2025-11-02T14:36:21.3539928-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1f890b0b-b31d-4873-aa65-d9c195c88cf1",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-11-02T14:36:21.3539928-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "a067a06a-b404-4e6b-8024-c6762b72445d",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-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": "b44c3a88-7a60-43e9-ae72-4f1f72611255",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "2c02862a-825c-4210-8c6c-929ef2029767",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6b28ca3c-7b93-4c04-ad27-edafe716dc20",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "0c2c4b67-647d-49ff-9fba-78a4ffe307dd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d02476cb-2611-4028-99c8-0cd3506f5d6b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5c8f9ee5-0512-40f6-9ba9-c11805f3becc",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "40ee8a55-965c-405f-a5a7-9131e97bb48e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-02T14:36:21.3539928-08:00",
"MeasurementValueNeededDate": "2025-11-02T14:36:21.3539928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5c66b1cb-4fed-4ec3-aac9-18891bb7637c",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-02T14:36:21.3539928-08:00",
"MeasurementValueNeededDate": "2025-11-02T14:36:21.3539928-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0500da62-ed6d-4435-871c-00863e962c7e",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-11-02T14:36:21.3539928-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "ecf9b4a7-2b06-481d-99fb-9f1f4adadcdc",
"CreateDate": "2025-11-02T14:36:21.3539928-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T14:36:21.3539928-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}