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": "844bef0f-3e3c-4ceb-9d1e-bfcf9caceaa5", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "e554e7e6-14c0-4c2b-8c2a-2cdc40ed43df", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "16c5e552-1f06-43e0-a2bd-c53b789c7e09", "CreateDate": "2025-08-24T10:11:42.619393-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-24T10:11:42.619393-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "07094a8f-359a-4860-8458-2f50b044e16b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ebd0e0d8-dfc7-4ed0-aef3-0d9ea469c198", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3ecce68c-b0b1-4662-a621-e1ebf65bd373", "CreateDate": "2025-08-24T10:11:42.619393-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.619393-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "ec98a961-715c-41b5-bf16-87f3352a38f1", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:11:42.619393-07:00", "MeasurementValueNeededDate": "2025-08-24T10:11:42.619393-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c7d194ff-7bbd-441a-9319-7a60f1a201d8", "CreateDate": "2025-08-24T10:11:42.619393-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:11:42.619393-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-24T10:11:42.619393-07:00", "MeasurementValueNeededDate": "2025-08-24T10:11:42.619393-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f03fc93e-f841-467a-828c-7608434347d6", "CreateDate": "2025-08-24T10:11:42.619393-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-24T10:11:42.619393-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-08-24T10:11:42.619393-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "c8700d68-6f5f-4af1-9999-4b62446b18e1", "CreateDate": "2025-08-24T10:11:42.619393-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.619393-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": "e5215adb-8d71-4d88-8757-9ebb7e2589fe", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "db7bd1bd-2b19-4c33-b392-16a5b814497e", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "839aa48e-da81-49c6-b686-73f5bebb0e10", "CreateDate": "2025-08-24T10:11:42.6350611-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-24T10:11:42.6350611-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "f8753def-1c7e-422c-868e-40f7da63566f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "1e994a1c-9729-44be-a7c1-c497f79ac73d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9f7b25b3-db5d-4306-a3f4-56f2fae47ea2", "CreateDate": "2025-08-24T10:11:42.6350611-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.6350611-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "1776c41b-e430-4bde-9cbe-da6beafeb5f2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:11:42.6350611-07:00", "MeasurementValueNeededDate": "2025-08-24T10:11:42.6350611-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4584a81f-27c1-466a-87ec-aff1c426b0eb", "CreateDate": "2025-08-24T10:11:42.6350611-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:11:42.6350611-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-24T10:11:42.6350611-07:00", "MeasurementValueNeededDate": "2025-08-24T10:11:42.6350611-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "790a7222-891f-4830-b27a-46c7e5cd668d", "CreateDate": "2025-08-24T10:11:42.6350611-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-24T10:11:42.6350611-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-08-24T10:11:42.6350611-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "6a3bcb85-73c5-467f-969a-44121ef5fc09", "CreateDate": "2025-08-24T10:11:42.6350611-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.6350611-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }