Get create issue metadata

GET

/rest/api/3/issue/createmeta

Issues

Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in Create issue and Create issues.

The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors.

This operation can be accessed anonymously.

Permissions required: Create issues project permission in the requested projects.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/issue/createmeta'

Response Example

200 - Success

{
  "projects": [
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/project/ED",
      "id": "10000",
      "key": "ED",
      "name": "Edison Project",
      "avatarUrls": {
        "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
        "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
        "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011",
        "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011"
      },
      "issuetypes": [
        {
          "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
          "id": "1",
          "description": "An error in the code",
          "iconUrl": "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
          "name": "Bug",
          "subtask": false,
          "fields": {
            "issuetype": {
              "required": true,
              "name": "Issue Type",
              "key": "issuetype",
              "hasDefaultValue": false,
              "operations": [
                "set"
              ]
            }
          }
        }
      ]
    }
  ]
}

Request

Query Params

projectIds

array[string]

optional

List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example, projectIds=10000,10001&projectIds=10020,10021. This parameter may be provided with projectKeys.

projectKeys

array[string]

optional

List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example, projectKeys=proj1,proj2&projectKeys=proj3. This parameter may be provided with projectIds.

issuetypeIds

array[string]

optional

List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example, issuetypeIds=10000,10001&issuetypeIds=10020,10021. This parameter may be provided with issuetypeNames.

issuetypeNames

array[string]

optional

List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example, issuetypeNames=name1,name2&issuetypeNames=name3. This parameter may be provided with issuetypeIds.

expand

string

optional

Use expand to include additional information about issue metadata in the response. This parameter accepts projects.issuetypes.fields, which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate the fields and update fields in Create issue and Create issues.

Responses

🟢200Returned if the request is successful.

application/json

Body

The wrapper for the issue creation metadata for a list of projects.

expand

string

read-onlyoptional

Expand options that include additional project details in the response.

projects

array[object (ProjectIssueCreateMetadata) {7}]

read-onlyoptional

List of projects and their issue creation metadata.

avatarUrls

object

read-onlyoptional

List of the project's avatars, returning the avatar size and associated URL.

expand

string

read-onlyoptional

Expand options that include additional project issue create metadata details in the response.

string

read-onlyoptional

The ID of the project.

issuetypes

array[object (IssueTypeIssueCreateMetadata) {12}]

read-onlyoptional

List of the issue types supported by the project.

key

string

read-onlyoptional

The key of the project.

name

string

read-onlyoptional

The name of the project.

self

string

read-onlyoptional

The URL of the project.

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

Modified at 2023-07-13 03:27:27

Bulk create issue

Get issue