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": "558ad5a4-4d3e-4562-af52-47aea0a40d72", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "52348228-ccf8-4780-8d8a-62f4f182d3c5", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "70941361-baa4-45be-9271-e99cc4d12cd0", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T14:40:17.862977-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "2a7eaaab-e218-4bb8-b77a-9a9084594cad", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "2be8e0a3-a730-4b91-b475-8e1e85d9407e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "02920eb6-ee8f-4f80-8617-18b3d15620e5", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T14:40:17.862977-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d9fc7d35-f5d6-4b6b-b878-8bebed290ea7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T14:40:17.862977-07:00", "MeasurementValueNeededDate": "2025-05-08T14:40:17.862977-07:00", "SourceSystemId": "sample string 3", "CompanyId": "679c4691-2c2d-4c7e-988f-150fe1d25d49", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T14:40:17.862977-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-08T14:40:17.862977-07:00", "MeasurementValueNeededDate": "2025-05-08T14:40:17.862977-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a536d3fd-e230-4053-89f4-7d0dd8222755", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T14:40:17.862977-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-05-08T14:40:17.862977-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "efcfeeb6-5485-4b37-a87f-e40a1d6943fa", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T14:40:17.862977-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": "3f9ba4c4-81b8-410b-9b38-9f6b74b401d1", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "d70cb261-5389-4f53-974e-67016a826daf", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "287a40f7-a976-4311-9e0b-b035e3bc62ed", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T14:40:17.862977-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "b6190e3a-7d71-466b-9571-b46818997c2e", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "0449921f-2cd3-4cc7-818d-45f531517282", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e5dce562-90d4-4589-a4f8-8eec8de6dba4", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T14:40:17.862977-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "07f73442-5843-4322-a5f0-be650d613d1c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T14:40:17.862977-07:00", "MeasurementValueNeededDate": "2025-05-08T14:40:17.862977-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d5be6232-425d-4554-a3f0-4180f3c246f3", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T14:40:17.862977-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-08T14:40:17.862977-07:00", "MeasurementValueNeededDate": "2025-05-08T14:40:17.862977-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "eb2fbad1-f0a6-4b68-afd0-ab4af720c25b", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T14:40:17.862977-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-05-08T14:40:17.862977-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "cba624a3-0191-461b-9314-729abbc98ace", "CreateDate": "2025-05-08T14:40:17.862977-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T14:40:17.862977-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }