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": "3571c103-8608-41bb-a247-343009e7d4a8", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "180f79e4-18fc-4f3c-8acf-1003c752d813", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "12c9d2d3-c246-43d2-a961-ef7edd38f134", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-17T05:02:56.8335822-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "8c2410a0-192a-4613-b9a0-3492015e2761", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "38569314-97fc-4811-be3f-59ea41739e35", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "66489c9f-c163-4cc4-a31f-6767704c3321", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-17T05:02:56.8335822-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "4d6bd261-1004-4f99-a488-485ac888a091", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-17T05:02:56.8335822-07:00", "MeasurementValueNeededDate": "2025-05-17T05:02:56.8335822-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4a7f0a39-546a-4421-af97-ece90b9a2130", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-17T05:02:56.8335822-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-17T05:02:56.8335822-07:00", "MeasurementValueNeededDate": "2025-05-17T05:02:56.8335822-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "17181d07-2a4a-4951-a0f0-2a97000d6756", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-17T05:02:56.8335822-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-05-17T05:02:56.8335822-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "68e69f3f-468f-455a-a9be-a564c3ddd4cd", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-17T05:02:56.8335822-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": "0dd35146-bf44-425f-b91c-2fc5e405db39", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "d9fdbec4-4f40-423b-8471-36ce99407ef4", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "8172a6b7-8059-4ad9-a2d7-b88ca6a5890a", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-17T05:02:56.8335822-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "c05a2535-38fd-4698-948b-4de537b15813", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "af36666f-aa3b-48e4-9af4-06cdf4da4898", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bb528d3a-12f2-4d77-a5cf-e94e1c56701a", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-17T05:02:56.8335822-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "7736ef10-c1d3-46f2-80d8-c85b7871be2f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-17T05:02:56.8335822-07:00", "MeasurementValueNeededDate": "2025-05-17T05:02:56.8335822-07:00", "SourceSystemId": "sample string 3", "CompanyId": "53a60e38-f315-4ecb-bba7-7a86d31296f7", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-17T05:02:56.8335822-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-17T05:02:56.8335822-07:00", "MeasurementValueNeededDate": "2025-05-17T05:02:56.8335822-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "850fb41d-597b-4c3e-b400-df5c1d7726e4", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-17T05:02:56.8335822-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-05-17T05:02:56.8335822-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "a939b792-594b-4286-92d6-dff7380e2a9e", "CreateDate": "2025-05-17T05:02:56.8335822-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-17T05:02:56.8335822-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }