Skip to main content
Version: 8.9 (unreleased)

Type Alias: DeleteResourceData

type DeleteResourceData = object;

Defined in: gen/types.gen.ts:14462

Properties​

body?​

optional body:
  | {
  deleteHistory?: boolean;
  operationReference?: OperationReference;
}
  | null;

Defined in: gen/types.gen.ts:14463

Type Declaration​

{
  deleteHistory?: boolean;
  operationReference?: OperationReference;
}

deleteHistory?​

optional deleteHistory: boolean;

Indicates if the historic data of a process resource should be deleted via a batch operation asynchronously.

This flag is only effective for process resources. For other resource types (decisions, forms, generic resources), this flag is ignored and no history will be deleted. In those cases, the batchOperation field in the response will not be populated.

operationReference?​

optional operationReference: OperationReference;

null

path​

path: object;

Defined in: gen/types.gen.ts:14477

resourceKey​

resourceKey: ResourceKey;

The key of the resource to delete. This can be the key of a process definition, the key of a decision requirements definition or the key of a form definition

query?​

optional query: never;

Defined in: gen/types.gen.ts:14486

url​

url: "/resources/{resourceKey}/deletion";

Defined in: gen/types.gen.ts:14487