Function: deleteDefaultWorkflow()
function deleteDefaultWorkflow(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, string>;
issueTypes?: Record<string, {
[key: string]: unknown;
avatarId?: number;
description?: string;
entityId?: string;
hierarchyLevel?: number;
iconUrl?: string;
id?: string;
name?: string;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
subtask?: boolean;
untranslatedName?: string;
}>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: string]: unknown;
};
items?: object[];
max-results?: number;
pagingCallback?: {
[key: string]: unknown;
};
size?: number;
};
appType?: string;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
expand?: string;
groups?: {
[key: string]: unknown;
callback?: {
[key: string]: unknown;
};
items?: object[];
max-results?: number;
pagingCallback?: {
[key: string]: unknown;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, string>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Defined in: src/cloud/api/workflowSchemes.ts:331
Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).
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 default workflow reset. The draft workflow scheme can be published in Jira.
Permissions required:Administer Jira global permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { id: number; updateDraftIfNeeded?: boolean; } | - |
parameters.id | number | The ID of the workflow scheme. |
parameters.updateDraftIfNeeded? | boolean | Set 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. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; appType?: string; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, string>; self?: string; updateDraftIfNeeded?: boolean; }>