Skip to content

Function: validateCreateWorkflows() ​

ts
function validateCreateWorkflows(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  errors?: object[];
}>;

Defined in: src/cloud/api/workflows.ts:910

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 ​

ParameterTypeDescription
clientClient-
parameters{ payload: { scope?: { project?: { id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }; statuses?: object[]; workflows?: object[]; }; validationOptions?: { levels?: (string & object | "WARNING" | "ERROR")[]; }; }-
parameters.payload{ scope?: { project?: { id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }; statuses?: object[]; workflows?: object[]; }-
parameters.payload.scope?{ project?: { id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }-
parameters.payload.scope.project?{ id: string; }-
parameters.payload.scope.project.id?stringThe ID of the project.
parameters.payload.scope.type?string & object | "PROJECT" | "GLOBAL"The scope of the workflow. GLOBAL for company-managed projects and PROJECT for team-managed projects.
parameters.payload.statuses?object[]The statuses to associate with the workflows.
parameters.payload.workflows?object[]The details of the workflows to create.
parameters.validationOptions?{ levels?: (string & object | "WARNING" | "ERROR")[]; }-
parameters.validationOptions.levels?(string & object | "WARNING" | "ERROR")[]-
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; errors?: object[]; }>