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": "7348e7cc-a818-43e9-9f92-e276ebbf2091", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "d52dab37-4c0e-486e-aef3-bc06a792a492", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "6098e81f-98b9-474e-8d2e-2c41526c2f98", "CreateDate": "2025-10-13T14:43:37.4760107-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-10-13T14:43:37.4760107-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "aab3809d-5d46-42df-b4fd-0aedab69cbd3", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "61026357-421f-46c0-b045-710c70ec8935", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ca72e1cd-151b-49ce-8d7b-15f2ee6c292b", "CreateDate": "2025-10-13T14:43:37.4760107-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T14:43:37.4760107-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "80bc7f39-8f14-4544-806f-f7690f05f8cb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T14:43:37.4760107-07:00", "MeasurementValueNeededDate": "2025-10-13T14:43:37.4760107-07:00", "SourceSystemId": "sample string 3", "CompanyId": "22cface0-f78e-42ad-bf25-c74689c4e112", "CreateDate": "2025-10-13T14:43:37.4760107-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:43:37.4760107-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-10-13T14:43:37.4760107-07:00", "MeasurementValueNeededDate": "2025-10-13T14:43:37.4760107-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5063db5a-dfb4-43c7-839d-c2f768b2e9b4", "CreateDate": "2025-10-13T14:43:37.4760107-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T14:43:37.4760107-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-10-13T14:43:37.4760107-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "bfac3d6d-ab58-48d8-9470-eded39a99268", "CreateDate": "2025-10-13T14:43:37.4760107-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T14:43:37.4760107-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": "fb78aca6-648a-4ccd-94af-e8c0b62c1a86", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "49b6c8f8-ff4e-425b-8701-86f256ce18ea", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "3026fcc6-4912-44f8-8dde-89af296b9f9b", "CreateDate": "2025-10-13T14:43:37.6322608-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-10-13T14:43:37.6322608-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "59286800-51c6-49e2-9ea1-8e5fc3afa04b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "64313921-7bc2-4fe4-b366-20558a12451b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a7bf6c71-1ef7-4679-af14-728daed7c567", "CreateDate": "2025-10-13T14:43:37.6322608-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T14:43:37.6322608-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "4f98aa6e-a8eb-4c70-99d4-a08b0d4982a9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T14:43:37.6322608-07:00", "MeasurementValueNeededDate": "2025-10-13T14:43:37.6322608-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9edac39d-e8c4-4028-8ce2-7a5b52a1a781", "CreateDate": "2025-10-13T14:43:37.6322608-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:43:37.6322608-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-10-13T14:43:37.6322608-07:00", "MeasurementValueNeededDate": "2025-10-13T14:43:37.6322608-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "4d3df637-2e8d-4432-9b34-5436df3c95d8", "CreateDate": "2025-10-13T14:43:37.6322608-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T14:43:37.6322608-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-10-13T14:43:37.6322608-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "1c67d2f2-9c4f-4c35-9ca6-cc10211223ec", "CreateDate": "2025-10-13T14:43:37.6322608-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T14:43:37.6322608-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }