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": "0a4bff29-a6dc-4d25-b00d-65a7fcbde431", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "dadc8146-ec12-44d0-8800-1eee57660e5c", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "ce89586f-8355-4d1c-ab31-1f7183e3963b", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-23T22:46:13.3943858-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "32fb67b6-623e-4c07-a44a-6aed4011a45d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "3e81f03f-4909-49e4-a866-cd2cd9310887", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fb6fc186-9f1b-4050-be59-ac8a05cd3ecd", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:46:13.3943858-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "2254ef30-b41f-49ba-a58f-824dfadc726b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:46:13.3943858-07:00", "MeasurementValueNeededDate": "2025-08-23T22:46:13.3943858-07:00", "SourceSystemId": "sample string 3", "CompanyId": "445bae97-b22c-4280-b16c-f2d59cc32863", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:46:13.3943858-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-23T22:46:13.3943858-07:00", "MeasurementValueNeededDate": "2025-08-23T22:46:13.3943858-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "816793d7-723c-46a0-96cf-f6ca3e649582", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-23T22:46:13.3943858-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-08-23T22:46:13.3943858-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "1e4a08b4-95cb-4203-be9d-144ccade18e8", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:46:13.3943858-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": "05cdf2bf-6339-4a83-8cea-0eaeae64a3fe", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "2ee62f83-6d67-4adb-8479-44bff5994f34", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "52ada8f5-ab7a-4f2d-8a5d-ba2cc9b4e33c", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-23T22:46:13.3943858-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "a7a15595-5a1c-453d-9a55-46e749990331", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "40df2d7c-8cd4-460d-8098-a30cd62bd464", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "da4db102-a432-4669-a6ea-bdd081f2ccd0", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:46:13.3943858-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "3aca4b4b-7293-4f4d-a346-8ce47c8b4670", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:46:13.3943858-07:00", "MeasurementValueNeededDate": "2025-08-23T22:46:13.3943858-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5d65cd03-daa3-47f3-8217-82a07d9f6f58", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:46:13.3943858-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-23T22:46:13.3943858-07:00", "MeasurementValueNeededDate": "2025-08-23T22:46:13.3943858-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e662ff80-2d9f-4861-aea7-0ebc0872afc8", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-23T22:46:13.3943858-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-08-23T22:46:13.3943858-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "dab4daf1-8dc9-47f2-8121-79f2a91f1364", "CreateDate": "2025-08-23T22:46:13.3943858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:46:13.3943858-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }