---
title: "Get required status mappings for workflow scheme update"
method: POST
path: "/rest/api/3/workflowscheme/update/mappings"
tags: ["Workflow schemes"]
---

# Get required status mappings for workflow scheme update

`POST /rest/api/3/workflowscheme/update/mappings`

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](#permissions) required:**

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

## Request body

- WorkflowSchemeUpdateRequiredMappingsRequest — The request payload to get the required mappings for updating a workflow scheme.
  - `defaultWorkflowId` string, nullable — The 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)*.
  - `id` string, required — The ID of the workflow scheme.
  - `workflowsForIssueTypes` WorkflowSchemeAssociation[], required — The new workflow to issue type mappings for this workflow scheme.
    - `issueTypeIds` string[], required — The issue types assigned to the workflow.
    - `workflowId` string, required — The ID of the workflow.

## Response `200`

Returned if the request is successful.

- WorkflowSchemeUpdateRequiredMappingsResponse
  - `statusMappingsByIssueTypes` RequiredMappingByIssueType[] — The list of required status mappings by issue type.
    - `issueTypeId` string — The ID of the issue type.
    - `statusIds` string[] — The status IDs requiring mapping.
  - `statusMappingsByWorkflows` RequiredMappingByWorkflows[] — The list of required status mappings by workflow.
    - `sourceWorkflowId` string — The ID of the source workflow.
    - `statusIds` string[] — The status IDs requiring mapping.
    - `targetWorkflowId` string — The ID of the target workflow.
  - `statuses` StatusMetadata[] — The details of the statuses in the associated workflows.
    - `category` 'TODO' | 'IN_PROGRESS' | 'DONE' — The category of the status.
    - `id` string — The ID of the status.
    - `name` string — The name of the status.
  - `statusesPerWorkflow` StatusesPerWorkflow[] — The statuses associated with each workflow.
    - `initialStatusId` string — The ID of the initial status for the workflow.
    - `statuses` string[] — The status IDs associated with the workflow.
    - `workflowId` string — The ID of the workflow.

## Other responses

- `400` — Returned if the request is not valid.
- `401` — Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.

---

[API](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api-3.md) · [All operations](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-3/revisions/2783f5d3849c/schema)