Interface WorkflowSchemeUpdateRequest

The update workflow scheme payload.

interface WorkflowSchemeUpdateRequest {
    defaultWorkflowId?: string;
    description: string;
    id: string;
    name: string;
    statusMappingsByIssueTypeOverride?: MappingsByIssueTypeOverride[];
    statusMappingsByWorkflows?: MappingsByWorkflow[];
    version: DocumentVersion;
    workflowsForIssueTypes?: WorkflowSchemeAssociation[];
}

Hierarchy

  • Record<string, unknown>
    • WorkflowSchemeUpdateRequest

Properties

defaultWorkflowId? description id name statusMappingsByIssueTypeOverride? statusMappingsByWorkflows? version workflowsForIssueTypes?

Properties

OptionaldefaultWorkflowId

defaultWorkflowId?: string

The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the defaultWorkflowId isn't specified, this is set to Jira Workflow (jira).

description

description: string

The new description for this workflow scheme.

id

id: string

The ID of this workflow scheme.

name

name: string

The new name for this workflow scheme.

OptionalstatusMappingsByIssueTypeOverride

statusMappingsByIssueTypeOverride?: MappingsByIssueTypeOverride[]

Overrides, for the selected issue types, any status mappings provided in statusMappingsByWorkflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of statusMappingsByWorkflows and statusMappingsByIssueTypeOverride.

OptionalstatusMappingsByWorkflows

statusMappingsByWorkflows?: MappingsByWorkflow[]

The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of statusMappingsByWorkflows and statusMappingsByIssueTypeOverride.

version

version: DocumentVersion

The current version details of this workflow scheme.

OptionalworkflowsForIssueTypes

workflowsForIssueTypes?: WorkflowSchemeAssociation[]

Mappings from workflows to issue types.

Settings

Member Visibility

On This Page

Properties