update_attachment
Modify the display name and category of an existing file attachment in Pega DX, ensuring proper access permissions are verified during the update process.
Instructions
Updates the name and category of an existing attachment for a given attachmentID. The API only updates the title and category of an existing attachment. It does not update the filename and URL. The system verifies user access to the attachment category before allowing the update.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| attachmentID | Yes | Full ID of the Attachment, Link-Attachment instance pzInsKey (attachment ID) to update. Format example: "LINK-ATTACHMENT OSIEO3-TESTAPP03-WORK T-672011!20240104T100246.978 GMT". This is the complete instance handle key that uniquely identifies the attachment in the Pega system. The attachment must exist and be accessible to the current user. | |
| name | Yes | New name of the attachment. This will be the display name shown for the attachment in the case. a non-empty string. | |
| category | Yes | New attachment category. a valid attachment category that exists in the system and that the user has edit permissions for. The category determines the attachment type and associated permissions. | |
| sessionCredentials | No | Optional session-specific credentials. If not provided, uses environment variables. Supports two authentication modes: (1) OAuth mode - provide baseUrl, clientId, and clientSecret, or (2) Token mode - provide baseUrl and accessToken. |