Skip to content

Function: getRequiredWorkflowSchemeMappings() ​

ts
function getRequiredWorkflowSchemeMappings(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  statuses?: object[];
  statusesPerWorkflow?: object[];
  statusMappingsByIssueTypes?: object[];
  statusMappingsByWorkflows?: object[];
}>;

Defined in: src/cloud/api/workflowSchemes.ts:176

Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both.

Permissions required:

  • Administer Jira permission to update all, including global-scoped, workflow schemes.
  • Administer projects project permission to update project-scoped workflow schemes.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ defaultWorkflowId?: string | null; id: string; workflowsForIssueTypes: object[]; }-
parameters.defaultWorkflowId?string | nullThe ID of the new default workflow for this workflow scheme. Only used in global-scoped workflow schemes. If it isn't specified, is set to Jira Workflow (jira).
parameters.id?stringThe ID of the workflow scheme.
parameters.workflowsForIssueTypes?object[]The new workflow to issue type mappings for this workflow scheme.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; statuses?: object[]; statusesPerWorkflow?: object[]; statusMappingsByIssueTypes?: object[]; statusMappingsByWorkflows?: object[]; }>