Function getWorkflow

getWorkflow(
    client: Client,
    parameters: {
        id: number;
        returnDraftIfExists?: boolean;
        workflowName?: string;
    },
    options?: RequestOptions,
): Promise<
    | {
        defaultMapping?: boolean;
        issueTypes?: string[];
        updateDraftIfNeeded?: boolean;
        workflow?: string;
        [key: string]: unknown;
    }
    | {
        defaultMapping?: boolean;
        issueTypes?: string[];
        updateDraftIfNeeded?: boolean;
        workflow?: string;
        [key: string]: unknown;
    }[],
>
Returns the workflow mappings or requested mapping to the caller for the passed scheme.
Parameters
- client: Client
- parameters: { id: number; returnDraftIfExists?: boolean; workflowName?: string }
  - id: number
    
    The id of the scheme.
  - OptionalreturnDraftIfExists?: boolean
    
    When true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
  - OptionalworkflowName?: string
    
    The workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name.
- Optionaloptions: RequestOptions
Returns Promise<
    | {
        defaultMapping?: boolean;
        issueTypes?: string[];
        updateDraftIfNeeded?: boolean;
        workflow?: string;
        [key: string]: unknown;
    }
    | {
        defaultMapping?: boolean;
        issueTypes?: string[];
        updateDraftIfNeeded?: boolean;
        workflow?: string;
        [key: string]: unknown;
    }[],
>
- Defined in src/server/api/workflowSchemes.ts:471

Function getWorkflow

Parameters

id: number

`Optional`returnDraftIfExists?: boolean

`Optional`workflowName?: string

Settings

Function getWorkflow

Parameters

id: number

OptionalreturnDraftIfExists?: boolean

OptionalworkflowName?: string

Returns Promise< | { defaultMapping?: boolean; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; [key: string]: unknown; } | { defaultMapping?: boolean; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; [key: string]: unknown; }[],>

Settings

`Optional`returnDraftIfExists?: boolean

`Optional`workflowName?: string

Returns Promise<
| {
defaultMapping?: boolean;
issueTypes?: string[];
updateDraftIfNeeded?: boolean;
workflow?: string;
[key: string]: unknown;
}
| {
defaultMapping?: boolean;
issueTypes?: string[];
updateDraftIfNeeded?: boolean;
workflow?: string;
[key: string]: unknown;
}[],
>