Create issue - JIRA 7.6.1

Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.

The content of the issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata. These are the same fields that appear on the issue's create screen. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don't handle Atlassian Document Format content.

Creating a subtask differs from creating an issue as follows:

issueType must be set to a subtask issue type (use Get create issue metadata to find subtask issue types).

parent must contain the ID or key of the parent issue.

In a next-gen project any issue may be made a child providing that the parent and child are members of the same project.

Permissions required: Browse projects and Create issues project permissions for the project in which the issue or subtask is created.

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/issue' \ --header 'Content-Type: application/json' \ --data-raw '{ "fields": { "assignee": { "id": "5b109f2e9729b51b54dc274d" }, "components": [ { "id": "10000" } ], "customfield_10000": "09/Jun/19", "customfield_20000": "06/Jul/19 3:25 PM", "customfield_30000": [ "10000", "10002" ], "customfield_40000": { "content": [ { "content": [ { "text": "Occurs on all orders", "type": "text" } ], "type": "paragraph" } ], "type": "doc", "version": 1 }, "customfield_50000": { "content": [ { "content": [ { "text": "Could impact day-to-day work.", "type": "text" } ], "type": "paragraph" } ], "type": "doc", "version": 1 }, "customfield_60000": "jira-software-users", "customfield_70000": [ "jira-administrators", "jira-software-users" ], "customfield_80000": { "value": "red" }, "description": { "content": [ { "content": [ { "text": "Order entry fails when selecting supplier.", "type": "text" } ], "type": "paragraph" } ], "type": "doc", "version": 1 }, "duedate": "2019-05-11", "environment": { "content": [ { "content": [ { "text": "UAT", "type": "text" } ], "type": "paragraph" } ], "type": "doc", "version": 1 }, "fixVersions": [ { "id": "10001" } ], "issuetype": { "id": "10000" }, "labels": [ "bugfix", "blitz_test" ], "parent": { "key": "PROJ-123" }, "priority": { "id": "20000" }, "project": { "id": "10000" }, "reporter": { "id": "5b10a2844c20165700ede21g" }, "security": { "id": "10000" }, "summary": "Main order flow broken", "timetracking": { "originalEstimate": "10", "remainingEstimate": "5" }, "versions": [ { "id": "10000" } ] }, "update": {} }'

{ "id": "10000", "key": "ED-24", "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000", "transition": { "status": 200, "errorCollection": { "errorMessages": [], "errors": {} } } }

Request

Query Params

updateHistory

string

optional

Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen.

Body Params application/json

Details of an issue update request.

fields

object

optional

List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update.

Additional properties

integer | number | string | boolean

optional

historyMetadata

object

optional

Additional issue history details.

activityDescription

string

optional

The activity described in the history record.

activityDescriptionKey

string

optional

The key of the activity described in the history record.

actor

object

optional

Details of the user whose action created the history record.

cause

object

optional

Details of the cause that triggered the creation the history record.

description

string

optional

The description of the history record.

descriptionKey

string

optional

The description key of the history record.

emailDescription

string

optional

The description of the email address associated the history record.

emailDescriptionKey

string

optional

The description key of the email address associated the history record.

extraData

object

optional

Additional arbitrary information about the history record.

generator

object

optional

Details of the system that generated the history record.

type

string

optional

The type of the history record.

Additional properties

integer | number | string | boolean

optional

properties

array[object (EntityProperty) {2}]

optional

Details of issue properties to be add or update.

key

string

optional

The key of the property. Required on create and update.

value

optional

The value of the property. Required on create and update.

transition

object

optional

Details of a transition. Required when performing a transition, optional when creating or editing an issue.

string

optional

The ID of the issue transition. Required when specifying a transition to undertake.

looped

boolean

optional

Additional properties

integer | number | string | boolean

optional

update

object

optional

A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.

Additional properties

array[object (FieldUpdateOperation) {5}]

optional

Additional properties

integer | number | string | boolean

optional

Examples

Responses

🟢201Returned if the request is successful.

application/json

Body

Details about a created issue or subtask.

string

read-onlyoptional

The ID of the created issue or subtask.

key

string

read-onlyoptional

The key of the created issue or subtask.

self

string

read-onlyoptional

The URL of the created issue or subtask.

transition

object

read-onlyoptional

The response code and messages related to any requested transition.

errorCollection

object

ErrorCollection

optional

Error messages from an operation.

status

integer <int32>

optional

warningCollection

object

WarningCollection

optional

watchers

object

read-onlyoptional

The response code and messages related to any requested watchers.

errorCollection

object

ErrorCollection

optional

Error messages from an operation.

status

integer <int32>

optional

warningCollection

object

WarningCollection

optional

🟠400Returned if the request: * is missing required fields. * contains invalid field values. * contains fields that cannot be set for the issue type. * is by a user who does not have the necessary permission. * is to create a subtype in a project di

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the necessary permission.