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": "f794337c-fbfd-45f0-969e-bd0d43e553a2", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "ff5796ce-7547-4236-b834-ac8a7b0c45a2", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "7216ef11-a5dd-4b1f-90eb-c56945650852", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-15T22:02:54.6344929-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "16be27a4-fb45-4956-a739-f95ba4e4952b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "c9af124e-83b5-41b7-9a78-07c458d90add", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5d1624ad-5f07-4e4c-86e4-fbb84eb27b63", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-15T22:02:54.6344929-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "98cc0426-6c59-47d6-bc6b-64c1f791bd81", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-15T22:02:54.6344929-07:00", "MeasurementValueNeededDate": "2025-09-15T22:02:54.6344929-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c94531db-9284-4ef0-b2f8-97d378be9ef6", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-15T22:02:54.6344929-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-15T22:02:54.6344929-07:00", "MeasurementValueNeededDate": "2025-09-15T22:02:54.6344929-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2e53330e-1608-4690-994e-b274c4d8c8b7", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-15T22:02:54.6344929-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-09-15T22:02:54.6344929-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "37840483-f94e-4c30-a1ef-4e27134f035c", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-15T22:02:54.6344929-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": "43852c25-c615-4853-9d4a-6e9846c3a106", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "168e049c-4932-4f85-90b6-dabaedc35f93", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "e1a2968d-2f84-4f1a-9f09-2a0650ebd2c4", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-15T22:02:54.6344929-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "4f68fe2b-99ee-4284-ba69-6e4b84fedbc2", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "03061c59-3796-4dae-ab70-ea283dd60a78", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4509d6e2-ef67-49a2-86b8-0b562bfed894", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-15T22:02:54.6344929-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "6a9c4141-1f5a-49fe-871e-6b4863ff3a23", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-15T22:02:54.6344929-07:00", "MeasurementValueNeededDate": "2025-09-15T22:02:54.6344929-07:00", "SourceSystemId": "sample string 3", "CompanyId": "eda2ba82-0480-4192-aeee-f02e03bb8120", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-15T22:02:54.6344929-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-15T22:02:54.6344929-07:00", "MeasurementValueNeededDate": "2025-09-15T22:02:54.6344929-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "6506bb20-8c2c-437a-be66-14c12898383b", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-15T22:02:54.6344929-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-09-15T22:02:54.6344929-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "af9a4237-96c3-41ea-848f-91cb55f1273b", "CreateDate": "2025-09-15T22:02:54.6344929-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-15T22:02:54.6344929-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }