Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Server

Jira Data Center / Reference / REST API

workflowscheme

Operations

POST

Create a new workflow scheme

Create a new workflow scheme. The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.

Request

Request bodyapplication/json

The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.

defaultWorkflow

string

description

string

draft

boolean

integer

issueTypeMappings

object

issueTypes

object

lastModified

string

lastModifiedUser

UserBean

name

string

originalDefaultWorkflow

string

Responses

The newly created scheme.

POST/api/2/workflowscheme

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/2/workflowscheme' \
  --header 'Content-Type: application/json'

GET

Get requested workflow scheme by ID

Returns the requested workflow scheme to the caller.

Request

Path parameters

integer

Required

Query parameters

returnDraftIfExists

boolean

Responses

Returned if the scheme exists and the caller has permission to see it.

application/json

WorkflowSchemeBean

GET/api/2/workflowscheme/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}' \
  --header 'Accept: application/json'

PUT

Update a specified workflow scheme

Update the passed workflow scheme. The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created and/or updated when the actual scheme cannot be edited (e.g. when the scheme is being used by a project). Values not appearing the body will not be touched.

Request

Path parameters

integer

Required

Request bodyapplication/json

The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.

defaultWorkflow

string

description

string

draft

boolean

integer

issueTypeMappings

object

issueTypes

object

lastModified

string

lastModifiedUser

UserBean

name

string

originalDefaultWorkflow

string

Responses

The updated scheme.

application/json

WorkflowSchemeBean

PUT/api/2/workflowscheme/{id}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

DEL

Delete the specified workflow scheme

Delete the passed workflow scheme.

Request

Path parameters

integer

Required

Responses

If the scheme was deleted.

DEL/api/2/workflowscheme/{id}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}'

POST

Create a draft for a workflow scheme

Create a draft for the passed scheme. The draft will be a copy of the state of the parent.

Request

Path parameters

integer

Required

Responses

The newly created scheme.

application/json

WorkflowSchemeBean

POST/api/2/workflowscheme/{id}/createdraft

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/createdraft' \
  --header 'Accept: application/json'

GET

Get default workflow for a scheme

Return the default workflow from the passed workflow scheme.

Request

Path parameters

integer

Required

Query parameters

returnDraftIfExists

boolean

Responses

Returned on success.

application/json

WorkflowSchemeBean

GET/api/2/workflowscheme/{id}/default

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/default' \
  --header 'Accept: application/json'

PUT

Update default workflow for a scheme

Set the default workflow for the passed workflow scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Request

Path parameters

integer

Required

Request bodyapplication/json

The new default.

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned on success.

application/json

WorkflowSchemeBean

PUT/api/2/workflowscheme/{id}/default

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/default' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

DEL

Remove default workflow from a scheme

Remove the default workflow from the passed workflow scheme.

Request

Path parameters

integer

Required

Query parameters

updateDraftIfNeeded

boolean

Responses

Returned on success.

application/json

WorkflowSchemeBean

DEL/api/2/workflowscheme/{id}/default

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/default' \
  --header 'Accept: application/json'

GET

Get requested draft workflow scheme by ID

Returns the requested draft workflow scheme to the caller.

Request

Path parameters

integer

Required

Responses

Returned if the scheme exists and the caller has permission to see it.

application/json

WorkflowSchemeBean

GET/api/2/workflowscheme/{id}/draft

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft' \
  --header 'Accept: application/json'

PUT

Update a draft workflow scheme

Update a draft workflow scheme. The draft will created if necessary. The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.

Request

Path parameters

integer

Required

Request bodyapplication/json

The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.

defaultWorkflow

string

description

string

draft

boolean

integer

issueTypeMappings

object

issueTypes

object

lastModified

string

lastModifiedUser

UserBean

name

string

originalDefaultWorkflow

string

Responses

The updated/created scheme.

application/json

WorkflowSchemeBean

PUT/api/2/workflowscheme/{id}/draft

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

DEL

Delete the specified draft workflow scheme

Delete the passed draft workflow scheme.

Request

Path parameters

integer

Required

Responses

If the scheme was deleted.

DEL/api/2/workflowscheme/{id}/draft

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft'

GET

Get default workflow for a draft scheme

Return the default workflow from the passed draft workflow scheme to the caller.

Request

Path parameters

integer

Required

Responses

Returned on success.

application/json

WorkflowSchemeBean

GET/api/2/workflowscheme/{id}/draft/default

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/default' \
  --header 'Accept: application/json'

PUT

Update default workflow for a draft scheme

Set the default workflow for the passed draft workflow scheme.

Request

Path parameters

integer

Required

Request bodyapplication/json

The new default.

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned on success.

application/json

WorkflowSchemeBean

PUT/api/2/workflowscheme/{id}/draft/default

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/default' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

DEL

Remove default workflow from a draft scheme

Remove the default workflow from the passed draft workflow scheme.

Request

Path parameters

integer

Required

Responses

Returned on success.

application/json

WorkflowSchemeBean

DEL/api/2/workflowscheme/{id}/draft/default

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/default' \
  --header 'Accept: application/json'

GET

Get issue type mapping for a draft scheme

Returns the issue type mapping for the passed draft workflow scheme.

Request

Path parameters

issueType

string

Required

integer

Required

Responses

Returned on success.

application/json

IssueTypeMappingBean

GET/api/2/workflowscheme/{id}/draft/issuetype/{issueType}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/issuetype/{issueType}' \
  --header 'Accept: application/json'

PUT

Set an issue type mapping for a draft scheme

Set the issue type mapping for the passed draft scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Request

Path parameters

issueType

string

Required

integer

Required

Request bodyapplication/json

The new mapping for the issue type.

issueType

string

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned on success.

application/json

WorkflowSchemeBean

PUT/api/2/workflowscheme/{id}/draft/issuetype/{issueType}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/issuetype/{issueType}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

DEL

Delete an issue type mapping from a draft scheme

Remove the specified issue type mapping from the draft scheme.

Request

Path parameters

issueType

string

Required

integer

Required

Responses

Returned on success.

application/json

WorkflowSchemeBean

DEL/api/2/workflowscheme/{id}/draft/issuetype/{issueType}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/issuetype/{issueType}' \
  --header 'Accept: application/json'

GET

Get draft workflow mappings

Returns the draft workflow mappings or requested mapping to the caller.

Request

Path parameters

integer

Required

Query parameters

workflowName

string

Responses

Returned on success.

application/json

WorkflowSchemeBean

GET/api/2/workflowscheme/{id}/draft/workflow

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/workflow' \
  --header 'Accept: application/json'

PUT

Update a workflow mapping in a draft scheme

Update the draft scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field.

Request

Path parameters

integer

Required

Query parameters

workflowName

string

Request bodyapplication/json

The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field.

defaultMapping

boolean

issueTypes

array<string>

updateDraftIfNeeded

boolean

workflow

string

Responses

The updated scheme.

application/json

WorkflowSchemeBean

PUT/api/2/workflowscheme/{id}/draft/workflow

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/workflow' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

DEL

Delete a workflow mapping from a draft scheme

Delete the passed workflow from the draft workflow scheme.

Request

Path parameters

integer

Required

Query parameters

workflowName

string

Responses

The scheme with the workflow deleted.

application/json

WorkflowSchemeBean

DEL/api/2/workflowscheme/{id}/draft/workflow

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/workflow' \
  --header 'Accept: application/json'

GET

Get issue type mapping for a scheme

Returns the issue type mapping for the passed workflow scheme.

Request

Path parameters

issueType

string

Required

integer

Required

Query parameters

returnDraftIfExists

boolean

Responses

Returned on success.

application/json

IssueTypeMappingBean

GET/api/2/workflowscheme/{id}/issuetype/{issueType}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/issuetype/{issueType}' \
  --header 'Accept: application/json'

PUT

Set an issue type mapping for a scheme

Set the issue type mapping for the passed scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Request

Path parameters

issueType

string

Required

integer

Required

Request bodyapplication/json

The new mapping for the issue type.

issueType

string

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned on success.

application/json

WorkflowSchemeBean

PUT/api/2/workflowscheme/{id}/issuetype/{issueType}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/issuetype/{issueType}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

DEL

Delete an issue type mapping from a scheme

Remove the specified issue type mapping from the scheme.

Request

Path parameters

issueType

string

Required

integer

Required

Query parameters

updateDraftIfNeeded

boolean

Responses

Returned on success.

application/json

WorkflowSchemeBean

DEL/api/2/workflowscheme/{id}/issuetype/{issueType}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/issuetype/{issueType}' \
  --header 'Accept: application/json'

GET

Get workflow mappings for a scheme

Returns the workflow mappings or requested mapping to the caller for the passed scheme.

Request

Path parameters

integer

Required

Query parameters

workflowName

string

returnDraftIfExists

boolean

Responses

Returned on success.

application/json

WorkflowSchemeBean

GET/api/2/workflowscheme/{id}/workflow

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/workflow' \
  --header 'Accept: application/json'

PUT

Update a workflow mapping in a scheme

Update the scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Request

Path parameters

integer

Required

Query parameters

workflowName

string

Request bodyapplication/json

The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field.

defaultMapping

boolean

issueTypes

array<string>

updateDraftIfNeeded

boolean

workflow

string

Responses

The updated scheme.

application/json

WorkflowSchemeBean

PUT/api/2/workflowscheme/{id}/workflow

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/workflow' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

DEL

Delete a workflow mapping from a scheme

Delete the passed workflow from the workflow scheme.

Request

Path parameters

integer

Required

Query parameters

updateDraftIfNeeded

boolean

workflowName

string

Responses

The scheme with the workflow deleted.

application/json

WorkflowSchemeBean

DEL/api/2/workflowscheme/{id}/workflow

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/workflow' \
  --header 'Accept: application/json'