@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias DeleteResourceData

    type DeleteResourceData = {
        body?:
            | { deleteHistory?: boolean; operationReference?: OperationReference }
            | null;
        path: { resourceKey: ResourceKey };
        query?: never;
        url: "/resources/{resourceKey}/deletion";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

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

    Type Declaration

    • { deleteHistory?: boolean; operationReference?: OperationReference }
      • OptionaldeleteHistory?: 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.

      • OptionaloperationReference?: OperationReference
    • null
    path: { resourceKey: ResourceKey }

    Type Declaration

    • 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?: never
    url: "/resources/{resourceKey}/deletion"

    Settings

    Member Visibility

    On This Page

    Properties