Project templates

Postman Collection

OpenAPI

This resource represents project templates. Use it to create a new project from a custom template.

Operations

POST/rest/api/2/project-template

POST

Create custom projectExperimental

Creates a project based on a custom template provided in the request.

The request body should contain the project details and the capabilities that comprise the project:

details - represents the project details settings
template - represents a list of capabilities responsible for creating specific parts of a project

A capability is defined as a unit of configuration for the project you want to create.

This operation is:

asynchronous. Follow the Location link in the response header to determine the status of the task and use Get task to obtain subsequent updates.

Note: This API is only supported for Jira Enterprise edition.

Data Security Policy: Exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:manage:jira-configuration

Granular:write:project:jira, read:project:jira

Connect apps cannot access this REST resource.

Request

Request bodyapplication/json

The JSON payload containing the project details and capabilities

details

CustomTemplatesProjectDetails

template

CustomTemplateRequestDTO

Responses

The project creation task has been queued for execution

application/json

any

POST/rest/api/2/project-template

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `{
  "details": {
    "accessLevel": "private",
    "additionalProperties": {},
    "assigneeType": "PROJECT_LEAD",
    "avatarId": 10200,
    "categoryId": 219,
    "description": "This is a project for Foo Bar",
    "enableComponents": false,
    "key": "PRJ",
    "language": "en",
    "leadAccountId": "1234567890",
    "name": "Project Foo Bar",
    "url": "https://www.example.com"
  },
  "template": {
    "boards": {
      "boards": [
        {}
      ]
    },
    "field": {
      "customFieldDefinitions": [
        {}
      ],
      "fieldLayoutScheme": {},
      "fieldLayouts": [
        {}
      ],
      "issueLayouts": [
        {}
      ],
      "issueTypeScreenScheme": {},
      "screenScheme": [
        {}
      ],
      "screens": [
        {}
      ]
    },
    "issueType": {
      "issueTypeHierarchy": [
        {}
      ],
      "issueTypeScheme": {},
      "issueTypes": [
        {}
      ]
    },
    "notification": {
      "description": "<string>",
      "name": "<string>",
      "notificationSchemeEvents": [
        {}
      ],
      "onConflict": "FAIL",
      "pcri": {}
    },
    "permissionScheme": {
      "addAddonRole": true,
      "description": "<string>",
      "grants": [
        {}
      ],
      "name": "<string>",
      "onConflict": "FAIL",
      "pcri": {}
    },
    "project": {
      "fieldLayoutSchemeId": {},
      "issueSecuritySchemeId": {},
      "issueTypeSchemeId": {},
      "issueTypeScreenSchemeId": {},
      "notificationSchemeId": {},
      "pcri": {},
      "permissionSchemeId": {},
      "projectTypeKey": "software",
      "workflowSchemeId": {}
    },
    "role": {
      "roleToProjectActors": {},
      "roles": [
        {}
      ]
    },
    "scope": {
      "type": "GLOBAL"
    },
    "security": {
      "description": "Newly created issue security scheme",
      "name": "New Security Scheme",
      "pcri": {},
      "securityLevels": [
        {}
      ]
    },
    "workflow": {
      "statuses": [
        {}
      ],
      "workflowScheme": {},
      "workflows": [
        {}
      ]
    }
  }
}`;

const response = await api.asUser().requestJira(route`/rest/api/2/project-template`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());