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

    Type Alias MigrateProcessInstanceData

    type MigrateProcessInstanceData = {
        body: {
            mappingInstructions: {
                sourceElementId: ElementId;
                targetElementId: ElementId;
            }[];
            operationReference?: OperationReference;
            targetProcessDefinitionKey: ProcessDefinitionKey;
        };
        path: { processInstanceKey: ProcessInstanceKey };
        query?: never;
        url: "/process-instances/{processInstanceKey}/migration";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        mappingInstructions: {
            sourceElementId: ElementId;
            targetElementId: ElementId;
        }[];
        operationReference?: OperationReference;
        targetProcessDefinitionKey: ProcessDefinitionKey;
    }

    The migration instructions describe how to migrate a process instance from one process definition to another.

    Type Declaration

    • mappingInstructions: { sourceElementId: ElementId; targetElementId: ElementId }[]

      Element mappings from the source process instance to the target process instance.

    • OptionaloperationReference?: OperationReference
    • targetProcessDefinitionKey: ProcessDefinitionKey

      The key of process definition to migrate the process instance to.

    path: { processInstanceKey: ProcessInstanceKey }

    Type Declaration

    • processInstanceKey: ProcessInstanceKey

      The key of the process instance that should be migrated.

    query?: never
    url: "/process-instances/{processInstanceKey}/migration"

    Settings

    Member Visibility

    On This Page

    Properties