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": "928105ac-b389-4882-af1b-64a3a7b2b50e", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "aa8b1d43-4713-4dfa-ba25-a290a215912a", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "a6dc004b-43ec-475c-b473-5fae9df57189", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-17T23:37:47.1461562-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "b24f8d9e-3142-4e68-a522-fcb380b24a6f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e6eb4b31-399f-4533-ab19-5e09f3a5e6f7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3fd3c044-d9df-46fd-98c7-39705b30fb42", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-17T23:37:47.1461562-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d2e01ea2-9e7e-4861-b477-04b03a639068", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-17T23:37:47.1461562-07:00", "MeasurementValueNeededDate": "2025-09-17T23:37:47.1461562-07:00", "SourceSystemId": "sample string 3", "CompanyId": "18636c6f-e070-46b4-9060-67524fe9aac0", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-17T23:37:47.1461562-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-17T23:37:47.1461562-07:00", "MeasurementValueNeededDate": "2025-09-17T23:37:47.1461562-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2a3509bc-c69c-42cc-9ff1-8015342b1450", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-17T23:37:47.1461562-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-09-17T23:37:47.1461562-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "64987262-e1f5-40a2-a8b0-beb1ed196963", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-17T23:37:47.1461562-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": "5bca956e-6e38-4290-a961-98c61723653a", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "4b164a8a-e3df-4ce5-8210-088973343d97", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "e5331019-f6ed-4567-b1fd-14bf7ff5d865", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-17T23:37:47.1461562-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "7dbe1c9e-80df-4b2b-a91f-1b180cf33178", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e57e5257-dfc8-4c49-bb3a-c37a1e66e280", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "6f6eb55a-3a54-4d5e-95cf-a2692ddf483d", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-17T23:37:47.1461562-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "547c1e1b-b5b7-496c-bf9d-96938b5cdb4a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-17T23:37:47.1461562-07:00", "MeasurementValueNeededDate": "2025-09-17T23:37:47.1461562-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c1e0acda-2163-450d-8aab-a3b5ce33d209", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-17T23:37:47.1461562-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-17T23:37:47.1461562-07:00", "MeasurementValueNeededDate": "2025-09-17T23:37:47.1461562-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e529fb17-e05c-4732-b88a-9b778c333ccb", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-17T23:37:47.1461562-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-09-17T23:37:47.1461562-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "b809c4c7-9c36-403f-a1de-27fd16c3d80a", "CreateDate": "2025-09-17T23:37:47.1461562-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-17T23:37:47.1461562-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }