POST /rest/api/2/project-template
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 settingstemplate
- 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.
Servers
- https://your-domain.atlassian.net
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
template |
Object | No |
The specific request object for creating a project with template. |
template.field |
Object | No |
Defines the payload for the fields, screens, screen schemes, issue type screen schemes, field layouts, and field layout schemes |
template.field.fieldLayoutScheme |
Object | No |
Defines the payload for the field layout schemes. See "Field Configuration Scheme" - https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-rest-api-3-fieldconfigurationscheme-post https://support.atlassian.com/jira-cloud-administration/docs/configure-a-field-configuration-scheme/ |
template.field.fieldLayoutScheme.defaultFieldLayout |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.fieldLayoutScheme.defaultFieldLayout.anID |
Boolean | No | |
template.field.fieldLayoutScheme.defaultFieldLayout.areference |
Boolean | No | |
template.field.fieldLayoutScheme.defaultFieldLayout.id |
String | No | |
template.field.fieldLayoutScheme.defaultFieldLayout.entityId |
String | No | |
template.field.fieldLayoutScheme.defaultFieldLayout.entityType |
String | No | |
template.field.fieldLayoutScheme.defaultFieldLayout.type |
String | No |
Possible values:
|
template.field.fieldLayoutScheme.name |
String | No |
The name of the field layout scheme |
template.field.fieldLayoutScheme.description |
String | No |
The description of the field layout scheme |
template.field.fieldLayoutScheme.explicitMappings |
Object | No |
There is a default configuration "fieldlayout" that is applied to all issue types using this scheme that don't have an explicit mapping users can create (or re-use existing) configurations for other issue types and map them to this scheme |
template.field.fieldLayoutScheme.explicitMappings.name |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.fieldLayoutScheme.explicitMappings.name.anID |
Boolean | No | |
template.field.fieldLayoutScheme.explicitMappings.name.areference |
Boolean | No | |
template.field.fieldLayoutScheme.explicitMappings.name.id |
String | No | |
template.field.fieldLayoutScheme.explicitMappings.name.entityId |
String | No | |
template.field.fieldLayoutScheme.explicitMappings.name.entityType |
String | No | |
template.field.fieldLayoutScheme.explicitMappings.name.type |
String | No |
Possible values:
|
template.field.fieldLayoutScheme.pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.fieldLayoutScheme.pcri.anID |
Boolean | No | |
template.field.fieldLayoutScheme.pcri.areference |
Boolean | No | |
template.field.fieldLayoutScheme.pcri.id |
String | No | |
template.field.fieldLayoutScheme.pcri.entityId |
String | No | |
template.field.fieldLayoutScheme.pcri.entityType |
String | No | |
template.field.fieldLayoutScheme.pcri.type |
String | No |
Possible values:
|
template.field.customFieldDefinitions[] |
Array | No |
The custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/\#api-rest-api-3-field-post |
template.field.customFieldDefinitions[].searcherKey |
String | No |
The searcher key of the custom field |
template.field.customFieldDefinitions[].onConflict |
String | No |
The strategy to use when there is a conflict with an existing custom field. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters Possible values:
|
template.field.customFieldDefinitions[].name |
String | No |
The name of the custom field |
template.field.customFieldDefinitions[].description |
String | No |
The description of the custom field |
template.field.customFieldDefinitions[].cfType |
String | No |
The type of the custom field |
template.field.customFieldDefinitions[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.customFieldDefinitions[].pcri.anID |
Boolean | No | |
template.field.customFieldDefinitions[].pcri.areference |
Boolean | No | |
template.field.customFieldDefinitions[].pcri.id |
String | No | |
template.field.customFieldDefinitions[].pcri.entityId |
String | No | |
template.field.customFieldDefinitions[].pcri.entityType |
String | No | |
template.field.customFieldDefinitions[].pcri.type |
String | No |
Possible values:
|
template.field.fieldLayouts[] |
Array | No |
The field layouts configuration. |
template.field.fieldLayouts[].name |
String | No |
The name of the field layout |
template.field.fieldLayouts[].description |
String | No |
The description of the field layout |
template.field.fieldLayouts[].configuration[] |
Array | No |
The field layout configuration. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-rest-api-3-fieldconfiguration-post |
template.field.fieldLayouts[].configuration[].field |
Boolean | No |
Whether to show the field |
template.field.fieldLayouts[].configuration[].required |
Boolean | No |
Whether the field is required |
template.field.fieldLayouts[].configuration[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.fieldLayouts[].configuration[].pcri.anID |
Boolean | No | |
template.field.fieldLayouts[].configuration[].pcri.areference |
Boolean | No | |
template.field.fieldLayouts[].configuration[].pcri.id |
String | No | |
template.field.fieldLayouts[].configuration[].pcri.entityId |
String | No | |
template.field.fieldLayouts[].configuration[].pcri.entityType |
String | No | |
template.field.fieldLayouts[].configuration[].pcri.type |
String | No |
Possible values:
|
template.field.fieldLayouts[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.fieldLayouts[].pcri.anID |
Boolean | No | |
template.field.fieldLayouts[].pcri.areference |
Boolean | No | |
template.field.fieldLayouts[].pcri.id |
String | No | |
template.field.fieldLayouts[].pcri.entityId |
String | No | |
template.field.fieldLayouts[].pcri.entityType |
String | No | |
template.field.fieldLayouts[].pcri.type |
String | No |
Possible values:
|
template.field.issueLayouts[] |
Array | No |
The issue layouts configuration |
template.field.issueLayouts[].containerId |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.issueLayouts[].containerId.anID |
Boolean | No | |
template.field.issueLayouts[].containerId.areference |
Boolean | No | |
template.field.issueLayouts[].containerId.id |
String | No | |
template.field.issueLayouts[].containerId.entityId |
String | No | |
template.field.issueLayouts[].containerId.entityType |
String | No | |
template.field.issueLayouts[].containerId.type |
String | No |
Possible values:
|
template.field.issueLayouts[].issueLayoutType |
String | No |
The issue layout type Possible values:
|
template.field.issueLayouts[].items[] |
Array | No |
The configuration of items in the issue layout |
template.field.issueLayouts[].items[].itemKey |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.issueLayouts[].items[].itemKey.anID |
Boolean | No | |
template.field.issueLayouts[].items[].itemKey.areference |
Boolean | No | |
template.field.issueLayouts[].items[].itemKey.id |
String | No | |
template.field.issueLayouts[].items[].itemKey.entityId |
String | No | |
template.field.issueLayouts[].items[].itemKey.entityType |
String | No | |
template.field.issueLayouts[].items[].itemKey.type |
String | No |
Possible values:
|
template.field.issueLayouts[].items[].sectionType |
String | No |
The item section type Possible values:
|
template.field.issueLayouts[].items[].type |
String | No |
The item type. Currently only support FIELD Possible values:
|
template.field.issueLayouts[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.issueLayouts[].pcri.anID |
Boolean | No | |
template.field.issueLayouts[].pcri.areference |
Boolean | No | |
template.field.issueLayouts[].pcri.id |
String | No | |
template.field.issueLayouts[].pcri.entityId |
String | No | |
template.field.issueLayouts[].pcri.entityType |
String | No | |
template.field.issueLayouts[].pcri.type |
String | No |
Possible values:
|
template.field.issueTypeScreenScheme |
Object | No |
Defines the payload for the issue type screen schemes. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/\#api-rest-api-3-issuetypescreenscheme-post |
template.field.issueTypeScreenScheme.name |
String | No |
The name of the issue type screen scheme |
template.field.issueTypeScreenScheme.description |
String | No |
The description of the issue type screen scheme |
template.field.issueTypeScreenScheme.defaultScreenScheme |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.issueTypeScreenScheme.defaultScreenScheme.anID |
Boolean | No | |
template.field.issueTypeScreenScheme.defaultScreenScheme.areference |
Boolean | No | |
template.field.issueTypeScreenScheme.defaultScreenScheme.id |
String | No | |
template.field.issueTypeScreenScheme.defaultScreenScheme.entityId |
String | No | |
template.field.issueTypeScreenScheme.defaultScreenScheme.entityType |
String | No | |
template.field.issueTypeScreenScheme.defaultScreenScheme.type |
String | No |
Possible values:
|
template.field.issueTypeScreenScheme.explicitMappings |
Object | No |
The IDs of the screen schemes for the issue type IDs and default. A default entry is required to create an issue type screen scheme, it defines the mapping for all issue types without a screen scheme. |
template.field.issueTypeScreenScheme.explicitMappings.name |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.issueTypeScreenScheme.explicitMappings.name.anID |
Boolean | No | |
template.field.issueTypeScreenScheme.explicitMappings.name.areference |
Boolean | No | |
template.field.issueTypeScreenScheme.explicitMappings.name.id |
String | No | |
template.field.issueTypeScreenScheme.explicitMappings.name.entityId |
String | No | |
template.field.issueTypeScreenScheme.explicitMappings.name.entityType |
String | No | |
template.field.issueTypeScreenScheme.explicitMappings.name.type |
String | No |
Possible values:
|
template.field.issueTypeScreenScheme.pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.issueTypeScreenScheme.pcri.anID |
Boolean | No | |
template.field.issueTypeScreenScheme.pcri.areference |
Boolean | No | |
template.field.issueTypeScreenScheme.pcri.id |
String | No | |
template.field.issueTypeScreenScheme.pcri.entityId |
String | No | |
template.field.issueTypeScreenScheme.pcri.entityType |
String | No | |
template.field.issueTypeScreenScheme.pcri.type |
String | No |
Possible values:
|
template.field.screenScheme[] |
Array | No |
The screen schemes See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes/\#api-rest-api-3-screenscheme-post |
template.field.screenScheme[].name |
String | No |
The name of the screen scheme |
template.field.screenScheme[].description |
String | No |
The description of the screen scheme |
template.field.screenScheme[].defaultScreen |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.screenScheme[].defaultScreen.anID |
Boolean | No | |
template.field.screenScheme[].defaultScreen.areference |
Boolean | No | |
template.field.screenScheme[].defaultScreen.id |
String | No | |
template.field.screenScheme[].defaultScreen.entityId |
String | No | |
template.field.screenScheme[].defaultScreen.entityType |
String | No | |
template.field.screenScheme[].defaultScreen.type |
String | No |
Possible values:
|
template.field.screenScheme[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.screenScheme[].pcri.anID |
Boolean | No | |
template.field.screenScheme[].pcri.areference |
Boolean | No | |
template.field.screenScheme[].pcri.id |
String | No | |
template.field.screenScheme[].pcri.entityId |
String | No | |
template.field.screenScheme[].pcri.entityType |
String | No | |
template.field.screenScheme[].pcri.type |
String | No |
Possible values:
|
template.field.screenScheme[].screens |
Object | No |
Similar to the field layout scheme those mappings allow users to set different screens for different operations: default - always there, applied to all operations that don't have an explicit mapping |
template.field.screenScheme[].screens.name |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.screenScheme[].screens.name.anID |
Boolean | No | |
template.field.screenScheme[].screens.name.areference |
Boolean | No | |
template.field.screenScheme[].screens.name.id |
String | No | |
template.field.screenScheme[].screens.name.entityId |
String | No | |
template.field.screenScheme[].screens.name.entityType |
String | No | |
template.field.screenScheme[].screens.name.type |
String | No |
Possible values:
|
template.field.screens[] |
Array | No |
The screens. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens/\#api-rest-api-3-screens-post |
template.field.screens[].name |
String | No |
The name of the screen |
template.field.screens[].description |
String | No |
The description of the screen |
template.field.screens[].tabs[] |
Array | No |
The tabs of the screen. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields/\#api-rest-api-3-screens-screenid-tabs-tabid-fields-post |
template.field.screens[].tabs[].name |
String | No |
The name of the tab |
template.field.screens[].tabs[].fields[] |
Array | No |
The list of resource identifier of the field associated to the tab. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields/\#api-rest-api-3-screens-screenid-tabs-tabid-fields-post |
template.field.screens[].tabs[].fields[].anID |
Boolean | No | |
template.field.screens[].tabs[].fields[].areference |
Boolean | No | |
template.field.screens[].tabs[].fields[].id |
String | No | |
template.field.screens[].tabs[].fields[].entityId |
String | No | |
template.field.screens[].tabs[].fields[].entityType |
String | No | |
template.field.screens[].tabs[].fields[].type |
String | No |
Possible values:
|
template.field.screens[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.field.screens[].pcri.anID |
Boolean | No | |
template.field.screens[].pcri.areference |
Boolean | No | |
template.field.screens[].pcri.id |
String | No | |
template.field.screens[].pcri.entityId |
String | No | |
template.field.screens[].pcri.entityType |
String | No | |
template.field.screens[].pcri.type |
String | No |
Possible values:
|
template.boards |
Object | No | |
template.boards.boards[] |
Array | No |
The boards to be associated with the project. |
template.boards.boards[].supportsSprint |
Boolean | No |
Whether sprints are supported on the board Default value: true |
template.boards.boards[].name |
String | No |
The name of the board |
template.boards.boards[].swimlanes |
Object | No |
The payload for customising a swimlanes on a board |
template.boards.boards[].swimlanes.swimlaneStrategy |
String | No |
The swimlane strategy for the board. Possible values:
|
template.boards.boards[].swimlanes.defaultCustomSwimlaneName |
String | No |
The name of the custom swimlane to use for work items that don't match any other swimlanes. |
template.boards.boards[].swimlanes.customSwimlanes[] |
Array | No |
The custom swimlane definitions. Possible values:
|
template.boards.boards[].swimlanes.customSwimlanes[].name |
String | No |
The name of the quick filter |
template.boards.boards[].swimlanes.customSwimlanes[].description |
String | No |
The description of the quick filter |
template.boards.boards[].swimlanes.customSwimlanes[].jqlQuery |
String | No |
The jql query for the quick filter |
template.boards.boards[].cardLayout |
Object | No |
Card layout configuration. |
template.boards.boards[].cardLayout.showDaysInColumn |
Boolean | No |
Whether to show days in column Possible values:
Default value: false |
template.boards.boards[].columns[] |
Array | No |
The columns of the board |
template.boards.boards[].columns[].statusIds[] |
Array | No |
The status IDs for the column |
template.boards.boards[].columns[].statusIds[].anID |
Boolean | No | |
template.boards.boards[].columns[].statusIds[].areference |
Boolean | No | |
template.boards.boards[].columns[].statusIds[].id |
String | No | |
template.boards.boards[].columns[].statusIds[].entityId |
String | No | |
template.boards.boards[].columns[].statusIds[].entityType |
String | No | |
template.boards.boards[].columns[].statusIds[].type |
String | No |
Possible values:
|
template.boards.boards[].columns[].name |
String | No |
The name of the column |
template.boards.boards[].columns[].maximumIssueConstraint |
Integer | No |
The maximum issue constraint for the column |
template.boards.boards[].columns[].minimumIssueConstraint |
Integer | No |
The minimum issue constraint for the column |
template.boards.boards[].boardFilterJQL |
String | No |
Takes in a JQL string to create a new filter. If no value is provided, it'll default to a JQL filter for the project creating |
template.boards.boards[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.boards.boards[].pcri.anID |
Boolean | No | |
template.boards.boards[].pcri.areference |
Boolean | No | |
template.boards.boards[].pcri.id |
String | No | |
template.boards.boards[].pcri.entityId |
String | No | |
template.boards.boards[].pcri.entityType |
String | No | |
template.boards.boards[].pcri.type |
String | No |
Possible values:
|
template.boards.boards[].workingDaysConfig |
Object | No |
Working days configuration |
template.boards.boards[].workingDaysConfig.id |
Integer | No | |
template.boards.boards[].workingDaysConfig.friday |
Boolean | No | |
template.boards.boards[].workingDaysConfig.sunday |
Boolean | No | |
template.boards.boards[].workingDaysConfig.timezoneId |
String | No | |
template.boards.boards[].workingDaysConfig.wednesday |
Boolean | No | |
template.boards.boards[].workingDaysConfig.saturday |
Boolean | No | |
template.boards.boards[].workingDaysConfig.nonWorkingDays[] |
Array | No | |
template.boards.boards[].workingDaysConfig.nonWorkingDays[].id |
Integer | No | |
template.boards.boards[].workingDaysConfig.nonWorkingDays[].iso8601Date |
String | No | |
template.boards.boards[].workingDaysConfig.monday |
Boolean | No | |
template.boards.boards[].workingDaysConfig.thursday |
Boolean | No | |
template.boards.boards[].workingDaysConfig.tuesday |
Boolean | No | |
template.boards.boards[].cardColorStrategy |
String | No |
Card color settings of the board Possible values:
|
template.boards.boards[].cardLayouts[] |
Array | No |
Card layout settings of the board |
template.boards.boards[].cardLayouts[].fieldId |
String | No | |
template.boards.boards[].cardLayouts[].id |
Integer | No | |
template.boards.boards[].cardLayouts[].mode |
String | No |
Possible values:
|
template.boards.boards[].cardLayouts[].position |
Integer | No | |
template.boards.boards[].features[] |
Array | No |
Feature settings for the board |
template.boards.boards[].features[].featureKey |
String | No |
The key of the feature Possible values:
|
template.boards.boards[].features[].state |
Boolean | No |
Whether the feature should be turned on or off Possible values:
|
template.boards.boards[].quickFilters[] |
Array | No |
The quick filters for the board. |
template.boards.boards[].quickFilters[].name |
String | No |
The name of the quick filter |
template.boards.boards[].quickFilters[].description |
String | No |
The description of the quick filter |
template.boards.boards[].quickFilters[].jqlQuery |
String | No |
The jql query for the quick filter |
template.permissionScheme |
Object | No |
The payload to create a permission scheme |
template.permissionScheme.onConflict |
String | No |
The strategy to use when there is a conflict with an existing permission scheme. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters; NEW - If the entity exist, try and create a new one with a different name Possible values:
Default value: "NEW" |
template.permissionScheme.addAddonRole |
Boolean | No |
Configuration to generate addon role. Default is false if null |
template.permissionScheme.name |
String | No |
The name of the permission scheme |
template.permissionScheme.description |
String | No |
The description of the permission scheme |
template.permissionScheme.grants[] |
Array | No |
List of permission grants |
template.permissionScheme.grants[].applicationAccess[] |
Array | No | |
template.permissionScheme.grants[].specialGrants[] |
Array | No | |
template.permissionScheme.grants[].groups[] |
Array | No | |
template.permissionScheme.grants[].groups[].anID |
Boolean | No | |
template.permissionScheme.grants[].groups[].areference |
Boolean | No | |
template.permissionScheme.grants[].groups[].id |
String | No | |
template.permissionScheme.grants[].groups[].entityId |
String | No | |
template.permissionScheme.grants[].groups[].entityType |
String | No | |
template.permissionScheme.grants[].groups[].type |
String | No |
Possible values:
|
template.permissionScheme.grants[].groupCustomFields[] |
Array | No | |
template.permissionScheme.grants[].groupCustomFields[].anID |
Boolean | No | |
template.permissionScheme.grants[].groupCustomFields[].areference |
Boolean | No | |
template.permissionScheme.grants[].groupCustomFields[].id |
String | No | |
template.permissionScheme.grants[].groupCustomFields[].entityId |
String | No | |
template.permissionScheme.grants[].groupCustomFields[].entityType |
String | No | |
template.permissionScheme.grants[].groupCustomFields[].type |
String | No |
Possible values:
|
template.permissionScheme.grants[].userCustomFields[] |
Array | No | |
template.permissionScheme.grants[].userCustomFields[].anID |
Boolean | No | |
template.permissionScheme.grants[].userCustomFields[].areference |
Boolean | No | |
template.permissionScheme.grants[].userCustomFields[].id |
String | No | |
template.permissionScheme.grants[].userCustomFields[].entityId |
String | No | |
template.permissionScheme.grants[].userCustomFields[].entityType |
String | No | |
template.permissionScheme.grants[].userCustomFields[].type |
String | No |
Possible values:
|
template.permissionScheme.grants[].permissionKeys[] |
Array | No | |
template.permissionScheme.grants[].users[] |
Array | No | |
template.permissionScheme.grants[].users[].anID |
Boolean | No | |
template.permissionScheme.grants[].users[].areference |
Boolean | No | |
template.permissionScheme.grants[].users[].id |
String | No | |
template.permissionScheme.grants[].users[].entityId |
String | No | |
template.permissionScheme.grants[].users[].entityType |
String | No | |
template.permissionScheme.grants[].users[].type |
String | No |
Possible values:
|
template.permissionScheme.grants[].projectRoles[] |
Array | No | |
template.permissionScheme.grants[].projectRoles[].anID |
Boolean | No | |
template.permissionScheme.grants[].projectRoles[].areference |
Boolean | No | |
template.permissionScheme.grants[].projectRoles[].id |
String | No | |
template.permissionScheme.grants[].projectRoles[].entityId |
String | No | |
template.permissionScheme.grants[].projectRoles[].entityType |
String | No | |
template.permissionScheme.grants[].projectRoles[].type |
String | No |
Possible values:
|
template.permissionScheme.pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.permissionScheme.pcri.anID |
Boolean | No | |
template.permissionScheme.pcri.areference |
Boolean | No | |
template.permissionScheme.pcri.id |
String | No | |
template.permissionScheme.pcri.entityId |
String | No | |
template.permissionScheme.pcri.entityType |
String | No | |
template.permissionScheme.pcri.type |
String | No |
Possible values:
|
template.security |
Object | No |
The payload for creating a security scheme. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/ |
template.security.name |
String | No |
The name of the security scheme |
template.security.description |
String | No |
The description of the security scheme |
template.security.securityLevels[] |
Array | No |
The security levels for the security scheme |
template.security.securityLevels[].name |
String | No |
The name of the security level |
template.security.securityLevels[].description |
String | No |
The description of the security level |
template.security.securityLevels[].isDefault |
Boolean | No |
Whether the security level is default for the security scheme Possible values:
|
template.security.securityLevels[].securityLevelMembers[] |
Array | No |
The members of the security level |
template.security.securityLevels[].securityLevelMembers[].parameter |
String | No |
Defines the value associated with the type. For reporter this would be {"null"}; for users this would be the names of specific users); for group this would be group names like {"administrators", "jira-administrators", "jira-users"} |
template.security.securityLevels[].securityLevelMembers[].type |
String | No |
The type of the security level member Possible values:
|
template.security.pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.security.pcri.anID |
Boolean | No | |
template.security.pcri.areference |
Boolean | No | |
template.security.pcri.id |
String | No | |
template.security.pcri.entityId |
String | No | |
template.security.pcri.entityType |
String | No | |
template.security.pcri.type |
String | No |
Possible values:
|
template.notification |
Object | No |
The payload for creating a notification scheme. The user has to supply the ID for the default notification scheme. For CMP this is provided in the project payload and should be left empty, for TMP it's provided using this payload |
template.notification.onConflict |
String | No |
The strategy to use when there is a conflict with an existing entity Possible values:
|
template.notification.name |
String | No |
The name of the notification scheme |
template.notification.description |
String | No |
The description of the notification scheme |
template.notification.notificationSchemeEvents[] |
Array | No |
The events and notifications for the notification scheme |
template.notification.notificationSchemeEvents[].event |
Object | No |
The event ID to use for reference in the payload |
template.notification.notificationSchemeEvents[].event.id |
String | No |
The event ID to use for reference in the payload |
template.notification.notificationSchemeEvents[].notifications[] |
Array | No |
The configuration for notification recipents |
template.notification.notificationSchemeEvents[].notifications[].parameter |
String | No |
The parameter of the notification, should be eiither null if not required, or PCRI. |
template.notification.notificationSchemeEvents[].notifications[].notificationType |
String | No |
The type of notification. |
template.notification.pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.notification.pcri.anID |
Boolean | No | |
template.notification.pcri.areference |
Boolean | No | |
template.notification.pcri.id |
String | No | |
template.notification.pcri.entityId |
String | No | |
template.notification.pcri.entityType |
String | No | |
template.notification.pcri.type |
String | No |
Possible values:
|
template.scope |
Object | No |
The payload for creating a scope. Defines if a project is team-managed project or company-managed project |
template.scope.type |
String | No |
The type of the scope. Use Possible values:
|
template.issueType |
Object | No |
The payload for creating issue types in a project |
template.issueType.issueTypeHierarchy[] |
Array | No |
Defines the issue type hierarhy to be created and used during this project creation. This will only add new levels if there isn't an existing level |
template.issueType.issueTypeHierarchy[].onConflict |
String | No |
The conflict strategy to use when the issue type already exists. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters Possible values:
|
template.issueType.issueTypeHierarchy[].name |
String | No |
The name of the issue type |
template.issueType.issueTypeHierarchy[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.issueType.issueTypeHierarchy[].pcri.anID |
Boolean | No | |
template.issueType.issueTypeHierarchy[].pcri.areference |
Boolean | No | |
template.issueType.issueTypeHierarchy[].pcri.id |
String | No | |
template.issueType.issueTypeHierarchy[].pcri.entityId |
String | No | |
template.issueType.issueTypeHierarchy[].pcri.entityType |
String | No | |
template.issueType.issueTypeHierarchy[].pcri.type |
String | No |
Possible values:
|
template.issueType.issueTypeHierarchy[].hierarchyLevel |
Integer | No |
The hierarchy level of the issue type. 0, 1, 2, 3 .. n; Negative values for subtasks |
template.issueType.issueTypeScheme |
Object | No |
The payload for creating issue type schemes |
template.issueType.issueTypeScheme.name |
String | No |
The name of the issue type scheme |
template.issueType.issueTypeScheme.description |
String | No |
The description of the issue type scheme |
template.issueType.issueTypeScheme.defaultIssueTypeId |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.issueType.issueTypeScheme.defaultIssueTypeId.anID |
Boolean | No | |
template.issueType.issueTypeScheme.defaultIssueTypeId.areference |
Boolean | No | |
template.issueType.issueTypeScheme.defaultIssueTypeId.id |
String | No | |
template.issueType.issueTypeScheme.defaultIssueTypeId.entityId |
String | No | |
template.issueType.issueTypeScheme.defaultIssueTypeId.entityType |
String | No | |
template.issueType.issueTypeScheme.defaultIssueTypeId.type |
String | No |
Possible values:
|
template.issueType.issueTypeScheme.issueTypeIds[] |
Array | No |
The issue type IDs for the issue type scheme |
template.issueType.issueTypeScheme.issueTypeIds[].anID |
Boolean | No | |
template.issueType.issueTypeScheme.issueTypeIds[].areference |
Boolean | No | |
template.issueType.issueTypeScheme.issueTypeIds[].id |
String | No | |
template.issueType.issueTypeScheme.issueTypeIds[].entityId |
String | No | |
template.issueType.issueTypeScheme.issueTypeIds[].entityType |
String | No | |
template.issueType.issueTypeScheme.issueTypeIds[].type |
String | No |
Possible values:
|
template.issueType.issueTypeScheme.pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.issueType.issueTypeScheme.pcri.anID |
Boolean | No | |
template.issueType.issueTypeScheme.pcri.areference |
Boolean | No | |
template.issueType.issueTypeScheme.pcri.id |
String | No | |
template.issueType.issueTypeScheme.pcri.entityId |
String | No | |
template.issueType.issueTypeScheme.pcri.entityType |
String | No | |
template.issueType.issueTypeScheme.pcri.type |
String | No |
Possible values:
|
template.issueType.issueTypes[] |
Array | No |
Only needed if you want to create issue types, you can otherwise use the ids of issue types in the scheme configuration |
template.issueType.issueTypes[].onConflict |
String | No |
The conflict strategy to use when the issue type already exists. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters Possible values:
|
template.issueType.issueTypes[].name |
String | No |
The name of the issue type |
template.issueType.issueTypes[].description |
String | No |
The description of the issue type |
template.issueType.issueTypes[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.issueType.issueTypes[].pcri.anID |
Boolean | No | |
template.issueType.issueTypes[].pcri.areference |
Boolean | No | |
template.issueType.issueTypes[].pcri.id |
String | No | |
template.issueType.issueTypes[].pcri.entityId |
String | No | |
template.issueType.issueTypes[].pcri.entityType |
String | No | |
template.issueType.issueTypes[].pcri.type |
String | No |
Possible values:
|
template.issueType.issueTypes[].hierarchyLevel |
Integer | No |
The hierarchy level of the issue type. 0, 1, 2, 3 .. n; Negative values for subtasks |
template.issueType.issueTypes[].avatarId |
Integer | No |
The avatar ID of the issue type. Go to https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/\#api-rest-api-3-avatar-type-system-get to choose an avatarId existing in Jira |
template.project |
Object | No |
The payload for creating a project |
template.project.projectTypeKey |
String | No |
The project type, which defines the application-specific feature set. If you don't specify the project template you have to specify the project type. Possible values:
|
template.project.issueTypeSchemeId |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.project.issueTypeSchemeId.anID |
Boolean | No | |
template.project.issueTypeSchemeId.areference |
Boolean | No | |
template.project.issueTypeSchemeId.id |
String | No | |
template.project.issueTypeSchemeId.entityId |
String | No | |
template.project.issueTypeSchemeId.entityType |
String | No | |
template.project.issueTypeSchemeId.type |
String | No |
Possible values:
|
template.project.issueSecuritySchemeId |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.project.issueSecuritySchemeId.anID |
Boolean | No | |
template.project.issueSecuritySchemeId.areference |
Boolean | No | |
template.project.issueSecuritySchemeId.id |
String | No | |
template.project.issueSecuritySchemeId.entityId |
String | No | |
template.project.issueSecuritySchemeId.entityType |
String | No | |
template.project.issueSecuritySchemeId.type |
String | No |
Possible values:
|
template.project.notificationSchemeId |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.project.notificationSchemeId.anID |
Boolean | No | |
template.project.notificationSchemeId.areference |
Boolean | No | |
template.project.notificationSchemeId.id |
String | No | |
template.project.notificationSchemeId.entityId |
String | No | |
template.project.notificationSchemeId.entityType |
String | No | |
template.project.notificationSchemeId.type |
String | No |
Possible values:
|
template.project.fieldLayoutSchemeId |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.project.fieldLayoutSchemeId.anID |
Boolean | No | |
template.project.fieldLayoutSchemeId.areference |
Boolean | No | |
template.project.fieldLayoutSchemeId.id |
String | No | |
template.project.fieldLayoutSchemeId.entityId |
String | No | |
template.project.fieldLayoutSchemeId.entityType |
String | No | |
template.project.fieldLayoutSchemeId.type |
String | No |
Possible values:
|
template.project.pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.project.pcri.anID |
Boolean | No | |
template.project.pcri.areference |
Boolean | No | |
template.project.pcri.id |
String | No | |
template.project.pcri.entityId |
String | No | |
template.project.pcri.entityType |
String | No | |
template.project.pcri.type |
String | No |
Possible values:
|
template.project.workflowSchemeId |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.project.workflowSchemeId.anID |
Boolean | No | |
template.project.workflowSchemeId.areference |
Boolean | No | |
template.project.workflowSchemeId.id |
String | No | |
template.project.workflowSchemeId.entityId |
String | No | |
template.project.workflowSchemeId.entityType |
String | No | |
template.project.workflowSchemeId.type |
String | No |
Possible values:
|
template.project.issueTypeScreenSchemeId |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.project.issueTypeScreenSchemeId.anID |
Boolean | No | |
template.project.issueTypeScreenSchemeId.areference |
Boolean | No | |
template.project.issueTypeScreenSchemeId.id |
String | No | |
template.project.issueTypeScreenSchemeId.entityId |
String | No | |
template.project.issueTypeScreenSchemeId.entityType |
String | No | |
template.project.issueTypeScreenSchemeId.type |
String | No |
Possible values:
|
template.project.permissionSchemeId |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.project.permissionSchemeId.anID |
Boolean | No | |
template.project.permissionSchemeId.areference |
Boolean | No | |
template.project.permissionSchemeId.id |
String | No | |
template.project.permissionSchemeId.entityId |
String | No | |
template.project.permissionSchemeId.entityType |
String | No | |
template.project.permissionSchemeId.type |
String | No |
Possible values:
|
template.role |
Object | No | |
template.role.roleToProjectActors |
Object | No |
A map of role PCRI (can be ID or REF) to a list of user or group PCRI IDs to associate with the role and project. |
template.role.roleToProjectActors.name |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.role.roleToProjectActors.name.anID |
Boolean | No | |
template.role.roleToProjectActors.name.areference |
Boolean | No | |
template.role.roleToProjectActors.name.id |
String | No | |
template.role.roleToProjectActors.name.entityId |
String | No | |
template.role.roleToProjectActors.name.entityType |
String | No | |
template.role.roleToProjectActors.name.type |
String | No |
Possible values:
|
template.role.roles[] |
Array | No |
The list of roles to create. |
template.role.roles[].defaultActors[] |
Array | No |
The default actors for the role. By adding default actors, the role will be added to any future projects created |
template.role.roles[].defaultActors[].anID |
Boolean | No | |
template.role.roles[].defaultActors[].areference |
Boolean | No | |
template.role.roles[].defaultActors[].id |
String | No | |
template.role.roles[].defaultActors[].entityId |
String | No | |
template.role.roles[].defaultActors[].entityType |
String | No | |
template.role.roles[].defaultActors[].type |
String | No |
Possible values:
|
template.role.roles[].onConflict |
String | No |
The strategy to use when there is a conflict with an existing project role. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters Possible values:
Default value: "USE" |
template.role.roles[].name |
String | No |
The name of the role |
template.role.roles[].description |
String | No |
The description of the role |
template.role.roles[].type |
String | No |
The type of the role. Only used by project-scoped project Possible values:
|
template.role.roles[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.role.roles[].pcri.anID |
Boolean | No | |
template.role.roles[].pcri.areference |
Boolean | No | |
template.role.roles[].pcri.id |
String | No | |
template.role.roles[].pcri.entityId |
String | No | |
template.role.roles[].pcri.entityType |
String | No | |
template.role.roles[].pcri.type |
String | No |
Possible values:
|
template.workflow |
Object | No |
The payload for creating a workflows. See https://www.atlassian.com/software/jira/guides/workflows/overview\#what-is-a-jira-workflow |
template.workflow.workflowScheme |
Object | No |
The payload for creating a workflow scheme. See https://www.atlassian.com/software/jira/guides/workflows/overview\#what-is-a-jira-workflow-scheme |
template.workflow.workflowScheme.defaultWorkflow |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.workflow.workflowScheme.defaultWorkflow.anID |
Boolean | No | |
template.workflow.workflowScheme.defaultWorkflow.areference |
Boolean | No | |
template.workflow.workflowScheme.defaultWorkflow.id |
String | No | |
template.workflow.workflowScheme.defaultWorkflow.entityId |
String | No | |
template.workflow.workflowScheme.defaultWorkflow.entityType |
String | No | |
template.workflow.workflowScheme.defaultWorkflow.type |
String | No |
Possible values:
|
template.workflow.workflowScheme.name |
String | No |
The name of the workflow scheme |
template.workflow.workflowScheme.description |
String | No |
The description of the workflow scheme |
template.workflow.workflowScheme.explicitMappings |
Object | No |
Association between issuetypes and workflows |
template.workflow.workflowScheme.explicitMappings.name |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.workflow.workflowScheme.explicitMappings.name.anID |
Boolean | No | |
template.workflow.workflowScheme.explicitMappings.name.areference |
Boolean | No | |
template.workflow.workflowScheme.explicitMappings.name.id |
String | No | |
template.workflow.workflowScheme.explicitMappings.name.entityId |
String | No | |
template.workflow.workflowScheme.explicitMappings.name.entityType |
String | No | |
template.workflow.workflowScheme.explicitMappings.name.type |
String | No |
Possible values:
|
template.workflow.workflowScheme.pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.workflow.workflowScheme.pcri.anID |
Boolean | No | |
template.workflow.workflowScheme.pcri.areference |
Boolean | No | |
template.workflow.workflowScheme.pcri.id |
String | No | |
template.workflow.workflowScheme.pcri.entityId |
String | No | |
template.workflow.workflowScheme.pcri.entityType |
String | No | |
template.workflow.workflowScheme.pcri.type |
String | No |
Possible values:
|
template.workflow.workflows[] |
Array | No |
The transitions for the workflow |
template.workflow.workflows[].onConflict |
String | No |
The strategy to use if there is a conflict with another workflow Possible values:
Default value: "NEW" |
template.workflow.workflows[].transitions[] |
Array | No |
The transitions for the workflow |
template.workflow.workflows[].transitions[].customIssueEventId |
String | No |
Mechanism in Jira for triggering certain actions, like notifications, automations, etc. Unless a custom notification scheme is configure, it's better not to provide any value here |
template.workflow.workflows[].transitions[].description |
String | No |
The description of the transition |
template.workflow.workflows[].transitions[].transitionScreen |
Object | No |
The payload for creating rules in a workflow |
template.workflow.workflows[].transitions[].transitionScreen.ruleKey |
String | No |
The key of the rule. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/\#api-rest-api-3-workflows-capabilities-get |
template.workflow.workflows[].transitions[].transitionScreen.parameters |
Object | No |
The parameters of the rule |
template.workflow.workflows[].transitions[].properties |
Object | No |
The properties of the transition |
template.workflow.workflows[].transitions[].triggers[] |
Array | No |
The triggers that are performed when the transition is made |
template.workflow.workflows[].transitions[].triggers[].ruleKey |
String | No |
The key of the rule. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/\#api-rest-api-3-workflows-capabilities-get |
template.workflow.workflows[].transitions[].triggers[].parameters |
Object | No |
The parameters of the rule |
template.workflow.workflows[].transitions[].conditions |
Object | No |
The payload for creating a condition group in a workflow |
template.workflow.workflows[].transitions[].conditions.operation |
String | No |
Determines how the conditions in the group are evaluated. Accepts either Possible values:
|
template.workflow.workflows[].transitions[].conditions.conditions[] |
Array | No |
The rules for this condition. |
template.workflow.workflows[].transitions[].conditions.conditions[].ruleKey |
String | No |
The key of the rule. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/\#api-rest-api-3-workflows-capabilities-get |
template.workflow.workflows[].transitions[].conditions.conditions[].parameters |
Object | No |
The parameters of the rule |
template.workflow.workflows[].transitions[].conditions.conditionGroup[] |
Array | No |
The nested conditions of the condition group. |
template.workflow.workflows[].transitions[].from[] |
Array | No |
The statuses that the transition can be made from |
template.workflow.workflows[].transitions[].from[].toPortOverride |
Integer | No |
The port that the transition goes to |
template.workflow.workflows[].transitions[].from[].status |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.workflow.workflows[].transitions[].from[].status.anID |
Boolean | No | |
template.workflow.workflows[].transitions[].from[].status.areference |
Boolean | No | |
template.workflow.workflows[].transitions[].from[].status.id |
String | No | |
template.workflow.workflows[].transitions[].from[].status.entityId |
String | No | |
template.workflow.workflows[].transitions[].from[].status.entityType |
String | No | |
template.workflow.workflows[].transitions[].from[].status.type |
String | No |
Possible values:
|
template.workflow.workflows[].transitions[].from[].fromPort |
Integer | No |
The port that the transition can be made from |
template.workflow.workflows[].transitions[].id |
Integer | No |
The id of the transition |
template.workflow.workflows[].transitions[].to |
Object | No |
The payload for the layout details for the destination end of a transition |
template.workflow.workflows[].transitions[].to.port |
Integer | No |
Defines where the transition line will be connected to a status. Port 0 to 7 are acceptable values. |
template.workflow.workflows[].transitions[].to.status |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.workflow.workflows[].transitions[].to.status.anID |
Boolean | No | |
template.workflow.workflows[].transitions[].to.status.areference |
Boolean | No | |
template.workflow.workflows[].transitions[].to.status.id |
String | No | |
template.workflow.workflows[].transitions[].to.status.entityId |
String | No | |
template.workflow.workflows[].transitions[].to.status.entityType |
String | No | |
template.workflow.workflows[].transitions[].to.status.type |
String | No |
Possible values:
|
template.workflow.workflows[].transitions[].validators[] |
Array | No |
The validators that are performed when the transition is made |
template.workflow.workflows[].transitions[].validators[].ruleKey |
String | No |
The key of the rule. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/\#api-rest-api-3-workflows-capabilities-get |
template.workflow.workflows[].transitions[].validators[].parameters |
Object | No |
The parameters of the rule |
template.workflow.workflows[].transitions[].actions[] |
Array | No |
The actions that are performed when the transition is made |
template.workflow.workflows[].transitions[].actions[].ruleKey |
String | No |
The key of the rule. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/\#api-rest-api-3-workflows-capabilities-get |
template.workflow.workflows[].transitions[].actions[].parameters |
Object | No |
The parameters of the rule |
template.workflow.workflows[].transitions[].name |
String | No |
The name of the transition |
template.workflow.workflows[].transitions[].type |
String | No |
The type of the transition Possible values:
|
template.workflow.workflows[].loopedTransitionContainerLayout |
Object | No |
The layout of the workflow status. |
template.workflow.workflows[].loopedTransitionContainerLayout.x |
Number | No |
The x coordinate of the status. |
template.workflow.workflows[].loopedTransitionContainerLayout.y |
Number | No |
The y coordinate of the status. |
template.workflow.workflows[].name |
String | No |
The name of the workflow |
template.workflow.workflows[].description |
String | No |
The description of the workflow |
template.workflow.workflows[].startPointLayout |
Object | No |
The layout of the workflow status. |
template.workflow.workflows[].startPointLayout.x |
Number | No |
The x coordinate of the status. |
template.workflow.workflows[].startPointLayout.y |
Number | No |
The y coordinate of the status. |
template.workflow.workflows[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.workflow.workflows[].pcri.anID |
Boolean | No | |
template.workflow.workflows[].pcri.areference |
Boolean | No | |
template.workflow.workflows[].pcri.id |
String | No | |
template.workflow.workflows[].pcri.entityId |
String | No | |
template.workflow.workflows[].pcri.entityType |
String | No | |
template.workflow.workflows[].pcri.type |
String | No |
Possible values:
|
template.workflow.workflows[].statuses[] |
Array | No |
The statuses to be used in the workflow |
template.workflow.workflows[].statuses[].layout |
Object | No |
The layout of the workflow status. |
template.workflow.workflows[].statuses[].layout.x |
Number | No |
The x coordinate of the status. |
template.workflow.workflows[].statuses[].layout.y |
Number | No |
The y coordinate of the status. |
template.workflow.workflows[].statuses[].properties |
Object | No |
The properties of the workflow status. |
template.workflow.workflows[].statuses[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.workflow.workflows[].statuses[].pcri.anID |
Boolean | No | |
template.workflow.workflows[].statuses[].pcri.areference |
Boolean | No | |
template.workflow.workflows[].statuses[].pcri.id |
String | No | |
template.workflow.workflows[].statuses[].pcri.entityId |
String | No | |
template.workflow.workflows[].statuses[].pcri.entityType |
String | No | |
template.workflow.workflows[].statuses[].pcri.type |
String | No |
Possible values:
|
template.workflow.statuses[] |
Array | No |
The statuses for the workflow |
template.workflow.statuses[].onConflict |
String | No |
The conflict strategy for the status already exists. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters; NEW - Create a new entity Possible values:
|
template.workflow.statuses[].name |
String | No |
The name of the status |
template.workflow.statuses[].description |
String | No |
The description of the status |
template.workflow.statuses[].statusCategory |
String | No |
The status category of the status. The value is case-sensitive. Possible values:
|
template.workflow.statuses[].pcri |
Object | No |
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either |
template.workflow.statuses[].pcri.anID |
Boolean | No | |
template.workflow.statuses[].pcri.areference |
Boolean | No | |
template.workflow.statuses[].pcri.id |
String | No | |
template.workflow.statuses[].pcri.entityId |
String | No | |
template.workflow.statuses[].pcri.entityType |
String | No | |
template.workflow.statuses[].pcri.type |
String | No |
Possible values:
|
details |
Object | No |
Project Details |
details.accessLevel |
String | No |
The access level of the project. Only used by team-managed project Possible values:
|
details.leadAccountId |
String | No |
The account ID of the project lead. Either |
details.name |
String | No |
Name of the project |
details.description |
String | No |
Brief description of the project |
details.key |
String | No |
Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters. |
details.url |
String | No |
A link to information about this project, such as project documentation |
details.enableComponents |
Boolean | No |
Whether components are enabled for the project. Only used by company-managed project Default value: false |
details.categoryId |
Integer | No |
The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. |
details.assigneeType |
String | No |
The default assignee when creating issues in the project Possible values:
|
details.additionalProperties |
Object | No |
Additional properties of the project |
details.avatarId |
Integer | No |
The ID of the project's avatar. Use the [Get project avatars](#api-rest-api-3-project-projectIdOrKey-avatar-get) operation to list the available avatars in a project. |
details.language |
String | No |
The default language for the project |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.