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": "c3cab374-54a5-4678-994b-15fdae03a87e", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "3a95dae6-369d-4a14-8e54-528dceb31fa4", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "48cfaa04-eb9a-4cb1-b1f3-3ceec9afcc5f", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T07:30:25.4685036-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "b1476313-30be-4841-adf0-159d691003f1", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9ef1bb18-295d-40d0-947f-96023df9fa9b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "af61854a-f0e8-434f-a62b-cf4e81409f11", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:30:25.4685036-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fef84270-120e-4a73-9213-391a31ad8195", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T07:30:25.4685036-07:00", "MeasurementValueNeededDate": "2025-06-02T07:30:25.4685036-07:00", "SourceSystemId": "sample string 3", "CompanyId": "254cdd3c-5779-4f14-b0a6-453ae3b4bc4f", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:30:25.4685036-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-02T07:30:25.4685036-07:00", "MeasurementValueNeededDate": "2025-06-02T07:30:25.4685036-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "891deb18-372e-4962-a930-5beee9fdf223", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T07:30:25.4685036-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-06-02T07:30:25.4685036-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "7a8c222a-b755-4bc1-b900-60576ddccabb", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:30:25.4685036-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": "63135011-5102-459c-89a3-e4646a315630", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "4ab885db-399b-44a7-9eb3-969cb9f39c4a", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "562f2144-91c4-47f2-8640-2c7c8080b025", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T07:30:25.4685036-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "c0bb1f8b-2345-43d0-a886-9ff1bb3ea707", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "89017083-612f-4df6-8a31-b0cf82b61b28", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "abb4c219-a9bf-405b-90a8-41fc17a6c4ad", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:30:25.4685036-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "bf82bdbe-3ea7-476f-8063-412fe1365d92", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T07:30:25.4685036-07:00", "MeasurementValueNeededDate": "2025-06-02T07:30:25.4685036-07:00", "SourceSystemId": "sample string 3", "CompanyId": "64e28076-4f4d-42c9-9880-cb1f73cf1855", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:30:25.4685036-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-02T07:30:25.4685036-07:00", "MeasurementValueNeededDate": "2025-06-02T07:30:25.4685036-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "8f8f60b5-6d77-48db-b410-7c6a7285d55d", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T07:30:25.4685036-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-06-02T07:30:25.4685036-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "53189bde-bbb3-49ca-8ccb-ec41f5cb9d20", "CreateDate": "2025-06-02T07:30:25.4685036-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:30:25.4685036-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }