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

    Type Alias GetStartProcessFormResponses

    type GetStartProcessFormResponses = {
        "200": {
            formId?: FormId;
            formKey?: FormKey;
            schema?: { [key: string]: unknown };
            tenantId?: TenantId;
            version?: number;
        };
        "204": void;
    }
    Index

    Properties

    200 204

    Properties

    "200": {
        formId?: FormId;
        formKey?: FormKey;
        schema?: { [key: string]: unknown };
        tenantId?: TenantId;
        version?: number;
    }

    The form is successfully returned.

    Type Declaration

    • OptionalformId?: FormId

      The user-provided identifier of the form.

    • OptionalformKey?: FormKey

      The assigned key, which acts as a unique identifier for this form.

    • Optionalschema?: { [key: string]: unknown }

      The form content.

    • OptionaltenantId?: TenantId

      The tenant ID of the form.

    • Optionalversion?: number

      The version of the the deployed form.

    "204": void

    The process was found, but no form is associated with it.

    Settings

    Member Visibility

    On This Page

    Properties