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": "4b5ee837-abe2-44d1-afa0-949daeb12df4", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "b0d14ea8-ac40-4085-9424-6823133b8eb1", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "82e5d837-ab04-49f7-ba95-43ad9e865bf4", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-31T18:00:29.0479482-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "a6bda32d-6169-4e40-b347-df42383c52f7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8304a769-43b1-46ad-869c-59deddea1b5e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c7cec336-71b4-41b2-b138-25682beef2c8", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T18:00:29.0479482-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "b7fcc37d-e06f-45aa-95f6-833706962536", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T18:00:29.0479482-07:00", "MeasurementValueNeededDate": "2025-07-31T18:00:29.0479482-07:00", "SourceSystemId": "sample string 3", "CompanyId": "79f2f514-ebaf-40bb-aad5-e9526d1af880", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:00:29.0479482-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-31T18:00:29.0479482-07:00", "MeasurementValueNeededDate": "2025-07-31T18:00:29.0479482-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "283d74f0-650e-4e1e-a058-72e0b7cb5d62", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-31T18:00:29.0479482-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-31T18:00:29.0479482-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "8f1d45be-8d5e-42ab-b040-0fcce1e02ab6", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T18:00:29.0479482-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": "4dab9ec2-08ae-4c60-9866-9f1d87e1e743", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "9e39cca2-8f50-439c-b69d-0cac73a5d05c", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "be50142a-4a7d-4df6-b04e-dce7cfff1a2b", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-31T18:00:29.0479482-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "cf50a0bc-85fd-4d3e-88c6-9ba614589107", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "07343596-85ac-40c6-a40d-9f43a3f56db6", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4650893f-d368-4dfc-a51a-d90a35461c24", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T18:00:29.0479482-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "ea2889dd-78fd-46f5-bf8f-1c53c56f04ee", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T18:00:29.0479482-07:00", "MeasurementValueNeededDate": "2025-07-31T18:00:29.0479482-07:00", "SourceSystemId": "sample string 3", "CompanyId": "77abf871-17a5-4359-90b5-59d10cf352ce", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:00:29.0479482-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-31T18:00:29.0479482-07:00", "MeasurementValueNeededDate": "2025-07-31T18:00:29.0479482-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "88b34987-d11b-4045-a401-400e219fe648", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-31T18:00:29.0479482-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-31T18:00:29.0479482-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "476cf8c5-57b8-4209-948b-8c4d86303d48", "CreateDate": "2025-07-31T18:00:29.0479482-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T18:00:29.0479482-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }