jira.js
    Preparing search index...

    Function validateCreateWorkflows

    • Validate the payload for bulk create workflows.

      Permissions required:

      • Administer Jira project permission to create all, including global-scoped, workflows
      • Administer projects project permissions to create project-scoped workflows

      Parameters

      • client: Client
      • parameters: {
            payload: {
                scope?: {
                    project?: { id: string; [key: string]: unknown };
                    type?: string & {} | "PROJECT" | "GLOBAL";
                    [key: string]: unknown;
                };
                statuses?: {
                    description?: string;
                    id?: string;
                    name: string;
                    statusCategory: string & {}
                    | "TODO"
                    | "IN_PROGRESS"
                    | "DONE";
                    statusReference: string;
                    [key: string]: unknown;
                }[];
                workflows?: {
                    description?: string;
                    loopedTransitionContainerLayout?: {
                        x?: number;
                        y?: number;
                        [key: string]: unknown;
                    };
                    name: string;
                    startPointLayout?: { x?: number; y?: number; [key: string]: unknown };
                    statuses: {
                        approvalConfiguration?: {
                            active: "false" | "true" | (...) & (...);
                            conditionType:
                                | "number"
                                | "percent"
                                | (...) & (...)
                                | "numberPerPrincipal";
                            conditionValue: string;
                            exclude?: (...)[] | null;
                            fieldId: string;
                            prePopulatedFieldId?: string | null;
                            transitionApproved: string;
                            transitionRejected: string;
                            [key: string]: unknown;
                        };
                        layout?: { x?: number; y?: number; [key: string]: unknown };
                        properties: Record<string, any>;
                        statusReference: string;
                        [key: string]: unknown;
                    }[];
                    transitions: {
                        actions?: {
                            id?: (...)
                            | (...)
                            | (...);
                            parameters?: (...) | (...);
                            ruleKey: string;
                            [key: string]: unknown;
                        }[];
                        conditions?: unknown;
                        customIssueEventId?: string;
                        description?: string;
                        id?: string;
                        links?: {
                            fromPort?: (...)
                            | (...)
                            | (...);
                            fromStatusReference?: (...) | (...) | (...);
                            toPort?: (...) | (...) | (...);
                            [key: string]: unknown;
                        }[];
                        name?: string;
                        properties?: Record<string, any>;
                        toStatusReference?: string;
                        transitionScreen?: {
                            id?: string | null;
                            parameters?: Record<(...), (...)>;
                            ruleKey: string;
                            [key: string]: unknown;
                        };
                        triggers?: {
                            id?: (...)
                            | (...);
                            parameters: Record<(...), (...)>;
                            ruleKey: string;
                            [key: string]: unknown;
                        }[];
                        type?: string & {}
                        | "GLOBAL"
                        | "INITIAL"
                        | "DIRECTED";
                        validators?: {
                            id?: (...) | (...) | (...);
                            parameters?: (...) | (...);
                            ruleKey: string;
                            [key: string]: unknown;
                        }[];
                        [key: string]: unknown;
                    }[];
                    [key: string]: unknown;
                }[];
                [key: string]: unknown;
            };
            validationOptions?: {
                levels?: (string & {} | "WARNING" | "ERROR")[];
                [key: string]: unknown;
            };
        }
      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              errors?: {
                  additionalDetails?: string;
                  code?: string;
                  elementReference?: {
                      propertyKey?: string;
                      ruleId?: string;
                      statusMappingReference?: {
                          issueTypeId: string;
                          projectId: string;
                          [key: string]: unknown;
                      };
                      statusReference?: string;
                      transitionId?: string;
                      [key: string]: unknown;
                  };
                  level?: string & {}
                  | "WARNING"
                  | "ERROR";
                  message?: string;
                  type?:
                      | string & {}
                      | "RULE"
                      | "STATUS"
                      | "STATUS_LAYOUT"
                      | "STATUS_PROPERTY"
                      | "WORKFLOW"
                      | "TRANSITION"
                      | "TRANSITION_PROPERTY"
                      | "SCOPE"
                      | "STATUS_MAPPING"
                      | "TRIGGER";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility