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

    Type Alias GetUserTaskResponses

    type GetUserTaskResponses = {
        "200": {
            assignee?: string;
            candidateGroups?: string[];
            candidateUsers?: string[];
            completionDate?: string;
            creationDate?: string;
            customHeaders?: { [key: string]: string };
            dueDate?: string;
            elementId?: ElementId;
            elementInstanceKey?: ElementInstanceKey;
            externalFormReference?: string;
            followUpDate?: string;
            formKey?: FormKey;
            name?: string;
            priority?: number;
            processDefinitionId?: ProcessDefinitionId;
            processDefinitionKey?: ProcessDefinitionKey;
            processDefinitionVersion?: number;
            processInstanceKey?: ProcessInstanceKey;
            processName?: string;
            state?: UserTaskStateEnum;
            tags?: TagSet;
            tenantId?: TenantId;
            userTaskKey?: UserTaskKey;
        };
    }
    Index

    Properties

    200

    Properties

    "200": {
        assignee?: string;
        candidateGroups?: string[];
        candidateUsers?: string[];
        completionDate?: string;
        creationDate?: string;
        customHeaders?: { [key: string]: string };
        dueDate?: string;
        elementId?: ElementId;
        elementInstanceKey?: ElementInstanceKey;
        externalFormReference?: string;
        followUpDate?: string;
        formKey?: FormKey;
        name?: string;
        priority?: number;
        processDefinitionId?: ProcessDefinitionId;
        processDefinitionKey?: ProcessDefinitionKey;
        processDefinitionVersion?: number;
        processInstanceKey?: ProcessInstanceKey;
        processName?: string;
        state?: UserTaskStateEnum;
        tags?: TagSet;
        tenantId?: TenantId;
        userTaskKey?: UserTaskKey;
    }

    The user task is successfully returned.

    Type Declaration

    • Optionalassignee?: string

      The assignee of the user task.

    • OptionalcandidateGroups?: string[]

      The candidate groups for this user task.

    • OptionalcandidateUsers?: string[]

      The candidate users for this user task.

    • OptionalcompletionDate?: string

      The completion date of a user task.

    • OptionalcreationDate?: string

      The creation date of a user task.

    • OptionalcustomHeaders?: { [key: string]: string }

      Custom headers for the user task.

    • OptionaldueDate?: string

      The due date of a user task.

    • OptionalelementId?: ElementId

      The element ID of the user task.

    • OptionalelementInstanceKey?: ElementInstanceKey

      The key of the element instance.

    • OptionalexternalFormReference?: string

      The external form reference.

    • OptionalfollowUpDate?: string

      The follow date of a user task.

    • OptionalformKey?: FormKey

      The key of the form.

    • Optionalname?: string

      The name for this user task.

    • Optionalpriority?: number

      The priority of a user task. The higher the value the higher the priority.

    • OptionalprocessDefinitionId?: ProcessDefinitionId

      The ID of the process definition.

    • OptionalprocessDefinitionKey?: ProcessDefinitionKey

      The key of the process definition.

    • OptionalprocessDefinitionVersion?: number

      The version of the process definition.

    • OptionalprocessInstanceKey?: ProcessInstanceKey

      The key of the process instance.

    • OptionalprocessName?: string

      The name of the process definition.

    • Optionalstate?: UserTaskStateEnum
    • Optionaltags?: TagSet
    • OptionaltenantId?: TenantId
    • OptionaluserTaskKey?: UserTaskKey

      The key of the user task.

    Settings

    Member Visibility

    On This Page

    Properties