Skip to content

Function: deleteWorkflowMapping() ​

ts
function deleteWorkflowMapping(
   client, 
   parameters, 
   options?
): Promise<void>;

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

Deletes the workflow-issue type mapping for a workflow in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required:Administer Jira global permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ id: number; updateDraftIfNeeded?: boolean; workflowName: string; }-
parameters.idnumberThe ID of the workflow scheme.
parameters.updateDraftIfNeeded?booleanSet to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false.
parameters.workflowName?stringThe name of the workflow.
options?RequestOptions-

Returns ​

Promise<void>