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": "609156aa-985d-4f82-b679-d3cf6a51f8ec", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "42bdd90b-d4d8-4fcf-afb5-c2f0347efb44", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "35ec3147-0358-422b-9f1c-ffab42adde4d", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T01:54:01.6072541-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "89f8b5b5-4793-4779-b7c4-1afaa81169dd", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9212743f-415b-418b-8f1c-6916015f6152", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "301e4949-38fd-47b3-9976-d07fe4f3af4e", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:54:01.6072541-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "29d03f62-5e3f-4ec7-be66-21c0607bf596", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:54:01.6072541-07:00", "MeasurementValueNeededDate": "2025-05-09T01:54:01.6072541-07:00", "SourceSystemId": "sample string 3", "CompanyId": "af8642ce-55c9-4334-943e-771a5777e095", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:54:01.6072541-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-09T01:54:01.6072541-07:00", "MeasurementValueNeededDate": "2025-05-09T01:54:01.6072541-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "72e0e27a-2067-4164-a74f-40e0d544620b", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T01:54:01.6072541-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-05-09T01:54:01.6072541-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "3877bfe9-cd4e-4a14-bba1-db69fe540f80", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:54:01.6072541-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": "1138a09f-bcc3-4a80-af9b-5b0c7884d7cf", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "595b84af-4c29-4c95-9f27-ab3bf1ba9246", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "58cebaeb-8f46-46fc-9171-f1d417cb9a7c", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T01:54:01.6072541-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "4cb4f73b-6c78-4974-914b-3027fa8d6227", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "89c1c00e-ae4e-4aed-b55e-c7f39ba73c36", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "1278bc2c-bd03-4e14-a2a5-51386392e157", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:54:01.6072541-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fe634dbf-20e2-49e4-a91c-9ff1a4b5615e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:54:01.6072541-07:00", "MeasurementValueNeededDate": "2025-05-09T01:54:01.6072541-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a1296ac5-8570-4130-929f-ccd6d0242f54", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:54:01.6072541-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-09T01:54:01.6072541-07:00", "MeasurementValueNeededDate": "2025-05-09T01:54:01.6072541-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b352deb4-0798-4a3d-b9b2-a2b42c5fc8fa", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T01:54:01.6072541-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-05-09T01:54:01.6072541-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "d54a8208-dd4d-4c75-949f-08560bfdaf19", "CreateDate": "2025-05-09T01:54:01.6072541-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:54:01.6072541-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }