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
AttachmentName | 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": "84a79681-e1d7-45b4-ab5e-54adfe317efb", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "6cda441c-c8e6-4963-96e7-cbd9e890f567", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "b5f9426d-c64c-4480-b329-d507afcc14c3", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-16T18:46:05.4209883-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "41f9a118-db33-4a1c-9b62-379befde2433", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "56bd0259-9588-4517-b9e0-54c348ac3e05", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f042a3ea-8e3d-43c2-b565-4024e1d86bdd", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-16T18:46:05.4209883-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "1d42e29d-9de7-4149-9bf2-a8a379387706", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-16T18:46:05.4209883-07:00", "MeasurementValueNeededDate": "2025-07-16T18:46:05.4209883-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d6f24dd6-2975-41fd-a491-7ea54856f006", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-16T18:46:05.4209883-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-16T18:46:05.4209883-07:00", "MeasurementValueNeededDate": "2025-07-16T18:46:05.4209883-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "bd2087ef-0a60-41fe-a64d-95dc3c23e0d6", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-16T18:46:05.4209883-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-16T18:46:05.4209883-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "572c52d2-caa3-4582-9afd-310b3369b3be", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-16T18:46:05.4209883-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": "e286fe80-b889-4df6-8e7d-5f6e07cfc2d8", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "46db9760-18fb-4de0-a55e-a887ba8b7d44", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "ff0c7fb1-b7d5-46e1-8c22-e46d789a321b", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-16T18:46:05.4209883-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "f9259671-5172-4f48-a56c-118b6b2a0963", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4a4ac8b8-f5e7-4793-880a-17cd60ce51e8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "324f21e8-2dfb-48f1-ba72-a31f860be47b", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-16T18:46:05.4209883-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "350b5e0e-69d3-4884-a2a1-dffc533a89bf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-16T18:46:05.4209883-07:00", "MeasurementValueNeededDate": "2025-07-16T18:46:05.4209883-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e64bdddb-7044-4e29-bfcd-4141ad5a8ef0", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-16T18:46:05.4209883-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-16T18:46:05.4209883-07:00", "MeasurementValueNeededDate": "2025-07-16T18:46:05.4209883-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "bd1b6d0a-686b-402a-8d96-db69551656bf", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-16T18:46:05.4209883-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-16T18:46:05.4209883-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "2f207927-937f-4ab8-8d50-340406611b67", "CreateDate": "2025-07-16T18:46:05.4209883-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-16T18:46:05.4209883-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }