CLI Reference (`get`)¶

All get commands.

cctl get¶

query resources of camunda engine

Usage:

cctl&nbsp;get [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`-e`, `--engine`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

cctl get activityInstanceTree¶

Get Activity Instance Retrieves an Activity Instance (Tree) for a given process instance by id. URL: /process-instance/{id}/activity-instances Schema: -

Usage:

cctl&nbsp;get activityInstanceTree [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get activityStatistics¶

Get Activity Instance Statistics Retrieves runtime statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. Note: This does not include historic data. URL: /process-definition/{id}/statistics Schema: -

Usage:

cctl&nbsp;get activityStatistics [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--incidents-for-type`	text	If this property has been set with any incident type (i.e., a string value) the result
will only include the number of incidents for the assigned incident type.
Cannot be used in combination with `incidents`.
See the User Guide
for a list of incident types.	None
`--incidents` / `--not-incidents`	boolean	Valid values for this property are `true` or `false`.
If this property has been set to `true` the result will include the corresponding number of incidents
for each occurred incident type.
If it is set to `false`, the incidents will not be included in the result.
Cannot be used in combination with `incidentsForType`.	None
`--failed-jobs` / `--not-failed-jobs`	boolean	Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get activityStatisticsByProcessDefinitionKey¶

Get Activity Instance Statistics Retrieves runtime statistics of the latest version of the given process definition which belongs to no tenant, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. Note: This does not include historic data. URL: /process-definition/key/{key}/statistics Schema: -

Usage:

cctl&nbsp;get activityStatisticsByProcessDefinitionKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--incidents-for-type`	text	If this property has been set with any incident type (i.e., a string value) the result
will only include the number of incidents for the assigned incident type.
Cannot be used in combination with `incidents`.
See the User Guide
for a list of incident types.	None
`--incidents` / `--not-incidents`	boolean	Valid values for this property are `true` or `false`.
If this property has been set to `true` the result will include the corresponding number of incidents
for each occurred incident type.
If it is set to `false`, the incidents will not be included in the result.
Cannot be used in combination with `incidentsForType`.	None
`--failed-jobs` / `--not-failed-jobs`	boolean	Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get activityStatisticsByProcessDefinitionKeyAndTenantId¶

Get Activity Instance Statistics Retrieves runtime statistics of the latest version of the given process definition for a tenant, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. Note: This does not include historic data. URL: /process-definition/key/{key}/tenant-id/{tenant-id}/statistics Schema: -

Usage:

cctl&nbsp;get activityStatisticsByProcessDefinitionKeyAndTenantId 
    [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--incidents-for-type`	text	If this property has been set with any incident type (i.e., a string value) the result
will only include the number of incidents for the assigned incident type.
Cannot be used in combination with `incidents`.
See the User Guide
for a list of incident types.	None
`--incidents` / `--not-incidents`	boolean	Valid values for this property are `true` or `false`.
If this property has been set to `true` the result will include the corresponding number of incidents
for each occurred incident type.
If it is set to `false`, the incidents will not be included in the result.
Cannot be used in combination with `incidentsForType`.	None
`--failed-jobs` / `--not-failed-jobs`	boolean	Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get attachment¶

Get Retrieves a task attachment by task id and attachment id. URL: /task/{id}/attachment/{attachmentId} Schema: -

Usage:

cctl&nbsp;get attachment [OPTIONS] ATTACHMENTID ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get attachmentData¶

Get (Binary) Retrieves the binary content of a task attachment by task id and attachment id. URL: /task/{id}/attachment/{attachmentId}/data Schema: -

Usage:

cctl&nbsp;get attachmentData [OPTIONS] ATTACHMENTID ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get attachments¶

Get List Gets the attachments for a task. URL: /task/{id}/attachment Schema: -

Usage:

cctl&nbsp;get attachments [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get authorization¶

Get Authorization Retrieves an authorization by id. URL: /authorization/{id} Schema: -

Usage:

cctl&nbsp;get authorization [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get authorizationCount¶

Get Authorization Count Queries for authorizations using a list of parameters and retrieves the count. URL: /authorization/count Schema: -

Usage:

cctl&nbsp;get authorizationCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--resource-id`	text	Filter by resource id.	None
`--resource-type`	text	Filter by an integer representation of the resource type. See the
User Guide
for a list of integer representations of resource types.	None
`--group-id-in`	text	Filter by a comma-separated list of groupIds.	None
`--user-id-in`	text	Filter by a comma-separated list of userIds.	None
`--type`	text	Filter by authorization type. (0=global, 1=grant, 2=revoke).
See the User Guide
for more information about authorization types.	None
`--id`	text	Filter by the id of the authorization.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get batch¶

Get Retrieves a batch by id, according to the Batch interface in the engine. URL: /batch/{id} Schema: -

Usage:

cctl&nbsp;get batch [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get batchStatistics¶

Get Statistics Queries for batch statistics that fulfill given parameters. Parameters may be the properties of batches, such as the id or type. The size of the result set can be retrieved by using the Get Batch Statistics Count method. URL: /batch/statistics Schema: -

Usage:

cctl&nbsp;get batchStatistics [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--suspended` / `--not-suspended`	boolean	A `Boolean` value which indicates whether only active or suspended batches should be included.
When the value is set to `true`, only suspended batches will be returned and
when the value is set to `false`, only active batches will be returned.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include batches which belong to no tenant.
Value can effectively only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of `Strings`. A batch matches if it has one of the given tenant ids.	None
`--type`	text	Filter by batch type.
See the User Guide
for more information about batch types.	None
`--batch-id`	text	Filter by batch id.	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get batchStatisticsCount¶

Get Statistics Count Requests the number of batch statistics that fulfill the query criteria. Takes the same filtering parameters as the Get Batch Statistics method. URL: /batch/statistics/count Schema: -

Usage:

cctl&nbsp;get batchStatisticsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--suspended` / `--not-suspended`	boolean	A `Boolean` value which indicates whether only active or suspended batches should be included.
When the value is set to `true`, only suspended batches will be returned and
when the value is set to `false`, only active batches will be returned.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include batches which belong to no tenant.
Value can effectively only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of `Strings`. A batch matches if it has one of the given tenant ids.	None
`--type`	text	Filter by batch type.
See the User Guide
for more information about batch types.	None
`--batch-id`	text	Filter by batch id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get batches¶

Get List Queries for batches that fulfill given parameters. Parameters may be the properties of batches, such as the id or type. The size of the result set can be retrieved by using the Get Batch Count method. URL: /batch Schema: -

Usage:

cctl&nbsp;get batches [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--suspended` / `--not-suspended`	boolean	A `Boolean` value which indicates whether only active or suspended batches should be included.
When the value is set to `true`, only suspended batches will be returned and
when the value is set to `false`, only active batches will be returned.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include batches which belong to no tenant.
Value can effectively only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of `Strings`. A batch matches if it has one of the given tenant ids.	None
`--type`	text	Filter by batch type.
See the User Guide
for more information about batch types.	None
`--batch-id`	text	Filter by batch id.	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get batchesCount¶

Get List Count Requests the number of batches that fulfill the query criteria. Takes the same filtering parameters as the Get Batches method. URL: /batch/count Schema: -

Usage:

cctl&nbsp;get batchesCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--suspended` / `--not-suspended`	boolean	A `Boolean` value which indicates whether only active or suspended batches should be included.
When the value is set to `true`, only suspended batches will be returned and
when the value is set to `false`, only active batches will be returned.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include batches which belong to no tenant.
Value can effectively only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of `Strings`. A batch matches if it has one of the given tenant ids.	None
`--type`	text	Filter by batch type.
See the User Guide
for more information about batch types.	None
`--batch-id`	text	Filter by batch id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get cleanableHistoricBatchesReport¶

Get Cleanable Batch Report Retrieves a report about a historic batch operations relevant to history cleanup (see History cleanup ) so that you can tune the history time to live. These reports include the count of the finished batches, cleanable batches and type of the batch. The size of the result set can be retrieved by using the Get Cleanable Batch Report Count method.

Please note: The history time to live for batch operations does not support Multi-Tenancy. The report will return an information for all batch operations (for all tenants) if you have permissions to see the history.

URL: /history/batch/cleanable-batch-report Schema: -

Usage:

cctl&nbsp;get cleanableHistoricBatchesReport [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get cleanableHistoricBatchesReportCount¶

Get Cleanable Batch Report Count Queries for the number of report results about a historic batch operations relevant to history cleanup (see History cleanup ). Takes the same parameters as the Get Cleanable Batch Report method. URL: /history/batch/cleanable-batch-report/count Schema: -

Usage:

cctl&nbsp;get cleanableHistoricBatchesReportCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get cleanableHistoricDecisionInstanceReport¶

Get Cleanable Decision Instance Report Retrieves a report about a decision definition and finished decision instances relevant to history cleanup (see History cleanup), so that you can tune the history time to live. These reports include the count of the finished historic decision instances, cleanable decision instances and basic decision definition data - id, key, name and version. The size of the result set can be retrieved by using the Get Cleanable Decision Instance Report Count method. URL: /history/decision-definition/cleanable-decision-instance-report Schema: -

Usage:

cctl&nbsp;get cleanableHistoricDecisionInstanceReport [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--compact` / `--not-compact`	boolean	Only include decision instances which have more than zero finished instances. Value may only be `true`,
as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include decision definitions which belong to no tenant. Value may only be `true`, as `false`
is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A decision definition must have one of the given tenant
ids.	None
`--decision-definition-key-in`	text	Filter by decision definition keys. Must be a comma-separated list of decision definition keys.	None
`--decision-definition-id-in`	text	Filter by decision definition ids. Must be a comma-separated list of decision definition ids.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get cleanableHistoricDecisionInstanceReportCount¶

Get Cleanable Decision Instance Report Count Queries for the number of report results about a decision definition and finished decision instances relevant to history cleanup (see History cleanup). Takes the same parameters as the Get Cleanable Decision Instance Report method. URL: /history/decision-definition/cleanable-decision-instance-report/count Schema: -

Usage:

cctl&nbsp;get cleanableHistoricDecisionInstanceReportCount 
    [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--compact` / `--not-compact`	boolean	Only include decision instances which have more than zero finished instances. Value may only be `true`,
as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include decision definitions which belong to no tenant. Value may only be `true`, as `false`
is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A decision definition must have one of the given tenant
ids.	None
`--decision-definition-key-in`	text	Filter by decision definition keys. Must be a comma-separated list of decision definition keys.	None
`--decision-definition-id-in`	text	Filter by decision definition ids. Must be a comma-separated list of decision definition ids.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get cleanableHistoricProcessInstanceReport¶

Get Cleanable Process Instance Report Retrieves a report about a process definition and finished process instances relevant to history cleanup (see History cleanup) so that you can tune the history time to live. These reports include the count of the finished historic process instances, cleanable process instances and basic process definition data - id, key, name and version. The size of the result set can be retrieved by using the Get Cleanable Process Instance Report Count method. URL: /history/process-definition/cleanable-process-instance-report Schema: -

Usage:

cctl&nbsp;get cleanableHistoricProcessInstanceReport [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--compact` / `--not-compact`	boolean	Only include process instances which have more than zero finished instances. Value may
only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include process definitions which belong to no tenant. Value may only be `true`, as
`false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A process definition must have one of the given
tenant ids.	None
`--process-definition-key-in`	text	Filter by process definition keys. Must be a comma-separated list of process definition keys.	None
`--process-definition-id-in`	text	Filter by process definition ids. Must be a comma-separated list of process definition ids.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get cleanableHistoricProcessInstanceReportCount¶

Get Cleanable Process Instance Report Count Queries for the number of report results about a process definition and finished process instances relevant to history cleanup (see History cleanup). Takes the same parameters as the Get Cleanable Process Instance Report method. URL: /history/process-definition/cleanable-process-instance-report/count Schema: -

Usage:

cctl&nbsp;get cleanableHistoricProcessInstanceReportCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--compact` / `--not-compact`	boolean	Only include process instances which have more than zero finished instances. Value may
only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include process definitions which belong to no tenant. Value may only be `true`, as
`false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A process definition must have one of the given
tenant ids.	None
`--process-definition-key-in`	text	Filter by process definition keys. Must be a comma-separated list of process definition keys.	None
`--process-definition-id-in`	text	Filter by process definition ids. Must be a comma-separated list of process definition ids.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get comment¶

Get Retrieves a task comment by task id and comment id. URL: /task/{id}/comment/{commentId} Schema: -

Usage:

cctl&nbsp;get comment [OPTIONS] COMMENTID ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get comments¶

Get List Gets the comments for a task by id. URL: /task/{id}/comment Schema: -

Usage:

cctl&nbsp;get comments [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionById¶

Get Decision Definition By Id Retrieves a decision definition by id, according to the DecisionDefinition interface in the engine. URL: /decision-definition/{id} Schema: -

Usage:

cctl&nbsp;get decisionDefinitionById [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionByKey¶

Get Decision Definition By Key Retrieves the latest version of the decision definition which belongs to no tenant. URL: /decision-definition/key/{key} Schema: -

Usage:

cctl&nbsp;get decisionDefinitionByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionByKeyAndTenantId¶

Get Decision Definition By Key And Tenant Id Retrieves the latest version of the decision definition for tenant URL: /decision-definition/key/{key}/tenant-id/{tenant-id} Schema: -

Usage:

cctl&nbsp;get decisionDefinitionByKeyAndTenantId [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionDiagram¶

Get Diagram Retrieves the diagram of a decision definition. URL: /decision-definition/{id}/diagram Schema: -

Usage:

cctl&nbsp;get decisionDefinitionDiagram [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionDiagramByKey¶

Get Diagram By Key Returns the diagram for the latest version of the decision definition which belongs to no tenant URL: /decision-definition/key/{key}/diagram Schema: -

Usage:

cctl&nbsp;get decisionDefinitionDiagramByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionDiagramByKeyAndTenant¶

Get Diagram By Key And Tenant Returns the XML of the latest version of the decision definition for tenant. URL: /decision-definition/key/{key}/tenant-id/{tenant-id}/diagram Schema: -

Usage:

cctl&nbsp;get decisionDefinitionDiagramByKeyAndTenant [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionDmnXmlById¶

Get XML By Id Retrieves the DMN XML of a decision definition. URL: /decision-definition/{id}/xml Schema: -

Usage:

cctl&nbsp;get decisionDefinitionDmnXmlById [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionDmnXmlByKey¶

Get XML By Key Retrieves the XML for the latest version of the decision definition which belongs to no tenant. URL: /decision-definition/key/{key}/xml Schema: -

Usage:

cctl&nbsp;get decisionDefinitionDmnXmlByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionDmnXmlByKeyAndTenant¶

Get XML By Key and Tenant Retrieves the XML of the latest version of the decision definition for tenant URL: /decision-definition/key/{key}/tenant-id/{tenant-id}/xml Schema: -

Usage:

cctl&nbsp;get decisionDefinitionDmnXmlByKeyAndTenant [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitions¶

Get List Queries for decision definitions that fulfill given parameters. Parameters may be the properties of decision definitions, such as the name, key or version. The size of the result set can be retrieved by using the Get Decision Definition Count method. URL: /decision-definition Schema: -

Usage:

cctl&nbsp;get decisionDefinitions [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--version-tag-like`	text	Filter by the version tags of those decision definition resources that the parameter is a substring of.	None
`--version-tag`	text	Filter by the version tag.	None
`--include-decision-definitions-without-tenant-id` / `--not-include-decision-definitions-without-tenant-id`	boolean	Include decision definitions which belong to no tenant.
Can be used in combination with `tenantIdIn`.
Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include decision definitions which belong to no tenant.
Value can effectively only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of `Strings`. A decision definition must have one of the given tenant ids.	None
`--without-decision-requirements-definition` / `--not-without-decision-requirements-definition`	boolean	Only include decision definitions which does not belongs to any decision requirements definition.
Value may only be `true`, as `false` is the default behavior.	None
`--decision-requirements-definition-key`	text	Filter by the key of the decision requirements definition this decision definition belongs to.	None
`--decision-requirements-definition-id`	text	Filter by the id of the decision requirements definition this decision definition belongs to.	None
`--resource-name-like`	text	Filter by names of those decision definition resources that the parameter is a substring of.	None
`--resource-name`	text	Filter by the name of the decision definition resource. Exact match.	None
`--latest-version` / `--not-latest-version`	boolean	Only include those decision definitions that are latest versions.
Value may only be `true`, as `false` is the default behavior.	None
`--version`	text	Filter by decision definition version.	None
`--category-like`	text	Filter by decision definition categories that the parameter is a substring of.	None
`--category`	text	Filter by decision definition category. Exact match.	None
`--key-like`	text	Filter by decision definition keys that the parameter is a substring of.	None
`--key`	text	Filter by decision definition key, i.e., the id in the DMN 1.0 XML. Exact match.	None
`--deployed-at`	text	Filter by the deploy time of the deployment the decision definition belongs to.
Only selects decision definitions that have been deployed at a specific time (exact match).	None
`--deployed-after`	text	Filter by the deploy time of the deployment the decision definition belongs to.
Only selects decision definitions that have been deployed after (exclusive) a specific time.	None
`--deployment-id`	text	Filter by the deployment the id belongs to.	None
`--name-like`	text	Filter by decision definition names that the parameter is a substring of.	None
`--name`	text	Filter by decision definition name.	None
`--decision-definition-id-in`	text	Filter by decision definition ids.	None
`--decision-definition-id`	text	Filter by decision definition id.	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionDefinitionsCount¶

Get List Count Requests the number of decision definitions that fulfill the query criteria. Takes the same filtering parameters as the Get Decision Definition method. URL: /decision-definition/count Schema: -

Usage:

cctl&nbsp;get decisionDefinitionsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--version-tag-like`	text	Filter by the version tags of those decision definition resources that the parameter is a substring of.	None
`--version-tag`	text	Filter by the version tag.	None
`--include-decision-definitions-without-tenant-id` / `--not-include-decision-definitions-without-tenant-id`	boolean	Include decision definitions which belong to no tenant.
Can be used in combination with `tenantIdIn`.
Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include decision definitions which belong to no tenant.
Value can effectively only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of `Strings`. A decision definition must have one of the given tenant ids.	None
`--without-decision-requirements-definition` / `--not-without-decision-requirements-definition`	boolean	Only include decision definitions which does not belongs to any decision requirements definition.
Value may only be `true`, as `false` is the default behavior.	None
`--decision-requirements-definition-key`	text	Filter by the key of the decision requirements definition this decision definition belongs to.	None
`--decision-requirements-definition-id`	text	Filter by the id of the decision requirements definition this decision definition belongs to.	None
`--resource-name-like`	text	Filter by names of those decision definition resources that the parameter is a substring of.	None
`--resource-name`	text	Filter by the name of the decision definition resource. Exact match.	None
`--latest-version` / `--not-latest-version`	boolean	Only include those decision definitions that are latest versions.
Value may only be `true`, as `false` is the default behavior.	None
`--version`	text	Filter by decision definition version.	None
`--category-like`	text	Filter by decision definition categories that the parameter is a substring of.	None
`--category`	text	Filter by decision definition category. Exact match.	None
`--key-like`	text	Filter by decision definition keys that the parameter is a substring of.	None
`--key`	text	Filter by decision definition key, i.e., the id in the DMN 1.0 XML. Exact match.	None
`--deployed-at`	text	Filter by the deploy time of the deployment the decision definition belongs to.
Only selects decision definitions that have been deployed at a specific time (exact match).	None
`--deployed-after`	text	Filter by the deploy time of the deployment the decision definition belongs to.
Only selects decision definitions that have been deployed after (exclusive) a specific time.	None
`--deployment-id`	text	Filter by the deployment the id belongs to.	None
`--name-like`	text	Filter by decision definition names that the parameter is a substring of.	None
`--name`	text	Filter by decision definition name.	None
`--decision-definition-id-in`	text	Filter by decision definition ids.	None
`--decision-definition-id`	text	Filter by decision definition id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionById¶

Get Decision Requirements Definition by ID Retrieves a decision requirements definition according to the DecisionRequirementsDefinition interface in the engine. URL: /decision-requirements-definition/{id} Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionById [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionByKey¶

Get Decision Requirements Definition by Key Retrieves a decision requirements definition according to the DecisionRequirementsDefinition interface in the engine. Returns the latest version of the decision requirements definition which belongs to no tenant. URL: /decision-requirements-definition/key/{key} Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionByKeyAndTenantId¶

Get Decision Requirements Definition by Key and Tenant ID Retrieves a decision requirements definition according to the DecisionRequirementsDefinition interface in the engine. Returns the latest version of the decision requirements definition for a tenant. URL: /decision-requirements-definition/key/{key}/tenant-id/{tenant-id} Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionByKeyAndTenantId 
    [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionDiagramById¶

Get Decision Requirements Diagram by ID Retrieves the diagram of a decision requirements definition. URL: /decision-requirements-definition/{id}/diagram Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionDiagramById [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionDiagramByKey¶

Get Decision Requirements Diagram by Key Retrieves the diagram of a decision requirements definition. Returns the diagram for the latest version of the decision requirements definition which belongs to no tenant. URL: /decision-requirements-definition/key/{key}/diagram Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionDiagramByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionDiagramByKeyAndTenantId¶

Get Decision Requirements Diagram by Key and Tenant ID Retrieves the diagram of a decision requirements definition. Returns the diagram of the latest version of the decision requirements definition for a tenant. URL: /decision-requirements-definition/key/{key}/tenant-id/{tenant-id}/diagram Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionDiagramByKeyAndTenantId 
    [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionDmnXmlById¶

Get DMN XML by ID Retrieves the DMN XML of a decision requirements definition. URL: /decision-requirements-definition/{id}/xml Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionDmnXmlById [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionDmnXmlByKey¶

Get DMN XML by Key Retrieves the DMN XML of a decision requirements definition. Returns the XML for the latest version of the decision requirements definition which belongs to no tenant. URL: /decision-requirements-definition/key/{key}/xml Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionDmnXmlByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionDmnXmlByKeyAndTenantId¶

Get DMN XML by Key and Tenant ID Retrieves the DMN XML of a decision requirements definition. Returns the XML of the latest version of the decision requirements definition for a tenant. URL: /decision-requirements-definition/key/{key}/tenant-id/{tenant-id}/xml Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionDmnXmlByKeyAndTenantId 
    [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitions¶

Get Decision Requirements Definitions Queries for decision requirements definitions that fulfill given parameters. Parameters may be the properties of decision requirements definitions, such as the name, key or version. The size of the result set can be retrieved by using the Get Decision Requirements Definition Count method. URL: /decision-requirements-definition Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitions [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--include-decision-requirements-definitions-without-tenant-id` / `--not-include-decision-requirements-definitions-without-tenant-id`	boolean	Include decision requirements definitions which belong to no tenant. Can be used in
combination with `tenantIdIn`. Value may only be `true`, as `false` is the
default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include decision requirements definitions which belong to no tenant. Value may only
be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A decision requirements definition must
have one of the given tenant ids.	None
`--resource-name-like`	text	Filter by names of those decision requirements definition resources that the parameter is
a substring of.	None
`--resource-name`	text	Filter by the name of the decision requirements definition resource. Exact match.	None
`--latest-version` / `--not-latest-version`	boolean	Only include those decision requirements definitions that are latest versions. Value may
only be `true`, as `false` is the default behavior.	None
`--version`	text	Filter by decision requirements definition version.	None
`--category-like`	text	Filter by decision requirements definition categories that the parameter is a substring
of.	None
`--category`	text	Filter by decision requirements definition category. Exact match.	None
`--key-like`	text	Filter by decision requirements definition keys that the parameter is a substring of.	None
`--key`	text	Filter by decision requirements definition key, i.e., the id in the DMN 1.3 XML. Exact
match.	None
`--deployment-id`	text	Filter by the id of the deployment a decision requirement definition belongs to.	None
`--name-like`	text	Filter by decision requirements definition names that the parameter is a substring of.	None
`--name`	text	Filter by decision requirements definition name.	None
`--decision-requirements-definition-id-in`	text	Filter by decision requirements definition ids.	None
`--decision-requirements-definition-id`	text	Filter by decision requirements definition id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionRequirementsDefinitionsCount¶

Get Decision Requirements Definition Count Requests the number of decision requirements definitions that fulfill the query criteria. Takes the same filtering parameters as the Get Decision Requirements Definitions method. URL: /decision-requirements-definition/count Schema: -

Usage:

cctl&nbsp;get decisionRequirementsDefinitionsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--include-decision-requirements-definitions-without-tenant-id` / `--not-include-decision-requirements-definitions-without-tenant-id`	boolean	Include decision requirements definitions which belong to no tenant. Can be used in
combination with `tenantIdIn`. Value may only be `true`, as `false` is the
default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include decision requirements definitions which belong to no tenant. Value may only
be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A decision requirements definition must
have one of the given tenant ids.	None
`--resource-name-like`	text	Filter by names of those decision requirements definition resources that the parameter is
a substring of.	None
`--resource-name`	text	Filter by the name of the decision requirements definition resource. Exact match.	None
`--latest-version` / `--not-latest-version`	boolean	Only include those decision requirements definitions that are latest versions. Value may
only be `true`, as `false` is the default behavior.	None
`--version`	text	Filter by decision requirements definition version.	None
`--category-like`	text	Filter by decision requirements definition categories that the parameter is a substring
of.	None
`--category`	text	Filter by decision requirements definition category. Exact match.	None
`--key-like`	text	Filter by decision requirements definition keys that the parameter is a substring of.	None
`--key`	text	Filter by decision requirements definition key, i.e., the id in the DMN 1.3 XML. Exact
match.	None
`--deployment-id`	text	Filter by the id of the deployment a decision requirement definition belongs to.	None
`--name-like`	text	Filter by decision requirements definition names that the parameter is a substring of.	None
`--name`	text	Filter by decision requirements definition name.	None
`--decision-requirements-definition-id-in`	text	Filter by decision requirements definition ids.	None
`--decision-requirements-definition-id`	text	Filter by decision requirements definition id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get decisionStatistics¶

Get DRD Statistics Retrieves evaluation statistics of a given decision requirements definition. URL: /history/decision-requirements-definition/{id}/statistics Schema: -

Usage:

cctl&nbsp;get decisionStatistics [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--decision-instance-id`	text	Restrict query results to be based only on specific evaluation
instance of a given decision requirements definition.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deployedForm¶

Get Deployed Form Retrieves the deployed form that is referenced from a given task. For further information please refer to the User Guide. URL: /task/{id}/deployed-form Schema: -

Usage:

cctl&nbsp;get deployedForm [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deployedStartForm¶

Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to User Guide. URL: /process-definition/{id}/deployed-start-form Schema: -

Usage:

cctl&nbsp;get deployedStartForm [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deployedStartFormByKey¶

Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to User Guide. URL: /process-definition/key/{key}/deployed-start-form Schema: -

Usage:

cctl&nbsp;get deployedStartFormByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deployedStartFormByKeyAndTenantId¶

Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to User Guide. URL: /process-definition/key/{key}/tenant-id/{tenant-id}/deployed-start-form Schema: -

Usage:

cctl&nbsp;get deployedStartFormByKeyAndTenantId [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deployment¶

Get Retrieves a deployment by id, according to the Deployment interface of the engine. URL: /deployment/{id} Schema: -

Usage:

cctl&nbsp;get deployment [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deploymentResource¶

Get Resource Retrieves a deployment resource by resource id for the given deployment. URL: /deployment/{id}/resources/{resourceId} Schema: -

Usage:

cctl&nbsp;get deploymentResource [OPTIONS] RESOURCEID ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deploymentResourceData¶

Get Resource (Binary) Retrieves the binary content of a deployment resource for the given deployment by id. URL: /deployment/{id}/resources/{resourceId}/data Schema: -

Usage:

cctl&nbsp;get deploymentResourceData [OPTIONS] RESOURCEID ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deploymentResources¶

Get Resources Retrieves all deployment resources of a given deployment. URL: /deployment/{id}/resources Schema: -

Usage:

cctl&nbsp;get deploymentResources [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deployments¶

Get List Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the Get Deployment count method. URL: /deployment Schema: -

Usage:

cctl&nbsp;get deployments [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--before`	text	Restricts to all deployments before the given date.
By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--after`	text	Restricts to all deployments after the given date.
By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--include-deployments-without-tenant-id` / `--not-include-deployments-without-tenant-id`	boolean	Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may
only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default
behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids.	None
`--without-source` / `--not-without-source`	boolean	Filter by the deployment source whereby source is equal to `null`.	None
`--source`	text	Filter by the deployment source.	None
`--name-like`	text	Filter by the deployment name that the parameter is a substring of. The parameter can include the
wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains
(`%`name`%`).	None
`--name`	text	Filter by the deployment name. Exact match.	None
`--id`	text	Filter by deployment id	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get deploymentsCount¶

Get List Count Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the Get Deployments method. URL: /deployment/count Schema: -

Usage:

cctl&nbsp;get deploymentsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--before`	text	Restricts to all deployments before the given date.
By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--after`	text	Restricts to all deployments after the given date.
By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--include-deployments-without-tenant-id` / `--not-include-deployments-without-tenant-id`	boolean	Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may
only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default
behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids.	None
`--without-source` / `--not-without-source`	boolean	Filter by the deployment source whereby source is equal to `null`.	None
`--source`	text	Filter by the deployment source.	None
`--name-like`	text	Filter by the deployment name that the parameter is a substring of. The parameter can include the
wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains
(`%`name`%`).	None
`--name`	text	Filter by the deployment name. Exact match.	None
`--id`	text	Filter by deployment id	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get errorDetailsHistoricExternalTaskLog¶

Get External Task Log Error Details Retrieves the corresponding error details of the passed historic external task log by id. URL: /history/external-task-log/{id}/error-details Schema: -

Usage:

cctl&nbsp;get errorDetailsHistoricExternalTaskLog [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get eventSubscriptions¶

Get List Queries for event subscriptions that fulfill given parameters. The size of the result set can be retrieved by using the Get Event Subscriptions count method. URL: /event-subscription Schema: -

Usage:

cctl&nbsp;get eventSubscriptions [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--include-event-subscriptions-without-tenant-id` / `--not-include-event-subscriptions-without-tenant-id`	boolean	Select event subscriptions which have no tenant id.
Can be used in combination with tenantIdIn parameter.
Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only select subscriptions which have no tenant id.
Value may only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids.
Only select subscriptions that belong to one of the given tenant ids.	None
`--activity-id`	text	Only select subscriptions that belong to an activity with the given id.	None
`--process-instance-id`	text	Only select subscriptions that belong to a process instance with the given id.	None
`--execution-id`	text	Only select subscriptions that belong to an execution with the given id.	None
`--event-type`	text	Only select subscriptions for events with the given type.
Valid values: `message`, `signal`, `compensate` and `conditional`.	None
`--event-name`	text	Only select subscriptions for events with the given name.	None
`--event-subscription-id`	text	Only select subscription with the given id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get eventSubscriptionsCount¶

Get List Count Queries for the number of event subscriptions that fulfill given parameters. Takes the same parameters as the Get Event Subscriptions method. URL: /event-subscription/count Schema: -

Usage:

cctl&nbsp;get eventSubscriptionsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--include-event-subscriptions-without-tenant-id` / `--not-include-event-subscriptions-without-tenant-id`	boolean	Select event subscriptions which have no tenant id.
Can be used in combination with tenantIdIn parameter.
Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only select subscriptions which have no tenant id.
Value may only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids.
Only select subscriptions that belong to one of the given tenant ids.	None
`--activity-id`	text	Only select subscriptions that belong to an activity with the given id.	None
`--process-instance-id`	text	Only select subscriptions that belong to a process instance with the given id.	None
`--execution-id`	text	Only select subscriptions that belong to an execution with the given id.	None
`--event-type`	text	Only select subscriptions for events with the given type.
Valid values: `message`, `signal`, `compensate` and `conditional`.	None
`--event-name`	text	Only select subscriptions for events with the given name.	None
`--event-subscription-id`	text	Only select subscription with the given id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get executeFilterCount¶

Execute Filter Count Executes the saved query of the filter by id and returns the count. URL: /filter/{id}/count Schema: -

Usage:

cctl&nbsp;get executeFilterCount [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get executeFilterList¶

Execute Filter List Executes the saved query of the filter by id and returns the result list. URL: /filter/{id}/list Schema: -

Usage:

cctl&nbsp;get executeFilterList [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get executeFilterSingleResult¶

Execute Filter Single Result Executes the saved query of the filter by id and returns the single result. URL: /filter/{id}/singleResult Schema: -

Usage:

cctl&nbsp;get executeFilterSingleResult [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get execution¶

Get Execution Retrieves an execution by id, according to the Execution interface in the engine. URL: /execution/{id} Schema: -

Usage:

cctl&nbsp;get execution [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get executions¶

Get Executions Queries for the executions that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of executions. The size of the result set can be retrieved by using the Get Execution Count method. URL: /execution Schema: -

Usage:

cctl&nbsp;get executions [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match all variable values provided in `variables` and `processVariables` case-
insensitively. If set to `true` variableValue and variablevalue are
treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match all variable names provided in `variables` and `processVariables` case-
insensitively. If set to `true` variableName and variablename are
treated as equal.	None
`--process-variables`	text	Only include executions that belong to a process instance with variables with certain
values.
Variable filtering expressions are comma-separated and are structured as
follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to. key and value may not contain underscore or comma characters. | None | | --variables | text | Only include executions that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

cctl get executionsCount¶

Get Execution Count Queries for the number of executions that fulfill given parameters. Takes the same parameters as the Get Executions method. URL: /execution/count Schema: -

Usage:

cctl&nbsp;get executionsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match all variable values provided in `variables` and `processVariables` case-
insensitively. If set to `true` variableValue and variablevalue are
treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match all variable names provided in `variables` and `processVariables` case-
insensitively. If set to `true` variableName and variablename are
treated as equal.	None
`--process-variables`	text	Only include executions that belong to a process instance with variables with certain
values.
Variable filtering expressions are comma-separated and are structured as
follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to. key and value may not contain underscore or comma characters. | None | | --variables | text | Only include executions that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

cctl get externalTask¶

Get Retrieves an external task by id, corresponding to the ExternalTask interface in the engine. URL: /external-task/{id} Schema: -

Usage:

cctl&nbsp;get externalTask [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get externalTaskErrorDetails¶

Get Error Details Retrieves the error details in the context of a running external task by id. URL: /external-task/{id}/errorDetails Schema: -

Usage:

cctl&nbsp;get externalTaskErrorDetails [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get externalTasks¶

Get List Queries for the external tasks that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of executions. The size of the result set can be retrieved by using the Get External Task Count method. URL: /external-task Schema: -

Usage:

cctl&nbsp;get externalTasks [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--priority-lower-than-or-equals`	text	Only include jobs with a priority lower than or equal to the given value.
Value must be a valid `long` value.	None
`--priority-higher-than-or-equals`	text	Only include jobs with a priority higher than or equal to the given value.
Value must be a valid `long` value.	None
`--suspended` / `--not-suspended`	boolean	Only include suspended tasks. Value may only be `true`, as `false` matches any external task.	None
`--active` / `--not-active`	boolean	Only include active tasks. Value may only be `true`, as `false` matches any external task.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids.
An external task must have one of the given tenant ids.	None
`--process-definition-id`	text	Filter by the id of the process definition that an external task belongs to.	None
`--process-instance-id-in`	text	Filter by a comma-separated list of process instance ids that an external task may belong to.	None
`--process-instance-id`	text	Filter by the id of the process instance that an external task belongs to.	None
`--execution-id`	text	Filter by the id of the execution that an external task belongs to.	None
`--activity-id-in`	text	Filter by the comma-separated list of ids of the activities that an external task is created for.	None
`--activity-id`	text	Filter by the id of the activity that an external task is created for.	None
`--lock-expiration-before`	text	Restrict to external tasks that have a lock that expires before a given date. By
default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--lock-expiration-after`	text	Restrict to external tasks that have a lock that expires after a given date. By
default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--no-retries-left` / `--not-no-retries-left`	boolean	Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any
external task.	None
`--with-retries-left` / `--not-with-retries-left`	boolean	Only include external tasks that have a positive (> 0) number of retries (or `null`). Value may only be
`true`, as `false` matches any external task.	None
`--not-locked` / `--not-not-locked`	boolean	Only include external tasks that are currently not locked (i.e., they have no lock or it has expired).
Value may only be `true`, as `false` matches any external task.	None
`--locked` / `--not-locked`	boolean	Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired).
Value may only be `true`, as `false` matches any external task.	None
`--worker-id`	text	Filter by the id of the worker that the task was most recently locked by.	None
`--topic-name`	text	Filter by an external task topic.	None
`--external-task-id-in`	text	Filter by the comma-separated list of external task ids.	None
`--external-task-id`	text	Filter by an external task's id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get externalTasksCount¶

Get List Count Queries for the number of external tasks that fulfill given parameters. Takes the same parameters as the Get External Tasks method. URL: /external-task/count Schema: -

Usage:

cctl&nbsp;get externalTasksCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--priority-lower-than-or-equals`	text	Only include jobs with a priority lower than or equal to the given value.
Value must be a valid `long` value.	None
`--priority-higher-than-or-equals`	text	Only include jobs with a priority higher than or equal to the given value.
Value must be a valid `long` value.	None
`--suspended` / `--not-suspended`	boolean	Only include suspended tasks. Value may only be `true`, as `false` matches any external task.	None
`--active` / `--not-active`	boolean	Only include active tasks. Value may only be `true`, as `false` matches any external task.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids.
An external task must have one of the given tenant ids.	None
`--process-definition-id`	text	Filter by the id of the process definition that an external task belongs to.	None
`--process-instance-id-in`	text	Filter by a comma-separated list of process instance ids that an external task may belong to.	None
`--process-instance-id`	text	Filter by the id of the process instance that an external task belongs to.	None
`--execution-id`	text	Filter by the id of the execution that an external task belongs to.	None
`--activity-id-in`	text	Filter by the comma-separated list of ids of the activities that an external task is created for.	None
`--activity-id`	text	Filter by the id of the activity that an external task is created for.	None
`--lock-expiration-before`	text	Restrict to external tasks that have a lock that expires before a given date. By
default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--lock-expiration-after`	text	Restrict to external tasks that have a lock that expires after a given date. By
default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--no-retries-left` / `--not-no-retries-left`	boolean	Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any
external task.	None
`--with-retries-left` / `--not-with-retries-left`	boolean	Only include external tasks that have a positive (> 0) number of retries (or `null`). Value may only be
`true`, as `false` matches any external task.	None
`--not-locked` / `--not-not-locked`	boolean	Only include external tasks that are currently not locked (i.e., they have no lock or it has expired).
Value may only be `true`, as `false` matches any external task.	None
`--locked` / `--not-locked`	boolean	Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired).
Value may only be `true`, as `false` matches any external task.	None
`--worker-id`	text	Filter by the id of the worker that the task was most recently locked by.	None
`--topic-name`	text	Filter by an external task topic.	None
`--external-task-id-in`	text	Filter by the comma-separated list of external task ids.	None
`--external-task-id`	text	Filter by an external task's id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get filterCount¶

Get Filter Count Retrieves the number of filters that fulfill a provided query. Corresponds to the size of the result set when using the Get Filters method. URL: /filter/count Schema: -

Usage:

cctl&nbsp;get filterCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--owner`	text	Filter by the user id of the owner of the filter.	None
`--name-like`	text	Filter by the name that the parameter is a substring of.	None
`--name`	text	Filter by the name of the filter.	None
`--resource-type`	text	Filter by the resource type of the filter, e.g., `Task`.	None
`--filter-id`	text	Filter by the id of the filter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

Get Filters Queries for a list of filters using a list of parameters. The size of the result set can be retrieved by using the Get Filter Count method. URL: /filter Schema: -

Usage:

cctl&nbsp;get filterList [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--item-count` / `--not-item-count`	boolean	If set to `true`, each filter result will contain an `itemCount` property
with the number of items matched by the filter itself.	None
`--owner`	text	Filter by the user id of the owner of the filter.	None
`--name-like`	text	Filter by the name that the parameter is a substring of.	None
`--name`	text	Filter by the name of the filter.	None
`--resource-type`	text	Filter by the resource type of the filter, e.g., `Task`.	None
`--filter-id`	text	Filter by the id of the filter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get findCleanupJob¶

Find clean up history job (GET) Deprecated! Use GET /history/cleanup/jobs instead.

Finds history cleanup job (See History cleanup). URL: /history/cleanup/job Schema: -

Usage:

cctl&nbsp;get findCleanupJob [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get findCleanupJobs¶

Find clean up history jobs (GET) Finds history cleanup jobs (See History cleanup). URL: /history/cleanup/jobs Schema: -

Usage:

cctl&nbsp;get findCleanupJobs [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get form¶

Get Form Key Retrieves the form key for a task. The form key corresponds to the FormData#formKey property in the engine. This key can be used to do task-specific form rendering in client applications. Additionally, the context path of the containing process application is returned. URL: /task/{id}/form Schema: -

Usage:

cctl&nbsp;get form [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get formVariables¶

Get Task Form Variables Retrieves the form variables for a task. The form variables take form data specified on the task into account. If form fields are defined, the variable types and default values of the form fields are taken into account. URL: /task/{id}/form-variables Schema: -

Usage:

cctl&nbsp;get formVariables [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that store
custom Java objects) should be deserialized on server side (default true).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get group¶

Get Group Retrieves a group by id. URL: /group/{id} Schema: -

Usage:

cctl&nbsp;get group [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get groupCount¶

Get List Count Queries for groups using a list of parameters and retrieves the count. URL: /group/count Schema: -

Usage:

cctl&nbsp;get groupCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--member-of-tenant`	text	Only retrieve groups which are members of the given tenant.	None
`--member`	text	Only retrieve groups where the given user id is a member of.	None
`--type`	text	Filter by the type of the group.	None
`--name-like`	text	Filter by the name that the parameter is a substring of.	None
`--name`	text	Filter by the name of the group.	None
`--id-in`	text	Filter by a comma seperated list of group ids.	None
`--id`	text	Filter by the id of the group.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get groupInfo¶

Get a User's Groups Gets the groups of a user by id and includes all users that share a group with the given user. URL: /identity/groups Schema: -

Usage:

cctl&nbsp;get groupInfo [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--user-id`	text	The id of the user to get the groups for.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicActivityInstance¶

Get Retrieves a historic activity instance by id, according to the HistoricActivityInstance interface in the engine. URL: /history/activity-instance/{id} Schema: -

Usage:

cctl&nbsp;get historicActivityInstance [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicActivityInstances¶

Get List Queries for historic activity instances that fulfill the given parameters. The size of the result set can be retrieved by using the Get Historic Activity Instance Count method. URL: /history/activity-instance Schema: -

Usage:

cctl&nbsp;get historicActivityInstances [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic activity instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of ids. An activity instance must have one of the given tenant ids.	None
`--finished-after`	text	Restrict to instances that were finished after the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--finished-before`	text	Restrict to instances that were finished before the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--started-after`	text	Restrict to instances that were started after the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--started-before`	text	Restrict to instances that were started before the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--complete-scope` / `--not-complete-scope`	boolean	Only include activity instances which completed a scope.
Value may only be `true`, as `false` behaves the same as when the property is not set.	None
`--canceled` / `--not-canceled`	boolean	Only include canceled activity instances.
Value may only be `true`, as `false` behaves the same as when the property is not set.	None
`--unfinished` / `--not-unfinished`	boolean	Only include unfinished activity instances.
Value may only be `true`, as `false` behaves the same as when the property is not set.	None
`--finished` / `--not-finished`	boolean	Only include finished activity instances.
Value may only be `true`, as `false` behaves the same as when the property is not set.	None
`--task-assignee`	text	Only include activity instances that are user tasks and assigned to a given user.	None
`--activity-type`	text	Filter by activity type.	None
`--activity-name`	text	Filter by the activity name (according to BPMN 2.0 XML).	None
`--activity-id`	text	Filter by the activity id (according to BPMN 2.0 XML).	None
`--execution-id`	text	Filter by the id of the execution that executed the activity instance.	None
`--process-definition-id`	text	Filter by process definition id.	None
`--process-instance-id`	text	Filter by process instance id.	None
`--activity-instance-id`	text	Filter by activity instance id.	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicActivityInstancesCount¶

Get List Count Queries for the number of historic activity instances that fulfill the given parameters. Takes the same parameters as the Get Historic Activity Instance method. URL: /history/activity-instance/count Schema: -

Usage:

cctl&nbsp;get historicActivityInstancesCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic activity instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of ids. An activity instance must have one of the given tenant ids.	None
`--finished-after`	text	Restrict to instances that were finished after the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--finished-before`	text	Restrict to instances that were finished before the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--started-after`	text	Restrict to instances that were started after the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--started-before`	text	Restrict to instances that were started before the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--complete-scope` / `--not-complete-scope`	boolean	Only include activity instances which completed a scope.
Value may only be `true`, as `false` behaves the same as when the property is not set.	None
`--canceled` / `--not-canceled`	boolean	Only include canceled activity instances.
Value may only be `true`, as `false` behaves the same as when the property is not set.	None
`--unfinished` / `--not-unfinished`	boolean	Only include unfinished activity instances.
Value may only be `true`, as `false` behaves the same as when the property is not set.	None
`--finished` / `--not-finished`	boolean	Only include finished activity instances.
Value may only be `true`, as `false` behaves the same as when the property is not set.	None
`--task-assignee`	text	Only include activity instances that are user tasks and assigned to a given user.	None
`--activity-type`	text	Filter by activity type.	None
`--activity-name`	text	Filter by the activity name (according to BPMN 2.0 XML).	None
`--activity-id`	text	Filter by the activity id (according to BPMN 2.0 XML).	None
`--execution-id`	text	Filter by the id of the execution that executed the activity instance.	None
`--process-definition-id`	text	Filter by process definition id.	None
`--process-instance-id`	text	Filter by process instance id.	None
`--activity-instance-id`	text	Filter by activity instance id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicActivityStatistics¶

Get Historic Activity Statistics Retrieves historic statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances and, optionally, the number of canceled activity instances, finished activity instances and activity instances which completed a scope (i.e., in BPMN 2.0 manner: a scope is completed by an activity instance when the activity instance consumed a token but did not emit a new token). Note: This only includes historic data. URL: /history/process-definition/{id}/statistics Schema: -

Usage:

cctl&nbsp;get historicActivityStatistics [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--process-instance-id-in`	text	Restrict to process instances with the given IDs. The IDs must be provided as a comma-
separated list.	None
`--finished-after`	text	Restrict to process instances that were finished after the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., `2013-01-23T14:42:45.000+0200`.	None
`--finished-before`	text	Restrict to process instances that were finished before the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., `2013-01-23T14:42:45.000+0200`.	None
`--started-after`	text	Restrict to process instances that were started after the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., `2013-01-23T14:42:45.000+0200`.	None
`--started-before`	text	Restrict to process instances that were started before the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., `2013-01-23T14:42:45.000+0200`.	None
`--incidents` / `--not-incidents`	boolean	Whether to include the number of incidents. Valid values are `true` or `false`. Default: `false`.	None
`--complete-scope` / `--not-complete-scope`	boolean	Whether to include the number of activity instances which completed a scope in the result
or not. Valid values are `true` or `false`. Default: `false`.	None
`--finished` / `--not-finished`	boolean	Whether to include the number of finished activity instances in the result or not. Valid
values are `true` or `false`. Default: `false`.	None
`--canceled` / `--not-canceled`	boolean	Whether to include the number of canceled activity instances in the result or not. Valid
values are `true` or `false`. Default: `false`.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicBatch¶

Get Historic Batch Retrieves a historic batch by id, according to the HistoricBatch interface in the engine. URL: /history/batch/{id} Schema: -

Usage:

cctl&nbsp;get historicBatch [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicBatches¶

Get Historic Batches Queries for historic batches that fulfill given parameters. Parameters may be the properties of batches, such as the id or type. The size of the result set can be retrieved by using the Get Historic Batch Count method. URL: /history/batch Schema: -

Usage:

cctl&nbsp;get historicBatches [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include batches which belong to no tenant. Value can effectively only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A batch matches if it has one of the given
tenant ids.	None
`--completed` / `--not-completed`	boolean	Filter completed or not completed batches. If the value is
`true`, only completed batches, i.e., end time is set, are
returned. Otherwise, if the value is `false`, only running
batches, i.e., end time is null, are returned.	None
`--type`	text	Filter by batch type. See the
User Guide
for more information about batch types.	None
`--batch-id`	text	Filter by batch id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicBatchesCount¶

Get Historic Batch Count Requests the number of historic batches that fulfill the query criteria. Takes the same filtering parameters as the Get Historic Batches method. URL: /history/batch/count Schema: -

Usage:

cctl&nbsp;get historicBatchesCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include batches which belong to no tenant. Value can effectively only be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A batch matches if it has one of the given
tenant ids.	None
`--completed` / `--not-completed`	boolean	Filter completed or not completed batches. If the value is
`true`, only completed batches, i.e., end time is set, are
returned. Otherwise, if the value is `false`, only running
batches, i.e., end time is null, are returned.	None
`--type`	text	Filter by batch type. See the
User Guide
for more information about batch types.	None
`--batch-id`	text	Filter by batch id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicDecisionInstance¶

Get Historic Decision Instance Retrieves a historic decision instance by id, according to the HistoricDecisionInstance interface in the engine. URL: /history/decision-instance/{id} Schema: -

Usage:

cctl&nbsp;get historicDecisionInstance [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--disable-custom-object-deserialization` / `--not-disable-custom-object-deserialization`	boolean	Disables deserialization of input and output values that are custom objects.
Value may only be `true`, as `false` is the default behavior.	None
`--disable-binary-fetching` / `--not-disable-binary-fetching`	boolean	Disables fetching of byte array input and output values.
Value may only be `true`, as `false` is the default behavior.	None
`--include-outputs` / `--not-include-outputs`	boolean	Include output values in the result.
Value may only be `true`, as `false` is the default behavior.	None
`--include-inputs` / `--not-include-inputs`	boolean	Include input values in the result.
Value may only be `true`, as `false` is the default behavior.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicDecisionInstances¶

Get Historic Decision Instances Queries for historic decision instances that fulfill the given parameters. The size of the result set can be retrieved by using the Get Historic Decision Instance Count method. URL: /history/decision-instance Schema: -

Usage:

cctl&nbsp;get historicDecisionInstances [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--disable-custom-object-deserialization` / `--not-disable-custom-object-deserialization`	boolean	Disables deserialization of input and output values that are custom objects.
Value may only be `true`, as `false` is the default behavior.	None
`--disable-binary-fetching` / `--not-disable-binary-fetching`	boolean	Disables fetching of byte array input and output values.
Value may only be `true`, as `false` is the default behavior.	None
`--include-outputs` / `--not-include-outputs`	boolean	Include output values in the result.
Value may only be `true`, as `false` is the default behavior.	None
`--include-inputs` / `--not-include-inputs`	boolean	Include input values in the result.
Value may only be `true`, as `false` is the default behavior.	None
`--decision-requirements-definition-key`	text	Filter by the key of the decision requirements definition the instances belongs to.	None
`--decision-requirements-definition-id`	text	Filter by the decision requirements definition the instances belongs to.	None
`--root-decision-instances-only` / `--not-root-decision-instances-only`	boolean	Restrict to instances those are the root decision instance of an evaluation.
Value may only be `true`, as `false` is the default behavior.	None
`--root-decision-instance-id`	text	Restrict to instances that have a given root decision instance id.
This also includes the decision instance with the given id.	None
`--user-id`	text	Restrict to instances that were evaluated by the given user.	None
`--evaluated-after`	text	Restrict to instances that were evaluated after the given date.
By default, the date must have the format `yyyy-MM-
dd'T'HH:mm:ss.SSSZ`, e.g.,`2013-01-23T14:42:45.000+0200`.	None
`--evaluated-before`	text	Restrict to instances that were evaluated before the given date.
By default, the date must have the format `yyyy-MM-
dd'T'HH:mm:ss.SSSZ`, e.g.,`2013-01-23T14:42:45.000+0200`.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic decision instances that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A historic decision instance must have one
of the given tenant ids.	None
`--activity-instance-id-in`	text	Filter by the activity instance ids the instances belongs to.
Must be a comma-separated list of acitvity instance ids.	None
`--activity-id-in`	text	Filter by the activity ids the instances belongs to.
Must be a comma-separated list of acitvity ids.	None
`--case-instance-id`	text	Filter by the case instance the instances belongs to.	None
`--case-definition-key`	text	Filter by the key of the case definition the instances belongs to.	None
`--case-definition-id`	text	Filter by the case definition the instances belongs to.	None
`--process-instance-id`	text	Filter by the process instance the instances belongs to.	None
`--process-definition-key`	text	Filter by the key of the process definition the instances belongs to.	None
`--process-definition-id`	text	Filter by the process definition the instances belongs to.	None
`--decision-definition-name-like`	text	Filter by the name of the decision definition the instances belongs to, that the parameter
is a substring of.	None
`--decision-definition-name`	text	Filter by the name of the decision definition the instances belongs to.	None
`--decision-definition-key-in`	text	Filter by the keys of the decision definition the instances belongs to. Must be a comma-
separated list of decision definition keys.	None
`--decision-definition-key`	text	Filter by the key of the decision definition the instances belongs to.	None
`--decision-definition-id-in`	text	Filter by the decision definitions the instances belongs to. Must be a
comma-separated list of decision definition ids.	None
`--decision-definition-id`	text	Filter by the decision definition the instances belongs to.	None
`--decision-instance-id-in`	text	Filter by decision instance ids. Must be a comma-separated list of decision instance ids.	None
`--decision-instance-id`	text	Filter by decision instance id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicDecisionInstancesCount¶

Get Historic Decision Instance Count Queries for the number of historic decision instances that fulfill the given parameters. Takes the same parameters as the Get Historic Decision Instances method. URL: /history/decision-instance/count Schema: -

Usage:

cctl&nbsp;get historicDecisionInstancesCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--decision-requirements-definition-key`	text	Filter by the key of the decision requirements definition the instances belongs to.	None
`--decision-requirements-definition-id`	text	Filter by the decision requirements definition the instances belongs to.	None
`--root-decision-instances-only` / `--not-root-decision-instances-only`	boolean	Restrict to instances those are the root decision instance of an evaluation.
Value may only be `true`, as `false` is the default behavior.	None
`--root-decision-instance-id`	text	Restrict to instances that have a given root decision instance id.
This also includes the decision instance with the given id.	None
`--user-id`	text	Restrict to instances that were evaluated by the given user.	None
`--evaluated-after`	text	Restrict to instances that were evaluated after the given date.
By default, the date must have the format `yyyy-MM-
dd'T'HH:mm:ss.SSSZ`, e.g.,`2013-01-23T14:42:45.000+0200`.	None
`--evaluated-before`	text	Restrict to instances that were evaluated before the given date.
By default, the date must have the format `yyyy-MM-
dd'T'HH:mm:ss.SSSZ`, e.g.,`2013-01-23T14:42:45.000+0200`.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic decision instances that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids. A historic decision instance must have one
of the given tenant ids.	None
`--activity-instance-id-in`	text	Filter by the activity instance ids the instances belongs to.
Must be a comma-separated list of acitvity instance ids.	None
`--activity-id-in`	text	Filter by the activity ids the instances belongs to.
Must be a comma-separated list of acitvity ids.	None
`--case-instance-id`	text	Filter by the case instance the instances belongs to.	None
`--case-definition-key`	text	Filter by the key of the case definition the instances belongs to.	None
`--case-definition-id`	text	Filter by the case definition the instances belongs to.	None
`--process-instance-id`	text	Filter by the process instance the instances belongs to.	None
`--process-definition-key`	text	Filter by the key of the process definition the instances belongs to.	None
`--process-definition-id`	text	Filter by the process definition the instances belongs to.	None
`--decision-definition-name-like`	text	Filter by the name of the decision definition the instances belongs to, that the parameter
is a substring of.	None
`--decision-definition-name`	text	Filter by the name of the decision definition the instances belongs to.	None
`--decision-definition-key-in`	text	Filter by the keys of the decision definition the instances belongs to. Must be a comma-
separated list of decision definition keys.	None
`--decision-definition-key`	text	Filter by the key of the decision definition the instances belongs to.	None
`--decision-definition-id-in`	text	Filter by the decision definitions the instances belongs to. Must be a
comma-separated list of decision definition ids.	None
`--decision-definition-id`	text	Filter by the decision definition the instances belongs to.	None
`--decision-instance-id-in`	text	Filter by decision instance ids. Must be a comma-separated list of decision instance ids.	None
`--decision-instance-id`	text	Filter by decision instance id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicDetail¶

Get Historic Detail Retrieves a historic detail by id. URL: /history/detail/{id} Schema: -

Usage:

cctl&nbsp;get historicDetail [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-value` / `--not-deserialize-value`	boolean	Determines whether serializable variable values (typically
variables that store custom Java objects) should be deserialized
on server side (default `true`).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get historicDetailBinary¶

Get Historic Detail (Binary) Retrieves the content of a historic variable update by id. Applicable for byte array and file variables. URL: /history/detail/{id}/data Schema: -

Usage:

cctl&nbsp;get historicDetailBinary [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicDetails¶

Get Historic Details Queries for historic details that fulfill the given parameters. The size of the result set can be retrieved by using the Get Historic Detail Count method. URL: /history/detail Schema: -

Usage:

cctl&nbsp;get historicDetails [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that
store custom Java objects) should be deserialized on server side (default
`true`).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get historicDetailsCount¶

Get Historic Detail Count Queries for the number of historic details that fulfill the given parameters. Takes the same parameters as the Get Historic Details method. URL: /history/detail/count Schema: -

Usage:

cctl&nbsp;get historicDetailsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--occurred-after`	text	Restrict to historic details that occured after the given date (including the date).
Default format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200.	None
`--occurred-before`	text	Restrict to historic details that occured before the given date (including the date).
Default format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200.	None
`--initial` / `--not-initial`	boolean	Restrict to historic variable updates that contain only initial variable values.
Value may only be `true`, as `false` is the default behavior.	None
`--exclude-task-details` / `--not-exclude-task-details`	boolean	Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected.
When this parameter is used together with `taskId`, this call is ignored and task details are not excluded.
Value may only be `true`, as `false` is the default behavior.	None
`--variable-updates` / `--not-variable-updates`	boolean	Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior.	None
`--form-fields` / `--not-form-fields`	boolean	Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior.	None
`--user-operation-id`	text	Filter by a user operation id.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic details that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids.	None
`--variable-type-in`	text	Only include historic details where the variable updates belong to one of the passed comma-separated
list of variable types. A list of all supported variable types can be found
here.
Note: All non-primitive variables are associated with the type `serializable`.	None
`--variable-instance-id`	text	Filter by variable instance id.	None
`--case-execution-id`	text	Filter by case execution id.	None
`--case-instance-id`	text	Filter by case instance id.	None
`--activity-instance-id`	text	Filter by activity instance id.	None
`--task-id`	text	Filter by task id.	None
`--execution-id`	text	Filter by execution id.	None
`--process-instance-id-in`	text	Only include historic details which belong to one of the passed comma-separated process instance ids.	None
`--process-instance-id`	text	Filter by process instance id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicExternalTaskLog¶

Get External Task Log Retrieves a historic external task log by id. URL: /history/external-task-log/{id} Schema: -

Usage:

cctl&nbsp;get historicExternalTaskLog [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicExternalTaskLogs¶

Get External Task Logs Queries for historic external task logs that fulfill the given parameters. The size of the result set can be retrieved by using the Get External Task Log Count method. URL: /history/external-task-log Schema: -

Usage:

cctl&nbsp;get historicExternalTaskLogs [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--deletion-log` / `--not-deletion-log`	boolean	Only include deletion logs. Value may only be `true`, as `false` is the default behavior.	None
`--success-log` / `--not-success-log`	boolean	Only include success logs. Value may only be `true`, as `false` is the default behavior.	None
`--failure-log` / `--not-failure-log`	boolean	Only include failure logs. Value may only be `true`, as `false` is the default behavior.	None
`--creation-log` / `--not-creation-log`	boolean	Only include creation logs. Value may only be `true`, as `false` is the default behavior.	None
`--priority-higher-than-or-equals`	text	Only include logs for which the associated external task had a priority higher than or
equal to the given value. Value must be a valid `long` value.	None
`--priority-lower-than-or-equals`	text	Only include logs for which the associated external task had a priority lower than or
equal to the given value. Value must be a valid `long` value.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic external task log entries that belong to no tenant. Value may only
be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Only include historic external task log entries which belong to one of the passed and
comma-separated tenant ids.	None
`--process-definition-key`	text	Filter by process definition key.	None
`--process-definition-id`	text	Filter by process definition id.	None
`--process-instance-id`	text	Filter by process instance id.	None
`--execution-id-in`	text	Only include historic external task logs which belong to one of the passed execution ids.	None
`--activity-instance-id-in`	text	Only include historic external task logs which belong to one of the passed activity
instance ids.	None
`--activity-id-in`	text	Only include historic external task logs which belong to one of the passed activity ids.	None
`--error-message`	text	Filter by external task exception message.	None
`--worker-id`	text	Filter by the id of the worker that the task was most recently locked by.	None
`--topic-name`	text	Filter by an external task topic.	None
`--external-task-id`	text	Filter by external task id.	None
`--log-id`	text	Filter by historic external task log id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicExternalTaskLogsCount¶

Get External Task Log Count Queries for the number of historic external task logs that fulfill the given parameters. Takes the same parameters as the Get External Task Logs method. URL: /history/external-task-log/count Schema: -

Usage:

cctl&nbsp;get historicExternalTaskLogsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deletion-log` / `--not-deletion-log`	boolean	Only include deletion logs. Value may only be `true`, as `false` is the default behavior.	None
`--success-log` / `--not-success-log`	boolean	Only include success logs. Value may only be `true`, as `false` is the default behavior.	None
`--failure-log` / `--not-failure-log`	boolean	Only include failure logs. Value may only be `true`, as `false` is the default behavior.	None
`--creation-log` / `--not-creation-log`	boolean	Only include creation logs. Value may only be `true`, as `false` is the default behavior.	None
`--priority-higher-than-or-equals`	text	Only include logs for which the associated external task had a priority higher than or
equal to the given value. Value must be a valid `long` value.	None
`--priority-lower-than-or-equals`	text	Only include logs for which the associated external task had a priority lower than or
equal to the given value. Value must be a valid `long` value.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic external task log entries that belong to no tenant. Value may only
be `true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Only include historic external task log entries which belong to one of the passed and
comma-separated tenant ids.	None
`--process-definition-key`	text	Filter by process definition key.	None
`--process-definition-id`	text	Filter by process definition id.	None
`--process-instance-id`	text	Filter by process instance id.	None
`--execution-id-in`	text	Only include historic external task logs which belong to one of the passed execution ids.	None
`--activity-instance-id-in`	text	Only include historic external task logs which belong to one of the passed activity
instance ids.	None
`--activity-id-in`	text	Only include historic external task logs which belong to one of the passed activity ids.	None
`--error-message`	text	Filter by external task exception message.	None
`--worker-id`	text	Filter by the id of the worker that the task was most recently locked by.	None
`--topic-name`	text	Filter by an external task topic.	None
`--external-task-id`	text	Filter by external task id.	None
`--log-id`	text	Filter by historic external task log id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicIdentityLinks¶

Get Identity Link Logs Queries for historic identity link logs that fulfill given parameters. The size of the result set can be retrieved by using the Get Identity-Link-Log Count method. URL: /history/identity-link-log Schema: -

Usage:

cctl&nbsp;get historicIdentityLinks [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic identity links that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids.	None
`--assigner-id`	text	Restricts to identity links that have the given assigner id.	None
`--operation-type`	text	Restricts to identity links that have the given operationType (add/delete).	None
`--process-definition-key`	text	Restricts to identity links that have the given process definition key.	None
`--process-definition-id`	text	Restricts to identity links that have the given process definition id.	None
`--task-id`	text	Restricts to identity links that have the given task id.	None
`--date-after`	text	Restricts to identity links that have the time after the given time.	None
`--date-before`	text	Restricts to identity links that have the time before the given time.	None
`--group-id`	text	Restricts to identity links that have the given group id.	None
`--user-id`	text	Restricts to identity links that have the given user id.	None
`--type`	text	Restricts to identity links that have the given type (candidate/assignee/owner).	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicIdentityLinksCount¶

Get Identity Link Log Count Queries for the number of historic identity link logs that fulfill the given parameters. Takes the same parameters as the Get Identity-Link-Logs method. URL: /history/identity-link-log/count Schema: -

Usage:

cctl&nbsp;get historicIdentityLinksCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic identity links that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids.	None
`--assigner-id`	text	Restricts to identity links that have the given assigner id.	None
`--operation-type`	text	Restricts to identity links that have the given operationType (add/delete).	None
`--process-definition-key`	text	Restricts to identity links that have the given process definition key.	None
`--process-definition-id`	text	Restricts to identity links that have the given process definition id.	None
`--task-id`	text	Restricts to identity links that have the given task id.	None
`--date-after`	text	Restricts to identity links that have the time after the given time.	None
`--date-before`	text	Restricts to identity links that have the time before the given time.	None
`--group-id`	text	Restricts to identity links that have the given group id.	None
`--user-id`	text	Restricts to identity links that have the given user id.	None
`--type`	text	Restricts to identity links that have the given type (candidate/assignee/owner).	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicIncidents¶

Get Incidents Queries for historic incidents that fulfill given parameters. The size of the result set can be retrieved by using the Get Incident Count method. URL: /history/incident Schema: -

Usage:

cctl&nbsp;get historicIncidents [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--job-definition-id-in`	text	Restricts to incidents that have one of the given comma-separated job definition ids.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic incidents that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Restricts to incidents that have one of the given comma-separated tenant ids.	None
`--deleted` / `--not-deleted`	boolean	Restricts to incidents that are deleted.	None
`--resolved` / `--not-resolved`	boolean	Restricts to incidents that are resolved.	None
`--open` / `--not-open`	boolean	Restricts to incidents that are open.	None
`--history-configuration`	text	Restricts to incidents that have the given parameter set as history configuration.	None
`--configuration`	text	Restricts to incidents that have the given parameter set as configuration.	None
`--root-cause-incident-id`	text	Restricts to incidents that have the given incident id as root cause incident.	None
`--cause-incident-id`	text	Restricts to incidents that have the given incident id as cause incident.	None
`--failed-activity-id`	text	Restricts to incidents that were created due to the failure of an activity with the given
id.	None
`--activity-id`	text	Restricts to incidents that belong to an activity with the given id.	None
`--end-time-after`	text	Restricts to incidents that have an endTimeAfter date after the given date. By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--end-time-before`	text	Restricts to incidents that have an endTimeBefore date before the given date. By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--create-time-after`	text	Restricts to incidents that have a createTime date after the given date. By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--create-time-before`	text	Restricts to incidents that have a createTime date before the given date. By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--execution-id`	text	Restricts to incidents that belong to an execution with the given id.	None
`--process-instance-id`	text	Restricts to incidents that belong to a process instance with the given id.	None
`--process-definition-key-in`	text	Restricts to incidents that have one of the given process definition keys.	None
`--process-definition-key`	text	Restricts to incidents that have the given processDefinitionKey.	None
`--process-definition-id`	text	Restricts to incidents that belong to a process definition with the given id.	None
`--incident-message-like`	text	Restricts to incidents that incidents message is a substring of the given value.
The string can include the wildcard character '%' to express
like-strategy: starts with (string%), ends with (%string) or contains
(%string%).	None
`--incident-message`	text	Restricts to incidents that have the given incident message.	None
`--incident-type`	text	Restricts to incidents that belong to the given incident type. See the [User
Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types)
for a list of incident types.	None
`--incident-id`	text	Restricts to incidents that have the given id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicIncidentsCount¶

Get Incident Count Queries for the number of historic incidents that fulfill the given parameters. Takes the same parameters as the Get Incidents method. URL: /history/incident/count Schema: -

Usage:

cctl&nbsp;get historicIncidentsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--job-definition-id-in`	text	Restricts to incidents that have one of the given comma-separated job definition ids.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic incidents that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Restricts to incidents that have one of the given comma-separated tenant ids.	None
`--deleted` / `--not-deleted`	boolean	Restricts to incidents that are deleted.	None
`--resolved` / `--not-resolved`	boolean	Restricts to incidents that are resolved.	None
`--open` / `--not-open`	boolean	Restricts to incidents that are open.	None
`--history-configuration`	text	Restricts to incidents that have the given parameter set as history configuration.	None
`--configuration`	text	Restricts to incidents that have the given parameter set as configuration.	None
`--root-cause-incident-id`	text	Restricts to incidents that have the given incident id as root cause incident.	None
`--cause-incident-id`	text	Restricts to incidents that have the given incident id as cause incident.	None
`--failed-activity-id`	text	Restricts to incidents that were created due to the failure of an activity with the given
id.	None
`--activity-id`	text	Restricts to incidents that belong to an activity with the given id.	None
`--end-time-after`	text	Restricts to incidents that have an endTimeAfter date after the given date. By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--end-time-before`	text	Restricts to incidents that have an endTimeBefore date before the given date. By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--create-time-after`	text	Restricts to incidents that have a createTime date after the given date. By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--create-time-before`	text	Restricts to incidents that have a createTime date before the given date. By default, the date must have the format
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--execution-id`	text	Restricts to incidents that belong to an execution with the given id.	None
`--process-instance-id`	text	Restricts to incidents that belong to a process instance with the given id.	None
`--process-definition-key-in`	text	Restricts to incidents that have one of the given process definition keys.	None
`--process-definition-key`	text	Restricts to incidents that have the given processDefinitionKey.	None
`--process-definition-id`	text	Restricts to incidents that belong to a process definition with the given id.	None
`--incident-message-like`	text	Restricts to incidents that incidents message is a substring of the given value.
The string can include the wildcard character '%' to express
like-strategy: starts with (string%), ends with (%string) or contains
(%string%).	None
`--incident-message`	text	Restricts to incidents that have the given incident message.	None
`--incident-type`	text	Restricts to incidents that belong to the given incident type. See the [User
Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types)
for a list of incident types.	None
`--incident-id`	text	Restricts to incidents that have the given id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicJobLog¶

Get Job Log Retrieves a historic job log by id. URL: /history/job-log/{id} Schema: -

Usage:

cctl&nbsp;get historicJobLog [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicJobLogs¶

Get Job Logs Queries for historic job logs that fulfill the given parameters. The size of the result set can be retrieved by using the Get Job Log Count method. URL: /history/job-log Schema: -

Usage:

cctl&nbsp;get historicJobLogs [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--deletion-log` / `--not-deletion-log`	boolean	Only include deletion logs. Value may only be `true`, as `false` is the default behavior.	None
`--success-log` / `--not-success-log`	boolean	Only include success logs. Value may only be `true`, as `false` is the default behavior.	None
`--failure-log` / `--not-failure-log`	boolean	Only include failure logs. Value may only be `true`, as `false` is the default behavior.	None
`--creation-log` / `--not-creation-log`	boolean	Only include creation logs. Value may only be `true`, as `false` is the default behavior.	None
`--job-priority-higher-than-or-equals`	text	Only include logs for which the associated job had a priority higher than or equal to the
given value. Value must be a valid `long` value.	None
`--job-priority-lower-than-or-equals`	text	Only include logs for which the associated job had a priority lower than or equal to the
given value. Value must be a valid `long` value.	None
`--hostname`	text	Filter by hostname.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic job log entries that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Only include historic job log entries which belong to one of the passed and comma-
separated tenant ids.	None
`--deployment-id`	text	Filter by deployment id.	None
`--process-definition-key`	text	Filter by process definition key.	None
`--process-definition-id`	text	Filter by process definition id.	None
`--process-instance-id`	text	Filter by process instance id.	None
`--execution-id-in`	text	Only include historic job logs which belong to one of the passed execution ids.	None
`--failed-activity-id-in`	text	Only include historic job logs which belong to failures of one of the passed activity ids.	None
`--activity-id-in`	text	Only include historic job logs which belong to one of the passed activity ids.	None
`--job-definition-configuration`	text	Filter by job definition configuration.	None
`--job-definition-type`	text	Filter by job definition type. See the
User Guide
for more information about job definition types.	None
`--job-definition-id`	text	Filter by job definition id.	None
`--job-exception-message`	text	Filter by job exception message.	None
`--job-id`	text	Filter by job id.	None
`--log-id`	text	Filter by historic job log id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicJobLogsCount¶

Get Job Log Count Queries for the number of historic job logs that fulfill the given parameters. Takes the same parameters as the Get Job Logs method. URL: /history/job-log/count Schema: -

Usage:

cctl&nbsp;get historicJobLogsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deletion-log` / `--not-deletion-log`	boolean	Only include deletion logs. Value may only be `true`, as `false` is the default behavior.	None
`--success-log` / `--not-success-log`	boolean	Only include success logs. Value may only be `true`, as `false` is the default behavior.	None
`--failure-log` / `--not-failure-log`	boolean	Only include failure logs. Value may only be `true`, as `false` is the default behavior.	None
`--creation-log` / `--not-creation-log`	boolean	Only include creation logs. Value may only be `true`, as `false` is the default behavior.	None
`--job-priority-higher-than-or-equals`	text	Only include logs for which the associated job had a priority higher than or equal to the
given value. Value must be a valid `long` value.	None
`--job-priority-lower-than-or-equals`	text	Only include logs for which the associated job had a priority lower than or equal to the
given value. Value must be a valid `long` value.	None
`--hostname`	text	Filter by hostname.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic job log entries that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Only include historic job log entries which belong to one of the passed and comma-
separated tenant ids.	None
`--deployment-id`	text	Filter by deployment id.	None
`--process-definition-key`	text	Filter by process definition key.	None
`--process-definition-id`	text	Filter by process definition id.	None
`--process-instance-id`	text	Filter by process instance id.	None
`--execution-id-in`	text	Only include historic job logs which belong to one of the passed execution ids.	None
`--failed-activity-id-in`	text	Only include historic job logs which belong to failures of one of the passed activity ids.	None
`--activity-id-in`	text	Only include historic job logs which belong to one of the passed activity ids.	None
`--job-definition-configuration`	text	Filter by job definition configuration.	None
`--job-definition-type`	text	Filter by job definition type. See the
User Guide
for more information about job definition types.	None
`--job-definition-id`	text	Filter by job definition id.	None
`--job-exception-message`	text	Filter by job exception message.	None
`--job-id`	text	Filter by job id.	None
`--log-id`	text	Filter by historic job log id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicProcessInstance¶

Get Retrieves a historic process instance by id, according to the HistoricProcessInstance interface in the engine. URL: /history/process-instance/{id} Schema: -

Usage:

cctl&nbsp;get historicProcessInstance [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicProcessInstanceDurationReport¶

Get Duration Report Retrieves a report about the duration of completed process instances, grouped by a period. These reports include the maximum, minimum and average duration of all completed process instances which were started in a given period.

Note: This only includes historic data. URL: /history/process-instance/report Schema: -

Usage:

cctl&nbsp;get historicProcessInstanceDurationReport [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--started-after`	text	Restrict to instances that were started after the given date.
By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`.	None
`--started-before`	text	Restrict to instances that were started before the given date.
By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`.	None
`--process-definition-key-in`	text	Filter by process definition keys. Must be a comma-separated list of process definition keys.	None
`--process-definition-id-in`	text	Filter by process definition ids. Must be a comma-separated list of process definition ids.	None
`--period-unit`	text	Mandatory. Specifies the granularity of the report. Valid values are `month` and `quarter`.	None
`--report-type`	text	Mandatory. Specifies the type of the report to retrieve.
To retrieve a report about the duration of process instances, the value must be set to `duration`.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicProcessInstances¶

Get List Queries for historic process instances that fulfill the given parameters. The size of the result set can be retrieved by using the Get Process Instance Count method. URL: /history/process-instance Schema: -

Usage:

cctl&nbsp;get historicProcessInstances [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal.	None
`--variables`	text	Only include process instances that have/had variables with certain values.
Variable filtering expressions are comma-separated and are structured as follows:
A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value.

Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like.

cctl get historicProcessInstancesCount¶

Get List Count Queries for the number of historic process instances that fulfill the given parameters. Takes the same parameters as the Get Process Instances method. URL: /history/process-instance/count Schema: -

Usage:

cctl&nbsp;get historicProcessInstancesCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal.	None
`--variables`	text	Only include process instances that have/had variables with certain values.
Variable filtering expressions are comma-separated and are structured as follows:
A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value.

Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like.

cctl get historicTaskInstanceReport¶

Get Task Report (Historic) Retrieves a report of completed tasks. When the report type is set to count, the report contains a list of completed task counts where an entry contains the task name, the definition key of the task, the process definition id, the process definition key, the process definition name and the count of how many tasks were completed for the specified key in a given period. When the report type is set to duration, the report contains a minimum, maximum and average duration value of all completed task instances in a given period. URL: /history/task/report Schema: -

Usage:

cctl&nbsp;get historicTaskInstanceReport [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--group-by`	text	When the report type is set to `count`, this parameter is mandatory. Groups the
tasks report by a given criterion. Valid values are `taskName` and `processDefinition`.	None
`--completed-after`	text	Restrict to tasks that were completed after the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., `2013-01-23T14:42:45.000+0200`.	None
`--completed-before`	text	Restrict to tasks that were completed before the given date. By default,
the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., `2013-01-23T14:42:45.000+0200`.	None
`--period-unit`	text	When the report type is set to `duration`, this parameter is mandatory.
Specifies the granularity of the report. Valid values are `month` and `quarter`.	None
`--report-type`	text	Mandatory. Specifies the kind of the report to execute. To retrieve a report
about the duration of process instances the value must be set to `duration`. For a
report of the completed tasks in a specific timespan the value must be set to `count`.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicTaskInstances¶

Get Tasks (Historic) Queries for historic tasks that fulfill the given parameters. The size of the result set can be retrieved by using the Get Task Count method. URL: /history/task Schema: -

Usage:

cctl&nbsp;get historicTaskInstances [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--without-candidate-groups` / `--not-without-candidate-groups`	boolean	Only include tasks which have no candidate group. Value may only be `true`,
as `false` is the default behavior.	None
`--with-candidate-groups` / `--not-with-candidate-groups`	boolean	Only include tasks which have a candidate group. Value may only be `true`,
as `false` is the default behavior.	None
`--task-had-candidate-group`	text	Restrict to tasks with a historic identity link to the given candidate group.	None
`--task-had-candidate-user`	text	Restrict to tasks with a historic identity link to the given candidate user.	None
`--task-involved-group`	text	Restrict to tasks with a historic identity link to the given group.	None
`--task-involved-user`	text	Restrict to tasks with a historic identity link to the given user.	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match the variable value provided in `taskVariables` and `processVariables` case-
insensitively. If set to `true` variableValue and variablevalue are
treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match the variable name provided in `taskVariables` and `processVariables` case-
insensitively. If set to `true` variableName and variablename are
treated as equal.	None
`--process-variables`	text	Only include tasks that belong to process instances that have variables with certain
values. Variable filtering expressions are comma-separated and are structured as
follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

Valid operator values are: * eq - equal to; * neq - not equal to; * gt - greater than; * gteq - greater than or equal to; * lt - lower than; * lteq - lower than or equal to; * like; * notLike.

key and value may not contain underscore or comma characters. | None | | --task-variables | text | Only include tasks that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

Valid operator values are: * eq - equal to; * neq - not equal to; * gt - greater than; * gteq - greater than or equal to; * lt - lower than; * lteq - lower than or equal to; * like.

cctl get historicTaskInstancesCount¶

Get Task Count Queries for the number of historic tasks that fulfill the given parameters. Takes the same parameters as the Get Tasks (Historic) method. URL: /history/task/count Schema: -

Usage:

cctl&nbsp;get historicTaskInstancesCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--without-candidate-groups` / `--not-without-candidate-groups`	boolean	Only include tasks which have no candidate group. Value may only be `true`,
as `false` is the default behavior.	None
`--with-candidate-groups` / `--not-with-candidate-groups`	boolean	Only include tasks which have a candidate group. Value may only be `true`,
as `false` is the default behavior.	None
`--task-had-candidate-group`	text	Restrict to tasks with a historic identity link to the given candidate group.	None
`--task-had-candidate-user`	text	Restrict to tasks with a historic identity link to the given candidate user.	None
`--task-involved-group`	text	Restrict to tasks with a historic identity link to the given group.	None
`--task-involved-user`	text	Restrict to tasks with a historic identity link to the given user.	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match the variable value provided in `taskVariables` and `processVariables` case-
insensitively. If set to `true` variableValue and variablevalue are
treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match the variable name provided in `taskVariables` and `processVariables` case-
insensitively. If set to `true` variableName and variablename are
treated as equal.	None
`--process-variables`	text	Only include tasks that belong to process instances that have variables with certain
values. Variable filtering expressions are comma-separated and are structured as
follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

Valid operator values are: * eq - equal to; * neq - not equal to; * gt - greater than; * gteq - greater than or equal to; * lt - lower than; * lteq - lower than or equal to; * like; * notLike.

key and value may not contain underscore or comma characters. | None | | --task-variables | text | Only include tasks that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

Valid operator values are: * eq - equal to; * neq - not equal to; * gt - greater than; * gteq - greater than or equal to; * lt - lower than; * lteq - lower than or equal to; * like.

cctl get historicVariableInstance¶

Get Variable Instance Retrieves a historic variable by id. URL: /history/variable-instance/{id} Schema: -

Usage:

cctl&nbsp;get historicVariableInstance [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that
store custom Java objects) should be deserialized on server side (default
`true`).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get historicVariableInstanceBinary¶

Get Variable Instance (Binary) Retrieves the content of a historic variable by id. Applicable for variables that are serialized as binary data. URL: /history/variable-instance/{id}/data Schema: -

Usage:

cctl&nbsp;get historicVariableInstanceBinary [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historicVariableInstances¶

Get Variable Instances Queries for historic variable instances that fulfill the given parameters. The size of the result set can be retrieved by using the Get Variable Instance Count method. URL: /history/variable-instance Schema: -

Usage:

cctl&nbsp;get historicVariableInstances [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that
store custom Java objects) should be deserialized on server side (default
`true`).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get historicVariableInstancesCount¶

Get Variable Instance Count Queries for the number of historic variable instances that fulfill the given parameters. Takes the same parameters as the Get Variable Instances method. URL: /history/variable-instance/count Schema: -

Usage:

cctl&nbsp;get historicVariableInstancesCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include historic variable instances that belong to no tenant. Value may only be
`true`, as `false` is the default behavior.	None
`--tenant-id-in`	text	Only include historic variable instances which belong to one of the passed and comma-
separated tenant ids.	None
`--activity-instance-id-in`	text	Only include historic variable instances which belong to one of the passed and and comma-separated activity instance ids.	None
`--task-id-in`	text	Only include historic variable instances which belong to one of the passed and and comma-separated task ids.	None
`--case-activity-id-in`	text	Only include historic variable instances which belong to one of the passed and and comma-separated case activity ids.	None
`--case-execution-id-in`	text	Only include historic variable instances which belong to one of the passed and and comma-separated case execution ids.	None
`--case-instance-id`	text	Filter by the case instance the variable belongs to.	None
`--execution-id-in`	text	Only include historic variable instances which belong to one of the passed and and comma-separated execution ids.	None
`--process-definition-key`	text	Filter by a key of the process definition the variable belongs to.	None
`--process-definition-id`	text	Filter by the process definition the variable belongs to.	None
`--process-instance-id-in`	text	Only include historic variable instances which belong to one of the passed and comma-separated process instance ids.	None
`--process-instance-id`	text	Filter by the process instance the variable belongs to.	None
`--include-deleted` / `--not-include-deleted`	boolean	Include variables that has already been deleted during the execution.	None
`--variable-type-in`	text	Only include historic variable instances which belong to one of the passed and comma-
separated variable types. A list of all supported variable types can be found
here.
Note: All non-primitive variables are associated with the type
'serializable'.	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match the variable value provided in `variableValue` case-insensitively. If set to `true`
variableValue and variablevalue are treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match the variable name provided in `variableName` and `variableNameLike` case-
insensitively. If set to `true` variableName and variablename are
treated as equal.	None
`--variable-value`	text	Filter by variable value. Is treated as a `String` object on server side.	None
`--variable-name-like`	text	Restrict to variables with a name like the parameter.	None
`--variable-name`	text	Filter by variable name.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get historyCleanupConfiguration¶

Get History Cleanup Configuration Retrieves history cleanup batch window configuration (See History cleanup). URL: /history/cleanup/configuration Schema: -

Usage:

cctl&nbsp;get historyCleanupConfiguration [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get identityLinks¶

Get List Gets the identity links for a task by id, which are the users and groups that are in some relation to it (including assignee and owner). URL: /task/{id}/identity-links Schema: -

Usage:

cctl&nbsp;get identityLinks [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--type`	text	Filter by the type of links to include.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get incident¶

Get Incident Retrieves an incident by ID. URL: /incident/{id} Schema: -

Usage:

cctl&nbsp;get incident [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get incidents¶

Get List Queries for incidents that fulfill given parameters. The size of the result set can be retrieved by using the Get Incident Count method. URL: /incident Schema: -

Usage:

cctl&nbsp;get incidents [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--job-definition-id-in`	text	Restricts to incidents that have one of the given comma-separated job definition ids.	None
`--tenant-id-in`	text	Restricts to incidents that have one of the given comma-separated tenant ids.	None
`--configuration`	text	Restricts to incidents that have the given parameter set as configuration.	None
`--root-cause-incident-id`	text	Restricts to incidents that have the given incident id as root cause incident.	None
`--cause-incident-id`	text	Restricts to incidents that have the given incident id as cause incident.	None
`--failed-activity-id`	text	Restricts to incidents that were created due to the failure of an activity with the given id.	None
`--activity-id`	text	Restricts to incidents that belong to an activity with the given id.	None
`--incident-timestamp-after`	text	Restricts to incidents that have an incidentTimestamp date after the given date.
By default, the date
must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--incident-timestamp-before`	text	Restricts to incidents that have an incidentTimestamp date before the given date.
By default, the date
must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--execution-id`	text	Restricts to incidents that belong to an execution with the given id.	None
`--process-instance-id`	text	Restricts to incidents that belong to a process instance with the given id.	None
`--process-definition-key-in`	text	Restricts to incidents that belong to a process definition with the given keys. Must be a
comma-separated list.	None
`--process-definition-id`	text	Restricts to incidents that belong to a process definition with the given id.	None
`--incident-message-like`	text	Restricts to incidents that incidents message is a substring of the given value. The string can include
the wildcard character '%' to express like-strategy: starts with (`string%`), ends with (`%string`) or
contains (`%string%`).	None
`--incident-message`	text	Restricts to incidents that have the given incident message.	None
`--incident-type`	text	Restricts to incidents that belong to the given incident type. See the
User Guide for a list of incident
types.	None
`--incident-id`	text	Restricts to incidents that have the given id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get incidentsCount¶

Get List Count Queries for the number of incidents that fulfill given parameters. Takes the same parameters as the Get Incidents method. URL: /incident/count Schema: -

Usage:

cctl&nbsp;get incidentsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--job-definition-id-in`	text	Restricts to incidents that have one of the given comma-separated job definition ids.	None
`--tenant-id-in`	text	Restricts to incidents that have one of the given comma-separated tenant ids.	None
`--configuration`	text	Restricts to incidents that have the given parameter set as configuration.	None
`--root-cause-incident-id`	text	Restricts to incidents that have the given incident id as root cause incident.	None
`--cause-incident-id`	text	Restricts to incidents that have the given incident id as cause incident.	None
`--failed-activity-id`	text	Restricts to incidents that were created due to the failure of an activity with the given id.	None
`--activity-id`	text	Restricts to incidents that belong to an activity with the given id.	None
`--incident-timestamp-after`	text	Restricts to incidents that have an incidentTimestamp date after the given date.
By default, the date
must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--incident-timestamp-before`	text	Restricts to incidents that have an incidentTimestamp date before the given date.
By default, the date
must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.	None
`--execution-id`	text	Restricts to incidents that belong to an execution with the given id.	None
`--process-instance-id`	text	Restricts to incidents that belong to a process instance with the given id.	None
`--process-definition-key-in`	text	Restricts to incidents that belong to a process definition with the given keys. Must be a
comma-separated list.	None
`--process-definition-id`	text	Restricts to incidents that belong to a process definition with the given id.	None
`--incident-message-like`	text	Restricts to incidents that incidents message is a substring of the given value. The string can include
the wildcard character '%' to express like-strategy: starts with (`string%`), ends with (`%string`) or
contains (`%string%`).	None
`--incident-message`	text	Restricts to incidents that have the given incident message.	None
`--incident-type`	text	Restricts to incidents that belong to the given incident type. See the
User Guide for a list of incident
types.	None
`--incident-id`	text	Restricts to incidents that have the given id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get interval¶

Get Metrics in Interval Retrieves a list of metrics, aggregated for a given interval. URL: /metrics Schema: -

Usage:

cctl&nbsp;get interval [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--aggregate-by-reporter`	text	Aggregate metrics by reporter.	None
`--interval`	text	The interval for which the metrics should be aggregated. Time unit is seconds.
Default: The interval is set to 15 minutes (900 seconds).	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--end-date`	text	The end date (exclusive).	None
`--start-date`	text	The start date (inclusive).	None
`--reporter`	text	The name of the reporter (host), on which the metrics was logged. This will have
value provided by the hostname configuration property.	None
`--name`	text	The name of the metric.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get isUserAuthorized¶

Perform an Authorization Check Performs an authorization check for the currently authenticated user. URL: /authorization/check Schema: -

Usage:

cctl&nbsp;get isUserAuthorized [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--user-id`	text	The id of the user to check permissions for. The currently authenticated
user must have a READ permission for the Authorization resource. If `userId` is
blank, a check for the currently authenticated user is performed.	None
`--resource-id`	text	The id of the resource to check permissions for. If left blank,
a check for global permissions on the resource is performed.	None
`--resource-type`	text	An integer representing the resource type to check permissions for.
See the User Guide
for a list of integer representations of resource types.	None
`--resource-name`	text	String value for the name of the resource to check permissions for.	None
`--permission-name`	text	String value representing the permission name to check for.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get job¶

Get Job Retrieves a job by id, according to the Job interface in the engine. URL: /job/{id} Schema: -

Usage:

cctl&nbsp;get job [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get jobDefinition¶

Get Job Definition Retrieves a job definition by id, according to the JobDefinition interface in the engine. URL: /job-definition/{id} Schema: -

Usage:

cctl&nbsp;get jobDefinition [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get jobDefinitions¶

Get Job Definitions Queries for job definitions that fulfill given parameters. The size of the result set can be retrieved by using the Get Job Definition Count method. URL: /job-definition Schema: -

Usage:

cctl&nbsp;get jobDefinitions [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--include-job-definitions-without-tenant-id` / `--not-include-job-definitions-without-tenant-id`	boolean	Include job definitions which belong to no tenant. Can be used in combination with
`tenantIdIn`. Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include job definitions which belong to no tenant. Value may only be `true`, as
`false` is the default behavior.	None
`--tenant-id-in`	text	Only include job definitions which belong to one of the passed and comma-separated tenant
ids.	None
`--with-overriding-job-priority` / `--not-with-overriding-job-priority`	boolean	Only include job definitions that have an overriding job priority defined. The only
effective value is `true`. If set to `false`, this filter is not applied.	None
`--suspended` / `--not-suspended`	boolean	Only include suspended job definitions. Value may only be `true`, as `false` is the
default behavior.	None
`--active` / `--not-active`	boolean	Only include active job definitions. Value may only be `true`, as `false` is the default
behavior.	None
`--job-configuration`	text	Only include job definitions which exist for the given job configuration. For example: for
timer jobs it is the timer configuration.	None
`--job-type`	text	Only include job definitions which exist for the given job type. See the
User Guide
for more information about job types.	None
`--process-definition-key`	text	Only include job definitions which exist for the given process definition key.	None
`--process-definition-id`	text	Only include job definitions which exist for the given process definition id.	None
`--activity-id-in`	text	Only include job definitions which belong to one of the passed and comma-separated activity ids.	None
`--job-definition-id`	text	Filter by job definition id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get jobDefinitionsCount¶

Get Job Definition Count Queries for the number of job definitions that fulfill given parameters. Takes the same parameters as the Get Job Definitions method. URL: /job-definition/count Schema: -

Usage:

cctl&nbsp;get jobDefinitionsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--include-job-definitions-without-tenant-id` / `--not-include-job-definitions-without-tenant-id`	boolean	Include job definitions which belong to no tenant. Can be used in combination with
`tenantIdIn`. Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include job definitions which belong to no tenant. Value may only be `true`, as
`false` is the default behavior.	None
`--tenant-id-in`	text	Only include job definitions which belong to one of the passed and comma-separated tenant
ids.	None
`--with-overriding-job-priority` / `--not-with-overriding-job-priority`	boolean	Only include job definitions that have an overriding job priority defined. The only
effective value is `true`. If set to `false`, this filter is not applied.	None
`--suspended` / `--not-suspended`	boolean	Only include suspended job definitions. Value may only be `true`, as `false` is the
default behavior.	None
`--active` / `--not-active`	boolean	Only include active job definitions. Value may only be `true`, as `false` is the default
behavior.	None
`--job-configuration`	text	Only include job definitions which exist for the given job configuration. For example: for
timer jobs it is the timer configuration.	None
`--job-type`	text	Only include job definitions which exist for the given job type. See the
User Guide
for more information about job types.	None
`--process-definition-key`	text	Only include job definitions which exist for the given process definition key.	None
`--process-definition-id`	text	Only include job definitions which exist for the given process definition id.	None
`--activity-id-in`	text	Only include job definitions which belong to one of the passed and comma-separated activity ids.	None
`--job-definition-id`	text	Filter by job definition id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get jobs¶

Get Jobs Queries for jobs that fulfill given parameters. The size of the result set can be retrieved by using the Get Job Count method. URL: /job Schema: -

Usage:

cctl&nbsp;get jobs [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--include-jobs-without-tenant-id` / `--not-include-jobs-without-tenant-id`	boolean	Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`.
Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the
default behavior.	None
`--tenant-id-in`	text	Only include jobs which belong to one of the passed comma-separated tenant ids.	None
`--priority-higher-than-or-equals`	text	Only include jobs with a priority higher than or equal to the given value. Value must be a
valid `long` value.	None
`--priority-lower-than-or-equals`	text	Only include jobs with a priority lower than or equal to the given value. Value must be a
valid `long` value.	None
`--suspended` / `--not-suspended`	boolean	Only include suspended jobs. Value may only be `true`, as `false` is the default behavior.	None
`--active` / `--not-active`	boolean	Only include active jobs. Value may only be `true`, as `false` is the default behavior.	None
`--no-retries-left` / `--not-no-retries-left`	boolean	Only select jobs which have no retries left. Value may only be `true`, as `false` is the
default behavior.	None
`--failed-activity-id`	text	Only select jobs that failed due to an exception at an activity with the given id.	None
`--exception-message`	text	Only select jobs that failed due to an exception with the given message.	None
`--with-exception` / `--not-with-exception`	boolean	Only select jobs that failed due to an exception. Value may only be `true`, as `false` is
the default behavior.	None
`--create-times`	text	Only select jobs created before or after the given date.

Create time expressions are comma-separated and are structured as follows:

A valid condition value has the form operator_value. operator is the comparison operator to be used and value the date value as string.

Valid operator values are: gt - greater than; lt - lower than. value may not contain underscore or comma characters. | None | | --due-dates | text | Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows:

A valid condition value has the form operator_value. operator is the comparison operator to be used and value the date value as string.

cctl get jobsCount¶

Get Job Count Queries for the number of jobs that fulfill given parameters. Takes the same parameters as the Get Jobs method. URL: /job/count Schema: -

Usage:

cctl&nbsp;get jobsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--include-jobs-without-tenant-id` / `--not-include-jobs-without-tenant-id`	boolean	Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`.
Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the
default behavior.	None
`--tenant-id-in`	text	Only include jobs which belong to one of the passed comma-separated tenant ids.	None
`--priority-higher-than-or-equals`	text	Only include jobs with a priority higher than or equal to the given value. Value must be a
valid `long` value.	None
`--priority-lower-than-or-equals`	text	Only include jobs with a priority lower than or equal to the given value. Value must be a
valid `long` value.	None
`--suspended` / `--not-suspended`	boolean	Only include suspended jobs. Value may only be `true`, as `false` is the default behavior.	None
`--active` / `--not-active`	boolean	Only include active jobs. Value may only be `true`, as `false` is the default behavior.	None
`--no-retries-left` / `--not-no-retries-left`	boolean	Only select jobs which have no retries left. Value may only be `true`, as `false` is the
default behavior.	None
`--failed-activity-id`	text	Only select jobs that failed due to an exception at an activity with the given id.	None
`--exception-message`	text	Only select jobs that failed due to an exception with the given message.	None
`--with-exception` / `--not-with-exception`	boolean	Only select jobs that failed due to an exception. Value may only be `true`, as `false` is
the default behavior.	None
`--create-times`	text	Only select jobs created before or after the given date.

Create time expressions are comma-separated and are structured as follows:

A valid condition value has the form operator_value. operator is the comparison operator to be used and value the date value as string.

Valid operator values are: gt - greater than; lt - lower than. value may not contain underscore or comma characters. | None | | --due-dates | text | Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows:

A valid condition value has the form operator_value. operator is the comparison operator to be used and value the date value as string.

cctl get latestProcessDefinitionByTenantId¶

Get Retrieves the latest version of the process definition for tenant according to the ProcessDefinition interface in the engine. URL: /process-definition/key/{key}/tenant-id/{tenant-id} Schema: -

Usage:

cctl&nbsp;get latestProcessDefinitionByTenantId [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get localExecutionVariable¶

Get Local Execution Variable Retrieves a variable from the context of a given execution by id. Does not traverse the parent execution hierarchy. URL: /execution/{id}/localVariables/{varName} Schema: -

Usage:

cctl&nbsp;get localExecutionVariable [OPTIONS] VARNAME ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-value` / `--not-deserialize-value`	boolean	Determines whether serializable variable values (typically
variables that store custom Java objects) should be deserialized
on server side (default `true`).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get localExecutionVariableBinary¶

Get Local Execution Variable (Binary) Retrieves a binary variable from the context of a given execution by id. Does not traverse the parent execution hierarchy. Applicable for byte array and file variables. URL: /execution/{id}/localVariables/{varName}/data Schema: -

Usage:

cctl&nbsp;get localExecutionVariableBinary [OPTIONS] VARNAME ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get localExecutionVariables¶

Get Local Execution Variables Retrieves all variables of a given execution by id. URL: /execution/{id}/localVariables Schema: -

Usage:

cctl&nbsp;get localExecutionVariables [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically
variables that store custom Java objects) should be deserialized
on server side (default `true`).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get messageEventSubscription¶

Get Message Event Subscription Retrieves a message event subscription for a given execution by id and a message name. URL: /execution/{id}/messageSubscriptions/{messageName} Schema: -

Usage:

cctl&nbsp;get messageEventSubscription [OPTIONS] MESSAGENAME ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get metrics¶

Get Sum Retrieves the sum (count) for a given metric. URL: /metrics/{metrics-name}/sum Schema: -

Usage:

cctl&nbsp;get metrics [OPTIONS] METRICS_NAME

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--end-date`	text	The end date (exclusive).	None
`--start-date`	text	The start date (inclusive).	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get passwordPolicy¶

Get Password Policy A password policy consists of a list of rules that new passwords must follow to be policy compliant. This end point returns a JSON representation of the list of policy rules. More information on password policies in Camunda can be found in the password policy user guide and in the security instructions. URL: /identity/password-policy Schema: -

Usage:

cctl&nbsp;get passwordPolicy [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinition¶

Get Retrieves a process definition according to the ProcessDefinition interface in the engine. URL: /process-definition/{id} Schema: -

Usage:

cctl&nbsp;get processDefinition [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitionBpmn20Xml¶

Get XML Retrieves the BPMN 2.0 XML of a process definition. URL: /process-definition/{id}/xml Schema: -

Usage:

cctl&nbsp;get processDefinitionBpmn20Xml [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitionBpmn20XmlByKey¶

Get XML Retrieves latest version the BPMN 2.0 XML of a process definition. URL: /process-definition/key/{key}/xml Schema: -

Usage:

cctl&nbsp;get processDefinitionBpmn20XmlByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitionBpmn20XmlByKeyAndTenantId¶

Get XML Retrieves latest version the BPMN 2.0 XML of a process definition. Returns the XML for the latest version of the process definition for tenant. URL: /process-definition/key/{key}/tenant-id/{tenant-id}/xml Schema: -

Usage:

cctl&nbsp;get processDefinitionBpmn20XmlByKeyAndTenantId [OPTIONS] TENANT_ID
                                                         KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitionByKey¶

Get Retrieves the latest version of the process definition which belongs to no tenant according to the ProcessDefinition interface in the engine. URL: /process-definition/key/{key} Schema: -

Usage:

cctl&nbsp;get processDefinitionByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitionDiagram¶

Get Diagram Retrieves the diagram of a process definition.

If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: someProcess.bpmn and someProcess.png. Supported file extentions for the image are: svg, png, jpg, and gif. URL: /process-definition/{id}/diagram Schema: -

Usage:

cctl&nbsp;get processDefinitionDiagram [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitionDiagramByKey¶

Get Diagram Retrieves the diagram for the latest version of the process definition which belongs to no tenant.

If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: someProcess.bpmn and someProcess.png. Supported file extentions for the image are: svg, png, jpg, and gif. URL: /process-definition/key/{key}/diagram Schema: -

Usage:

cctl&nbsp;get processDefinitionDiagramByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitionDiagramByKeyAndTenantId¶

Get Diagram Retrieves the diagram for the latest version of the process definition for tenant.

If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: someProcess.bpmn and someProcess.png. Supported file extentions for the image are: svg, png, jpg, and gif. URL: /process-definition/key/{key}/tenant-id/{tenant-id}/diagram Schema: -

Usage:

cctl&nbsp;get processDefinitionDiagramByKeyAndTenantId [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitionStatistics¶

Get Process Instance Statistics Retrieves runtime statistics of the process engine, grouped by process definitions. These statistics include the number of running process instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. Note: This does not include historic data. URL: /process-definition/statistics Schema: -

Usage:

cctl&nbsp;get processDefinitionStatistics [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--root-incidents` / `--not-root-incidents`	boolean	Valid values for this property are `true` or `false`.
If this property has been set to `true` the result will include the corresponding number of
root incidents for each occurred incident type.
If it is set to `false`, the incidents will not be included in the result.
Cannot be used in combination with `incidentsForType` or `incidents`.	None
`--incidents-for-type`	text	If this property has been set with any incident type (i.e., a string value) the result
will only include the number of incidents for the assigned incident type.
Cannot be used in combination with `incidents`.
See the User Guide
for a list of incident types.	None
`--incidents` / `--not-incidents`	boolean	Valid values for this property are `true` or `false`.
If this property has been set to `true` the result will include the corresponding number of incidents
for each occurred incident type.
If it is set to `false`, the incidents will not be included in the result.
Cannot be used in combination with `incidentsForType`.	None
`--failed-jobs` / `--not-failed-jobs`	boolean	Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitions¶

Get List Queries for process definitions that fulfill given parameters. Parameters may be the properties of process definitions, such as the name, key or version. The size of the result set can be retrieved by using the Get Definition Count method. URL: /process-definition Schema: -

Usage:

cctl&nbsp;get processDefinitions [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--startable-permission-check` / `--not-startable-permission-check`	boolean	Filter by process definitions which the user is allowed to start in Tasklist.
If the user doesn't have these permissions the result will be empty list.
The permissions are:
* `CREATE` permission for all Process instances
* `CREATE_INSTANCE` and `READ` permission on Process definition level	None
`--not-startable-in-tasklist` / `--not-not-startable-in-tasklist`	boolean	Filter by process definitions which are not startable in Tasklist.	None
`--startable-in-tasklist` / `--not-startable-in-tasklist`	boolean	Filter by process definitions which are startable in Tasklist..	None
`--without-version-tag` / `--not-without-version-tag`	boolean	Only include process definitions without a `versionTag`.	None
`--version-tag-like`	text	Filter by the version tag that the parameter is a substring of.	None
`--version-tag`	text	Filter by the version tag.	None
`--include-process-definitions-without-tenant-id` / `--not-include-process-definitions-without-tenant-id`	boolean	Include process definitions which belong to no tenant. Can be used in combination with `tenantIdIn`.
Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include process definitions which belong to no tenant.
Value may only be true, as false is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids.
A process definition must have one of the given tenant ids.	None
`--incident-message-like`	text	Filter by the incident message that the parameter is a substring of.	None
`--incident-message`	text	Filter by the incident message. Exact match.	None
`--incident-type`	text	Filter by the incident type.
See the User Guide
for a list of incident types.	None
`--incident-id`	text	Filter by the incident id.	None
`--suspended` / `--not-suspended`	boolean	Only include suspended process definitions.
Value may only be `true`, as `false` is the default behavior.	None
`--active` / `--not-active`	boolean	Only include active process definitions.
Value may only be `true`, as `false` is the default behavior.	None
`--startable-by`	text	Filter by a user name who is allowed to start the process.	None
`--resource-name-like`	text	Filter by names of those process definition resources that the parameter is a substring of.	None
`--resource-name`	text	Filter by the name of the process definition resource. Exact match.	None
`--latest-version` / `--not-latest-version`	boolean	Only include those process definitions that are latest versions.
Value may only be `true`, as `false` is the default behavior.	None
`--version`	text	Filter by process definition version.	None
`--category-like`	text	Filter by process definition categories that the parameter is a substring of.	None
`--category`	text	Filter by process definition category. Exact match.	None
`--key-like`	text	Filter by process definition keys that the parameter is a substring of.	None
`--keys-in`	text	Filter by a comma-separated list of process definition keys.	None
`--key`	text	Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match.	None
`--deployed-at`	text	Filter by the deploy time of the deployment the process definition belongs to.
Only selects process definitions that have been deployed at a specific time (exact match).
By default, the date must have the
format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
`2013-01-23T14:42:45.546+0200`.	None
`--deployed-after`	text	Filter by the deploy time of the deployment the process definition belongs to.
Only selects process definitions that have been deployed after (exclusive) a specific time.
By default, the date must have the
format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
`2013-01-23T14:42:45.546+0200`.	None
`--deployment-id`	text	Filter by the deployment the id belongs to.	None
`--name-like`	text	Filter by process definition names that the parameter is a substring of.	None
`--name`	text	Filter by process definition name.	None
`--process-definition-id-in`	text	Filter by a comma-separated list of process definition ids.	None
`--process-definition-id`	text	Filter by process definition id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processDefinitionsCount¶

Get List Count Requests the number of process definitions that fulfill the query criteria. Takes the same filtering parameters as the Get Definitions method. URL: /process-definition/count Schema: -

Usage:

cctl&nbsp;get processDefinitionsCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--startable-permission-check` / `--not-startable-permission-check`	boolean	Filter by process definitions which the user is allowed to start in Tasklist.
If the user doesn't have these permissions the result will be empty list.
The permissions are:
* `CREATE` permission for all Process instances
* `CREATE_INSTANCE` and `READ` permission on Process definition level	None
`--not-startable-in-tasklist` / `--not-not-startable-in-tasklist`	boolean	Filter by process definitions which are not startable in Tasklist.	None
`--startable-in-tasklist` / `--not-startable-in-tasklist`	boolean	Filter by process definitions which are startable in Tasklist..	None
`--without-version-tag` / `--not-without-version-tag`	boolean	Only include process definitions without a `versionTag`.	None
`--version-tag-like`	text	Filter by the version tag that the parameter is a substring of.	None
`--version-tag`	text	Filter by the version tag.	None
`--include-process-definitions-without-tenant-id` / `--not-include-process-definitions-without-tenant-id`	boolean	Include process definitions which belong to no tenant. Can be used in combination with `tenantIdIn`.
Value may only be `true`, as `false` is the default behavior.	None
`--without-tenant-id` / `--not-without-tenant-id`	boolean	Only include process definitions which belong to no tenant.
Value may only be true, as false is the default behavior.	None
`--tenant-id-in`	text	Filter by a comma-separated list of tenant ids.
A process definition must have one of the given tenant ids.	None
`--incident-message-like`	text	Filter by the incident message that the parameter is a substring of.	None
`--incident-message`	text	Filter by the incident message. Exact match.	None
`--incident-type`	text	Filter by the incident type.
See the User Guide
for a list of incident types.	None
`--incident-id`	text	Filter by the incident id.	None
`--suspended` / `--not-suspended`	boolean	Only include suspended process definitions.
Value may only be `true`, as `false` is the default behavior.	None
`--active` / `--not-active`	boolean	Only include active process definitions.
Value may only be `true`, as `false` is the default behavior.	None
`--startable-by`	text	Filter by a user name who is allowed to start the process.	None
`--resource-name-like`	text	Filter by names of those process definition resources that the parameter is a substring of.	None
`--resource-name`	text	Filter by the name of the process definition resource. Exact match.	None
`--latest-version` / `--not-latest-version`	boolean	Only include those process definitions that are latest versions.
Value may only be `true`, as `false` is the default behavior.	None
`--version`	text	Filter by process definition version.	None
`--category-like`	text	Filter by process definition categories that the parameter is a substring of.	None
`--category`	text	Filter by process definition category. Exact match.	None
`--key-like`	text	Filter by process definition keys that the parameter is a substring of.	None
`--keys-in`	text	Filter by a comma-separated list of process definition keys.	None
`--key`	text	Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match.	None
`--deployed-at`	text	Filter by the deploy time of the deployment the process definition belongs to.
Only selects process definitions that have been deployed at a specific time (exact match).
By default, the date must have the
format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
`2013-01-23T14:42:45.546+0200`.	None
`--deployed-after`	text	Filter by the deploy time of the deployment the process definition belongs to.
Only selects process definitions that have been deployed after (exclusive) a specific time.
By default, the date must have the
format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
`2013-01-23T14:42:45.546+0200`.	None
`--deployment-id`	text	Filter by the deployment the id belongs to.	None
`--name-like`	text	Filter by process definition names that the parameter is a substring of.	None
`--name`	text	Filter by process definition name.	None
`--process-definition-id-in`	text	Filter by a comma-separated list of process definition ids.	None
`--process-definition-id`	text	Filter by process definition id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processEngineNames¶

Get List Retrieves the names of all process engines available on your platform. Note: You cannot prepend /engine/{name} to this method. URL: /engine Schema: -

Usage:

cctl&nbsp;get processEngineNames [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processInstance¶

Get Process Instance Retrieves a process instance by id, according to the ProcessInstance interface in the engine. URL: /process-instance/{id} Schema: -

Usage:

cctl&nbsp;get processInstance [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processInstanceVariable¶

Get Process Variable Retrieves a variable of a given process instance by id. URL: /process-instance/{id}/variables/{varName} Schema: -

Usage:

cctl&nbsp;get processInstanceVariable [OPTIONS] VARNAME ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-value` / `--not-deserialize-value`	boolean	Determines whether serializable variable values (typically variables that store custom Java objects)
should be deserialized on server side (default true).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get processInstanceVariableBinary¶

Get Process Variable (Binary) Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name. Applicable for byte array or file Process Variables. URL: /process-instance/{id}/variables/{varName}/data Schema: -

Usage:

cctl&nbsp;get processInstanceVariableBinary [OPTIONS] VARNAME ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get processInstanceVariables¶

Get Process Variables Retrieves all variables of a given process instance by id. URL: /process-instance/{id}/variables Schema: -

Usage:

cctl&nbsp;get processInstanceVariables [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that store custom Java objects)
should be deserialized on server side (default true).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get processInstances¶

Get List Queries for process instances that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of process instances. The size of the result set can be retrieved by using the Get Instance Count method. URL: /process-instance Schema: -

Usage:

cctl&nbsp;get processInstances [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match all variable values in this query case-insensitively.
If set to true variableValue and variablevalue are treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match all variable names in this query case-insensitively.
If set to true variableName and variablename are treated as equal.	None
`--variables`	text	Only include process instances that have variables with certain values.
Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

cctl get processInstancesCount¶

Get List Count Queries for the number of process instances that fulfill given parameters. URL: /process-instance/count Schema: -

Usage:

cctl&nbsp;get processInstancesCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match all variable values in this query case-insensitively.
If set to true variableValue and variablevalue are treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match all variable names in this query case-insensitively.
If set to true variableName and variablename are treated as equal.	None
`--variables`	text	Only include process instances that have variables with certain values.
Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

cctl get queryAuthorizations¶

Get Authorizations Queries for a list of authorizations using a list of parameters. The size of the result set can be retrieved by using the Get Authorization Count method. URL: /authorization Schema: -

Usage:

cctl&nbsp;get queryAuthorizations [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--resource-id`	text	Filter by resource id.	None
`--resource-type`	text	Filter by an integer representation of the resource type. See the
User Guide
for a list of integer representations of resource types.	None
`--group-id-in`	text	Filter by a comma-separated list of groupIds.	None
`--user-id-in`	text	Filter by a comma-separated list of userIds.	None
`--type`	text	Filter by authorization type. (0=global, 1=grant, 2=revoke).
See the User Guide
for more information about authorization types.	None
`--id`	text	Filter by the id of the authorization.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get queryGroups¶

Get List Queries for a list of groups using a list of parameters. The size of the result set can be retrieved by using the Get Group Count method. URL: /group Schema: -

Usage:

cctl&nbsp;get queryGroups [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--member-of-tenant`	text	Only retrieve groups which are members of the given tenant.	None
`--member`	text	Only retrieve groups where the given user id is a member of.	None
`--type`	text	Filter by the type of the group.	None
`--name-like`	text	Filter by the name that the parameter is a substring of.	None
`--name`	text	Filter by the name of the group.	None
`--id-in`	text	Filter by a comma seperated list of group ids.	None
`--id`	text	Filter by the id of the group.	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get queryTenants¶

Get Tenants Query for a list of tenants using a list of parameters. The size of the result set can be retrieved by using the Get Tenant Count method. URL: /tenant Schema: -

Usage:

cctl&nbsp;get queryTenants [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--including-groups-of-user` / `--not-including-groups-of-user`	boolean	Select only tenants where the user or one of his groups is a member of.
Can only be used in combination with the `userMember` parameter. Value may only be `true`,
as `false` is the default behavior.	None
`--group-member`	text	Select only tenants where the given group is a member of.	None
`--user-member`	text	Select only tenants where the given user is a member of.	None
`--name-like`	text	Filter by the name that the parameter is a substring of.	None
`--name`	text	Filter by the name of the tenant.	None
`--id`	text	Filter by the id of the tenant.	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get queryUserOperationCount¶

Get User Operation Log Count Queries for the number of user operation log entries that fulfill the given parameters. Takes the same parameters as the Get User Operation Log (Historic) method. URL: /history/user-operation/count Schema: -

Usage:

cctl&nbsp;get queryUserOperationCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--before-timestamp`	text	Restrict to entries that were created before the given timestamp. By default, the
timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., 2013-01-23T14:42:45.000+0200.	None
`--after-timestamp`	text	Restrict to entries that were created after the given timestamp. By default, the
timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., 2013-01-23T14:42:45.000+0200.	None
`--property`	text	Only include operations that changed this property, e.g., `owner` or `assignee`.	None
`--category-in`	text	Filter by a comma-separated list of categories that this operation is associated with, possible values are
`TaskWorker`, `Admin` or `Operator`.	None
`--category`	text	Filter by the category that this operation is associated with, possible values are
`TaskWorker`, `Admin` or `Operator`.	None
`--entity-type-in`	text	Filter by a comma-separated list of types of the entities that was affected by this operation,
possible values are `Task`, `Attachment` or `IdentityLink`.	None
`--entity-type`	text	Filter by the type of the entity that was affected by this operation, possible values are
`Task`, `Attachment` or `IdentityLink`.	None
`--operation-type`	text	Filter by the type of the operation like `Claim` or `Delegate`. See the
Javadoc
for a list of available operation types.	None
`--operation-id`	text	Filter by the id of the operation. This allows fetching of multiple entries which are part
of a composite operation.	None
`--user-id`	text	Only include operations of this user.	None
`--job-definition-id`	text	Filter by job definition id.	None
`--job-id`	text	Filter by job id.	None
`--batch-id`	text	Only include operations on this batch.	None
`--external-task-id`	text	Only include operations on this external task.	None
`--task-id`	text	Only include operations on this task.	None
`--case-execution-id`	text	Filter by case execution id.	None
`--case-instance-id`	text	Filter by case instance id.	None
`--case-definition-id`	text	Filter by case definition id.	None
`--execution-id`	text	Filter by execution id.	None
`--process-instance-id`	text	Filter by process instance id.	None
`--process-definition-key`	text	Filter by process definition key.	None
`--process-definition-id`	text	Filter by process definition id.	None
`--deployment-id`	text	Filter by deployment id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get queryUserOperationEntries¶

Get User Operation Log (Historic) Queries for user operation log entries that fulfill the given parameters. The size of the result set can be retrieved by using the Get User Operation Log Count method.

Note that the properties of operation log entries are interpreted as restrictions on the entities they apply to. That means, if a single process instance is updated, the field processInstanceId is populated. If a single operation updates all process instances of the same process definition, the field processInstanceId is null (a null restriction is viewed as a wildcard, i.e., matches a process instance with any id) and the field processDefinitionId is populated. This way, which entities were changed by a user operation can easily be reconstructed. URL: /history/user-operation Schema: -

Usage:

cctl&nbsp;get queryUserOperationEntries [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--before-timestamp`	text	Restrict to entries that were created before the given timestamp. By default, the
timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., 2013-01-23T14:42:45.000+0200.	None
`--after-timestamp`	text	Restrict to entries that were created after the given timestamp. By default, the
timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,
e.g., 2013-01-23T14:42:45.000+0200.	None
`--property`	text	Only include operations that changed this property, e.g., `owner` or `assignee`.	None
`--category-in`	text	Filter by a comma-separated list of categories that this operation is associated with, possible values are
`TaskWorker`, `Admin` or `Operator`.	None
`--category`	text	Filter by the category that this operation is associated with, possible values are
`TaskWorker`, `Admin` or `Operator`.	None
`--entity-type-in`	text	Filter by a comma-separated list of types of the entities that was affected by this operation,
possible values are `Task`, `Attachment` or `IdentityLink`.	None
`--entity-type`	text	Filter by the type of the entity that was affected by this operation, possible values are
`Task`, `Attachment` or `IdentityLink`.	None
`--operation-type`	text	Filter by the type of the operation like `Claim` or `Delegate`. See the
Javadoc
for a list of available operation types.	None
`--operation-id`	text	Filter by the id of the operation. This allows fetching of multiple entries which are part
of a composite operation.	None
`--user-id`	text	Only include operations of this user.	None
`--job-definition-id`	text	Filter by job definition id.	None
`--job-id`	text	Filter by job id.	None
`--batch-id`	text	Only include operations on this batch.	None
`--external-task-id`	text	Only include operations on this external task.	None
`--task-id`	text	Only include operations on this task.	None
`--case-execution-id`	text	Filter by case execution id.	None
`--case-instance-id`	text	Filter by case instance id.	None
`--case-definition-id`	text	Filter by case definition id.	None
`--execution-id`	text	Filter by execution id.	None
`--process-instance-id`	text	Filter by process instance id.	None
`--process-definition-key`	text	Filter by process definition key.	None
`--process-definition-id`	text	Filter by process definition id.	None
`--deployment-id`	text	Filter by deployment id.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get renderedForm¶

Get Rendered Form Retrieves the rendered form for a task. This method can be used to get the HTML rendering of a Generated Task Form. URL: /task/{id}/rendered-form Schema: -

Usage:

cctl&nbsp;get renderedForm [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get renderedStartForm¶

Get Rendered Start Form Retrieves the rendered form for a process definition. This method can be used to get the HTML rendering of a Generated Task Form. URL: /process-definition/{id}/rendered-form Schema: -

Usage:

cctl&nbsp;get renderedStartForm [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get renderedStartFormByKey¶

Get Rendered Start Form Retrieves the rendered form for the latest version of the process definition which belongs to no tenant. This method can be used to get the HTML rendering of a Generated Task Form. URL: /process-definition/key/{key}/rendered-form Schema: -

Usage:

cctl&nbsp;get renderedStartFormByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get renderedStartFormByKeyAndTenantId¶

Get Rendered Start Form Retrieves the rendered form for the latest version of the process definition for a tenant. This method can be used to get the HTML rendering of a Generated Task Form. URL: /process-definition/key/{key}/tenant-id/{tenant-id}/rendered-form Schema: -

Usage:

cctl&nbsp;get renderedStartFormByKeyAndTenantId [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get restAPIVersion¶

Get Rest API version Retrieves the version of the Rest API. URL: /version Schema: -

Usage:

cctl&nbsp;get restAPIVersion [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get schemaLog¶

Get List Queries for schema log entries that fulfill given parameters. URL: /schema/log Schema: -

Usage:

cctl&nbsp;get schemaLog [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--version`	text	Only return schema log entries with a specific version.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get singleFilter¶

Get Single Filter Retrieves a single filter by id, according to the Filter interface in the engine. URL: /filter/{id} Schema: -

Usage:

cctl&nbsp;get singleFilter [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--item-count` / `--not-item-count`	boolean	If set to `true`, each filter result will contain an `itemCount`
property with the number of items matched by the filter itself.	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get stacktrace¶

Get Exception Stacktrace Retrieves the exception stacktrace corresponding to the passed job id. URL: /job/{id}/stacktrace Schema: -

Usage:

cctl&nbsp;get stacktrace [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get stacktraceHistoricJobLog¶

Get Job Log Exception Stacktrace Retrieves the corresponding exception stacktrace to the passed historic job log by id. URL: /history/job-log/{id}/stacktrace Schema: -

Usage:

cctl&nbsp;get stacktraceHistoricJobLog [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get startForm¶

Get Start Form Key Retrieves the key of the start form for a process definition. The form key corresponds to the FormData#formKey property in the engine. URL: /process-definition/{id}/startForm Schema: -

Usage:

cctl&nbsp;get startForm [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get startFormByKey¶

Get Start Form Key Retrieves the key of the start form for the latest version of the process definition which belongs to no tenant. The form key corresponds to the FormData#formKey property in the engine. URL: /process-definition/key/{key}/startForm Schema: -

Usage:

cctl&nbsp;get startFormByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get startFormByKeyAndTenantId¶

Get Start Form Key Retrieves the key of the start form for the latest version of the process definition for a tenant. The form key corresponds to the FormData#formKey property in the engine. URL: /process-definition/key/{key}/tenant-id/{tenant-id}/startForm Schema: -

Usage:

cctl&nbsp;get startFormByKeyAndTenantId [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get startFormVariables¶

Get Start Form Variables Retrieves the start form variables for a process definition (only if they are defined via the Generated Task Form approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account. URL: /process-definition/{id}/form-variables Schema: -

Usage:

cctl&nbsp;get startFormVariables [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that store
custom Java objects) should be deserialized on server side (default true).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get startFormVariablesByKey¶

Get Start Form Variables Retrieves the start form variables for the latest process definition which belongs to no tenant (only if they are defined via the Generated Task Form approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account. URL: /process-definition/key/{key}/form-variables Schema: -

Usage:

cctl&nbsp;get startFormVariablesByKey [OPTIONS] KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that store
custom Java objects) should be deserialized on server side (default true).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get startFormVariablesByKeyAndTenantId¶

Get Start Form Variables Retrieves the start form variables for the latest process definition for a tenant (only if they are defined via the Generated Task Form approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account. URL: /process-definition/key/{key}/tenant-id/{tenant-id}/form-variables Schema: -

Usage:

cctl&nbsp;get startFormVariablesByKeyAndTenantId [OPTIONS] TENANT_ID KEY

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that store
custom Java objects) should be deserialized on server side (default true).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get staticCalledProcessDefinitions¶

Get Static Called Process Definitions For the given process, returns a list of called process definitions corresponding to the CalledProcessDefinition interface in the engine. The list contains all process definitions that are referenced statically by call activities in the given process. This endpoint does not resolve process definitions that are referenced with expressions. Each called process definition contains a list of call activity ids, which specifies the call activities that are calling that process. This endpoint does not resolve references to case definitions. URL: /process-definition/{id}/static-called-process-definitions Schema: -

Usage:

cctl&nbsp;get staticCalledProcessDefinitions [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get task¶

Get Retrieves a task by id. URL: /task/{id} Schema: -

Usage:

cctl&nbsp;get task [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get taskLocalVariable¶

Get Local Task Variable Retrieves a variable from the context of a given task by id. URL: /task/{id}/localVariables/{varName} Schema: -

Usage:

cctl&nbsp;get taskLocalVariable [OPTIONS] VARNAME ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-value` / `--not-deserialize-value`	boolean	Determines whether serializable variable values (typically variables that store custom Java objects)
should be deserialized on the server side (default `true`).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get taskLocalVariableBinary¶

Get Local Task Variable (Binary) Retrieves a binary variable from the context of a given task by id. Applicable for byte array and file variables. URL: /task/{id}/localVariables/{varName}/data Schema: -

Usage:

cctl&nbsp;get taskLocalVariableBinary [OPTIONS] VARNAME ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get taskLocalVariables¶

Get Local Task Variables Retrieves all variables of a given task by id. URL: /task/{id}/localVariables Schema: -

Usage:

cctl&nbsp;get taskLocalVariables [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that store custom Java objects)
should be deserialized on the server side (default `true`).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get taskVariable¶

Get Task Variable Retrieves a variable from the context of a given task. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on visiblity of variables. URL: /task/{id}/variables/{varName} Schema: -

Usage:

cctl&nbsp;get taskVariable [OPTIONS] VARNAME ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-value` / `--not-deserialize-value`	boolean	Determines whether serializable variable values (typically variables that store custom Java objects)
should be deserialized on the server side (default `true`).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get taskVariableBinary¶

Get Task Variable (Binary) Retrieves a binary variable from the context of a given task. Applicable for byte array and file variables. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on visiblity of variables. URL: /task/{id}/variables/{varName}/data Schema: -

Usage:

cctl&nbsp;get taskVariableBinary [OPTIONS] VARNAME ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`-oF`, `--output-file`	filename	output file	None
`-oT`, `--output-template`	text	provide a template name (one of default, result-length) or provide a jinja2 template string that will be used.	None
`-oJ`, `--output-jsonpath`	text	jsonpath template	`$`
`-oCL`, `--output-cell-limit`	integer	limit cell value for table output (default=40)	`40`
`-oH`, `--output-header`	text	comma seperated list of headers	None
`-o`, `--output`	choice (`table` \| `json` \| `jsonpath` \| `template` \| `raw`)	N/A	`table`
`--help`	boolean	Show this message and exit.	`False`

cctl get taskVariables¶

Get Task Variables Retrieves all variables visible from the task. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on visiblity of variables. URL: /task/{id}/variables Schema: -

Usage:

cctl&nbsp;get taskVariables [OPTIONS] ID

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--deserialize-values` / `--not-deserialize-values`	boolean	Determines whether serializable variable values (typically variables that store custom Java objects)
should be deserialized on the server side (default `true`).
If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON
using Jackson's POJO/bean property introspection feature.
Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

cctl get tasks¶

Get List Queries for tasks that fulfill a given filter. The size of the result set can be retrieved by using the Get Task Count method.

Security Consideration: There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on security considerations for custom code in the user guide for details. URL: /task Schema: -

Usage:

cctl&nbsp;get tasks [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--max-results`	text	Pagination of results. Specifies the maximum number of results to return.
Will return less results if there are no more results left.	None
`--first-result`	text	Pagination of results. Specifies the index of the first result to return.	None
`--sort-order`	text	Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter.	None
`--sort-by`	text	Sort the results lexicographically by a given criterion.
Must be used in conjunction with the sortOrder parameter.	None
`--parent-task-id`	text	Restrict query to all tasks that are sub tasks of the given task. Takes a task id.	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match all variable values in this query case-insensitively. If set
`variableValue` and `variablevalue` are treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match all variable names in this query case-insensitively. If set
`variableName` and `variablename` are treated as equal.	None
`--case-instance-variables`	text	Only include tasks that belong to case instances that have variables with certain
values. Variable filtering expressions are comma-separated and are structured as
follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters. | None | | --process-variables | text | Only include tasks that belong to process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like; notLike. key and value may not contain underscore or comma characters. | None | | --task-variables | text | Only include tasks that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

cctl get tasksCount¶

Get List Count Retrieves the number of tasks that fulfill a provided filter. Corresponds to the size of the result set when using the Get Tasks method.

Security Consideration: There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on security considerations for custom code in the user guide for details. URL: /task/count Schema: -

Usage:

cctl&nbsp;get tasksCount [OPTIONS]

Options:

Name	Type	Description	Default
`--traceback`	boolean	do not hide traceback on error	`False`
`--query-extra`	text	extra query parameters, not listed in openapi (format: PARAM=VALUE)	None
`--parent-task-id`	text	Restrict query to all tasks that are sub tasks of the given task. Takes a task id.	None
`--variable-values-ignore-case` / `--not-variable-values-ignore-case`	boolean	Match all variable values in this query case-insensitively. If set
`variableValue` and `variablevalue` are treated as equal.	None
`--variable-names-ignore-case` / `--not-variable-names-ignore-case`	boolean	Match all variable names in this query case-insensitively. If set
`variableName` and `variablename` are treated as equal.	None
`--case-instance-variables`	text	Only include tasks that belong to case instances that have variables with certain
values. Variable filtering expressions are comma-separated and are structured as
follows: