Skip to content

TaskCatalogUpdateOptions

Optional fields for updating a task catalog, plus folder scope. encrypted is omitted because the backend does not allow changing it after creation.

Extends

Properties

Property Type Description
description? string Description of the task catalog (max 512 characters).
expand? string -
folderId? number Numeric folder ID.
folderKey? string Folder key (GUID-formatted string).
folderPath? string Slash-delimited folder path, e.g. 'Shared/Finance'.
name? string New name for the catalog (max 50 characters). Defaults to the catalog's current name.
retentionAction? TaskCatalogRetentionActionInput Action taken on the catalog's tasks when the retention period is reached.
retentionBucketId? number Id of the storage bucket used when retentionAction is Archive.
retentionPeriod? number Retention period, in days.
select? string -
tags? Tag[] Tags to associate with the task catalog.