Atlassian: Project templates schemas

← Project templates operations · All schemas

Create custom project — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request to create a project using a custom template Additional keys: not allowed
details	Model	Optional	Expand Create custom project — request body — body details
template	Model	Optional	Expand Create custom project — request body — body template

Referenced models: Create custom project — request body — body template, Create custom project — request body — body details

Create custom project — request body — body / template / field / customFieldDefinitions, fieldLayoutScheme, fieldLayouts, fieldScheme, issueLayouts, issueTypeScreenScheme, screenScheme, screens / fieldScheme / onConflict: FAIL, USE, NEW items item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the payload for the field association scheme. Additional keys: not allowed
description	string	Optional	The description of the field association item
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
qualifierId	Model	Optional	Expand Create custom project — request body — body template project pcri
qualifierType	Model	Optional	Expand Create custom project — request body — body template project pcri
rendererType	string	Optional	The renderer type of the field
required	boolean	Optional	Whether the field is required

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body / template / field / customFieldDefinitions, fieldLayoutScheme, fieldLayouts, fieldScheme, issueLayouts, issueTypeScreenScheme, screenScheme, screens / issueLayouts / The issue layouts configuration / item / issueLayoutType: ISSUE VIEW, ISSUE CREATE, REQUEST FORM items item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the payload to configure the issue layout item for a project. Additional keys: not allowed
itemKey	Model	Optional	Expand Create custom project — request body — body template project pcri
properties	object	Optional	Additional properties for this item. This field is only used when the type is FIELD. Additional keys: see wildcard field
properties.*	JSON	Additional keys	Additional properties for this item. This field is only used when the type is FIELD.
sectionType	string	Optional	The item section type One of: content, primaryContext, secondaryContext
type	string	Optional	The item type. Currently only support FIELD One of: FIELD

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body / template / notification / onConflict: FAIL, USE, NEW notification Scheme Events item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a notification scheme event. Defines which notifications should be sent for a specific event Additional keys: not allowed
event	Model	Optional	Expand Create custom project — request body — body / template / notification / onConflict: FAIL, USE, NEW notification Scheme Events item event
notifications	array	Optional	The configuration for notification recipents
notifications[]	Model	Each item	Expand Create custom project — request body — body / template / notification / onConflict: FAIL, USE, NEW notification Scheme Events item notifications item

Referenced models: Create custom project — request body — body / template / notification / onConflict: FAIL, USE, NEW notification Scheme Events item event, Create custom project — request body — body / template / notification / onConflict: FAIL, USE, NEW notification Scheme Events item notifications item

Create custom project — request body — body / template / notification / onConflict: FAIL, USE, NEW notification Scheme Events item event

Field	Type	Presence	Description and constraints
$	object	Root	The event ID to use for reference in the payload Additional keys: not allowed
id	string	Optional	The event ID to use for reference in the payload

Create custom project — request body — body / template / notification / onConflict: FAIL, USE, NEW notification Scheme Events item notifications item

Field	Type	Presence	Description and constraints
$	object	Root	The configuration for notification recipents Additional keys: not allowed
notificationType	string	Optional	The type of notification.
parameter	string	Optional	The parameter of the notification, should be eiither null if not required, or PCRI.

Create custom project — request body — body / template / permissionScheme / onConflict: FAIL, USE, NEW grants item

Field	Type	Presence	Description and constraints
$	object	Root	List of permission grants Additional keys: not allowed
applicationAccess	array	Optional	Unique items: true
applicationAccess[]	string	Each item
groupCustomFields	array	Optional	Unique items: true
groupCustomFields[]	Model	Each item	Expand Create custom project — request body — body template project pcri
groups	array	Optional	Unique items: true
groups[]	Model	Each item	Expand Create custom project — request body — body template project pcri
permissionKeys	array	Optional	Unique items: true
permissionKeys[]	string	Each item
projectRoles	array	Optional	Unique items: true
projectRoles[]	Model	Each item	Expand Create custom project — request body — body template project pcri
specialGrants	array	Optional	Unique items: true
specialGrants[]	string	Each item
userCustomFields	array	Optional	Unique items: true
userCustomFields[]	Model	Each item	Expand Create custom project — request body — body template project pcri
users	array	Optional	Unique items: true
users[]	Model	Each item	Expand Create custom project — request body — body template project pcri

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body details

Field	Type	Presence	Description and constraints
$	object	Root	Project Details Additional keys: not allowed
accessLevel	string	Optional	The access level of the project. Only used by team-managed project One of: open, limited, private, free
additionalProperties	object	Optional	Additional properties of the project Additional keys: see wildcard field
additionalProperties.*	string	Additional keys	Additional properties of the project
assigneeType	string	Optional	The default assignee when creating issues in the project One of: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED
avatarId	integer	Optional	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. Format: int64
categoryId	integer	Optional	The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation. Format: int64
description	string	Optional	Brief description of the project
enableComponents	boolean	Optional	Whether components are enabled for the project. Only used by company-managed project Default: false
key	string	Optional	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.
language	string	Optional	The default language for the project
leadAccountId	string	Optional	The account ID of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be provided with `lead`.
name	string	Optional	Name of the project
url	string	Optional	A link to information about this project, such as project documentation

Create custom project — request body — body template

Field	Type	Presence	Description and constraints
$	object	Root	The specific request object for creating a project with template. Additional keys: not allowed
boardFeatures	Model	Optional	Expand Create custom project — request body — body template board Features
boards	Model	Optional	Expand Create custom project — request body — body template boards
field	Model	Optional	Expand Create custom project — request body — body template field
issueType	Model	Optional	Expand Create custom project — request body — body template issue Type
notification	Model	Optional	Expand Create custom project — request body — body template notification
permissionScheme	Model	Optional	Expand Create custom project — request body — body template permission Scheme
project	Model	Optional	Expand Create custom project — request body — body template project
role	Model	Optional	Expand Create custom project — request body — body template role
scope	Model	Optional	Expand Create custom project — request body — body template scope
security	Model	Optional	Expand Create custom project — request body — body template security
workflow	Model	Optional	Expand Create custom project — request body — body template workflow

Referenced models: Create custom project — request body — body template board Features, Create custom project — request body — body template boards, Create custom project — request body — body template field, Create custom project — request body — body template issue Type, Create custom project — request body — body template notification, Create custom project — request body — body template permission Scheme, Create custom project — request body — body template project, Create custom project — request body — body template role, Create custom project — request body — body template scope, Create custom project — request body — body template security, Create custom project — request body — body template workflow

Create custom project — request body — body template board Features

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Configuration of features for one or more boards. Replaces the deprecated features field on BoardPayload Additional keys: not allowed
$ (anyOf 1).boardFeatures	object	Optional	A map of board PCRIs to the list of features to enable on each board. Additional keys: see wildcard field
$ (anyOf 1).boardFeatures.*	array	Additional keys	A map of board PCRIs to the list of features to enable on each board.
$ (anyOf 1).boardFeatures.*[]	Model	Each item	Expand Create custom project — request body — body template board Features board Features board Features value item
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template board Features board Features board Features value item

Create custom project — request body — body template board Features board Features board Features value item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for setting a board feature Additional keys: not allowed
featureKey	string	Optional	The key of the feature One of: ESTIMATION, SPRINTS
state	boolean	Optional	Whether the feature should be turned on or off One of: true, false

Create custom project — request body — body template boards

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Additional keys: not allowed
$ (anyOf 1).boards	array	Optional	The boards to be associated with the project.
$ (anyOf 1).boards[]	Model	Each item	Expand Create custom project — request body — body template boards boards boards item
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template boards boards boards item

Create custom project — request body — body template boards boards boards item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a board Additional keys: not allowed
boardFilterJQL	string	Optional	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
cardColorStrategy	string	Optional	Card color settings of the board One of: ISSUE_TYPE, REQUEST_TYPE, ASSIGNEE, PRIORITY, NONE, CUSTOM
cardLayout	Model	Optional	Expand Create custom project — request body — body template boards boards boards item card Layout
cardLayouts	array	Optional	Card layout settings of the board
cardLayouts[]	Model	Each item	Expand Create custom project — request body — body template boards boards boards item card Layouts item
columns	array	Optional	The columns of the board
columns[]	Model	Each item	Expand Create custom project — request body — body template boards boards boards item columns item
enableCardCover	boolean	Optional	Whether to enable the card cover option on this board
features	array	Optional	Feature settings for the board. Deprecated: use boardFeatures capability instead.
features[]	Model	Each item	Expand Create custom project — request body — body template board Features board Features board Features value item
name	string	Optional	The name of the board
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
quickFilters	array	Optional	The quick filters for the board.
quickFilters[]	Model	Each item	Expand Create custom project — request body — body template boards boards boards item quick Filters item
supportsSprint	boolean	Optional	Whether sprints are supported on the board Default: true
swimlanes	Model	Optional	Expand Create custom project — request body — body template boards boards boards item swimlanes
workingDaysConfig	Model	Optional	Expand Create custom project — request body — body template boards boards boards item working Days Config

Referenced models: Create custom project — request body — body template boards boards boards item columns item, Create custom project — request body — body template board Features board Features board Features value item, Create custom project — request body — body template boards boards boards item card Layout, Create custom project — request body — body template boards boards boards item card Layouts item, Create custom project — request body — body template project pcri, Create custom project — request body — body template boards boards boards item quick Filters item, Create custom project — request body — body template boards boards boards item swimlanes, Create custom project — request body — body template boards boards boards item working Days Config

Create custom project — request body — body template boards boards boards item card Layout

Field	Type	Presence	Description and constraints
$	object	Root	Card layout configuration. Additional keys: not allowed
showDaysInColumn	boolean	Optional	Whether to show days in column Default: false One of: true, false

Create custom project — request body — body template boards boards boards item card Layouts item

Field	Type	Presence	Description and constraints
$	object	Root	Card layout settings of the board Additional keys: not allowed
fieldId	string	Optional
id	integer	Optional	Format: int64
mode	string	Optional	One of: PLAN, WORK
position	integer	Optional	Format: int32

Create custom project — request body — body template boards boards boards item columns item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a board column Additional keys: not allowed
maximumIssueConstraint	integer	Optional	The maximum issue constraint for the column Format: int64
minimumIssueConstraint	integer	Optional	The minimum issue constraint for the column Format: int64
name	string	Optional	The name of the column
statusIds	array	Optional	The status IDs for the column
statusIds[]	Model	Each item	Expand Create custom project — request body — body template project pcri

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template boards boards boards item quick Filters item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for defining quick filters Additional keys: not allowed
description	string	Optional	The description of the quick filter
jqlQuery	string	Optional	The jql query for the quick filter
name	string	Optional	The name of the quick filter

Create custom project — request body — body template boards boards boards item swimlanes

Field	Type	Presence	Description and constraints
$	object	Root	The payload for customising a swimlanes on a board Additional keys: not allowed
customSwimlanes	array	Optional	The custom swimlane definitions.
customSwimlanes[]	Model	Each item	Expand Create custom project — request body — body template boards boards boards item swimlanes custom Swimlanes item
defaultCustomSwimlaneName	string	Optional	The name of the custom swimlane to use for work items that don't match any other swimlanes.
swimlaneStrategy	string	Optional	The swimlane strategy for the board. One of: none, custom, parentChild, assignee, assigneeUnassignedFirst, epic, project, issueparent, issuechildren, request_type

Referenced models: Create custom project — request body — body template boards boards boards item swimlanes custom Swimlanes item

Create custom project — request body — body template boards boards boards item swimlanes custom Swimlanes item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for custom swimlanes Additional keys: not allowed
description	string	Optional	The description of the quick filter
jqlQuery	string	Optional	The jql query for the quick filter
name	string	Optional	The name of the quick filter

Create custom project — request body — body template boards boards boards item working Days Config

Field	Type	Presence	Description and constraints
$	object	Root	Working days configuration Additional keys: not allowed
friday	boolean	Optional
id	integer	Optional	Format: int64
monday	boolean	Optional
nonWorkingDays	array	Optional	Unique items: true
nonWorkingDays[]	Model	Each item	Expand Create custom project — request body — body template boards boards boards item working Days Config non Working Days item
saturday	boolean	Optional
sunday	boolean	Optional
thursday	boolean	Optional
timezoneId	string	Optional
tuesday	boolean	Optional
wednesday	boolean	Optional

Referenced models: Create custom project — request body — body template boards boards boards item working Days Config non Working Days item

Create custom project — request body — body template boards boards boards item working Days Config non Working Days item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
id	integer	Optional	Format: int64
iso8601Date	string	Optional

Create custom project — request body — body template field

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Defines the payload for the fields, screens, screen schemes, issue type screen schemes, field layouts, and field layout schemes Additional keys: not allowed
$ (anyOf 1).customFieldDefinitions	JSON	Optional
$ (anyOf 1).customFieldDefinitions (anyOf 1)	array	Alternative	The custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/\#api-rest-api-3-field-post
$ (anyOf 1).customFieldDefinitions (anyOf 1)[]	Model	Each item	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens custom Field Definitions array item
$ (anyOf 1).customFieldDefinitions (anyOf 2)	null	Alternative
$ (anyOf 1).fieldLayoutScheme	Model	Optional	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Layout Scheme
$ (anyOf 1).fieldLayouts	JSON	Optional
$ (anyOf 1).fieldLayouts (anyOf 1)	array	Alternative	The field layouts configuration.
$ (anyOf 1).fieldLayouts (anyOf 1)[]	Model	Each item	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Layouts The field layouts configuration item
$ (anyOf 1).fieldLayouts (anyOf 2)	null	Alternative
$ (anyOf 1).fieldScheme	Model	Optional	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Scheme
$ (anyOf 1).issueLayouts	JSON	Optional
$ (anyOf 1).issueLayouts (anyOf 1)	array	Alternative	The issue layouts configuration
$ (anyOf 1).issueLayouts (anyOf 1)[]	Model	Each item	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens issue Layouts The issue layouts configuration item
$ (anyOf 1).issueLayouts (anyOf 2)	null	Alternative
$ (anyOf 1).issueTypeScreenScheme	Model	Optional	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens issue Type Screen Scheme
$ (anyOf 1).screenScheme	JSON	Optional
$ (anyOf 1).screenScheme (anyOf 1)	array	Alternative	The screen schemes See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes/\#api-rest-api-3-screenscheme-post
$ (anyOf 1).screenScheme (anyOf 1)[]	Model	Each item	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens screen Scheme array item
$ (anyOf 1).screenScheme (anyOf 2)	null	Alternative
$ (anyOf 1).screens	JSON	Optional
$ (anyOf 1).screens (anyOf 1)	array	Alternative	The screens. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens/\#api-rest-api-3-screens-post
$ (anyOf 1).screens (anyOf 1)[]	Model	Each item	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens screens array item
$ (anyOf 1).screens (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens custom Field Definitions array item, Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Layouts The field layouts configuration item, Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Layout Scheme, Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Scheme, Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens issue Layouts The issue layouts configuration item, Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens issue Type Screen Scheme, Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens screens array item, Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens screen Scheme array item

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens custom Field Definitions array item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Defines the payload for the custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/\#api-rest-api-3-field-post Additional keys: not allowed
$ (anyOf 1).cfType	string	Optional	The type of the custom field
$ (anyOf 1).description	string	Optional	The description of the custom field
$ (anyOf 1).name	string	Optional	The name of the custom field
$ (anyOf 1).onConflict	string	Optional	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 One of: FAIL, USE, NEW
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).scope	string	Optional	Allows an overwrite to declare the new Custom Field to be created as a GLOBAL-scoped field. Leave this as empty or null to use the project's default scope. One of: GLOBAL, TEMPLATE, PROJECT
$ (anyOf 1).searcherKey	string	Optional	The searcher key of the custom field
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Layout Scheme

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Deprecated use [fieldAssociationScheme](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) instead 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). [ How to configure a field configuration scheme](https://support.atlassian.com/jira-cloud-administration/docs/configure-a-field-configuration-scheme/). Additional keys: not allowed
$ (anyOf 1).defaultFieldLayout	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).description	string	Optional	The description of the field layout scheme
$ (anyOf 1).explicitMappings	object	Optional	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 Additional keys: see wildcard field
$ (anyOf 1).explicitMappings.*	Model	Additional keys	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).name	string	Optional	The name of the field layout scheme
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Layouts The field layouts configuration item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Defines the payload for the field layouts. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-group-issue-field-configurations" + fieldlayout is what users would see as "Field Configuration" in Jira's UI - https://support.atlassian.com/jira-cloud-administration/docs/manage-issue-field-configurations/ Additional keys: not allowed
$ (anyOf 1).configuration	array	Optional	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
$ (anyOf 1).configuration[]	Model	Each item	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Layouts The field layouts configuration item configuration, description, name, pcri configuration item
$ (anyOf 1).description	string	Optional	The description of the field layout
$ (anyOf 1).name	string	Optional	The name of the field layout
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Layouts The field layouts configuration item configuration, description, name, pcri configuration item, Create custom project — request body — body template project pcri

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Layouts The field layouts configuration item configuration, description, name, pcri configuration item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the payload for 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 Additional keys: not allowed
field	boolean	Optional	Whether to show the field
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
required	boolean	Optional	Whether the field is required

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens field Scheme

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Defines the payload to configure the field scheme for a project. See [Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes). Additional keys: not allowed
$ (anyOf 1).description	string	Optional	The description of the field scheme
$ (anyOf 1).items	array	Optional	The field association items for this field scheme.
$ (anyOf 1).items[]	Model	Each item	Expand Create custom project — request body — body / template / field / customFieldDefinitions, fieldLayoutScheme, fieldLayouts, fieldScheme, issueLayouts, issueTypeScreenScheme, screenScheme, screens / fieldScheme / onConflict: FAIL, USE, NEW items item
$ (anyOf 1).name	string	Optional	The name of the field scheme
$ (anyOf 1).onConflict	string	Optional	The strategy to use when there is a conflict with an existing field scheme. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters One of: FAIL, USE, NEW
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body / template / field / customFieldDefinitions, fieldLayoutScheme, fieldLayouts, fieldScheme, issueLayouts, issueTypeScreenScheme, screenScheme, screens / fieldScheme / onConflict: FAIL, USE, NEW items item, Create custom project — request body — body template project pcri

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens issue Layouts The issue layouts configuration item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Defines the payload to configure the issue layouts for a project. Additional keys: not allowed
$ (anyOf 1).containerId	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).issueLayoutType	string	Optional	The issue layout type One of: ISSUE_VIEW, ISSUE_CREATE, REQUEST_FORM
$ (anyOf 1).items	array	Optional	The configuration of items in the issue layout
$ (anyOf 1).items[]	Model	Each item	Expand Create custom project — request body — body / template / field / customFieldDefinitions, fieldLayoutScheme, fieldLayouts, fieldScheme, issueLayouts, issueTypeScreenScheme, screenScheme, screens / issueLayouts / The issue layouts configuration / item / issueLayoutType: ISSUE VIEW, ISSUE CREATE, REQUEST FORM items item
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body / template / field / customFieldDefinitions, fieldLayoutScheme, fieldLayouts, fieldScheme, issueLayouts, issueTypeScreenScheme, screenScheme, screens / issueLayouts / The issue layouts configuration / item / issueLayoutType: ISSUE VIEW, ISSUE CREATE, REQUEST FORM items item, Create custom project — request body — body template project pcri

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens issue Type Screen Scheme

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	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 Additional keys: not allowed
$ (anyOf 1).defaultScreenScheme	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).description	string	Optional	The description of the issue type screen scheme
$ (anyOf 1).explicitMappings	object	Optional	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. Additional keys: see wildcard field
$ (anyOf 1).explicitMappings.*	Model	Additional keys	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).name	string	Optional	The name of the issue type screen scheme
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens screen Scheme array item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Defines the payload for the screen schemes. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes/\#api-rest-api-3-screenscheme-post Additional keys: not allowed
$ (anyOf 1).defaultScreen	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).description	string	Optional	The description of the screen scheme
$ (anyOf 1).name	string	Optional	The name of the screen scheme
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).screens	object	Optional	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 `create`, `view`, `edit` - specific operations that are available and users can assign a different screen for each one of them https://support.atlassian.com/jira-cloud-administration/docs/manage-screen-schemes/\#Associating-a-screen-with-an-issue-operation Additional keys: see wildcard field
$ (anyOf 1).screens.*	Model	Additional keys	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens screens array item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Defines the payload for the field screens. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens/\#api-rest-api-3-screens-post Additional keys: not allowed
$ (anyOf 1).description	string	Optional	The description of the screen
$ (anyOf 1).name	string	Optional	The name of the screen
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).tabs	array	Optional	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
$ (anyOf 1).tabs[]	Model	Each item	Expand Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens screens array item description, name, pcri, tabs tabs item
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template project pcri, Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens screens array item description, name, pcri, tabs tabs item

Create custom project — request body — body template field custom Field Definitions, field Layout Scheme, field Layouts, field Scheme, issue Layouts, issue Type Screen Scheme, screen Scheme, screens screens array item description, name, pcri, tabs tabs item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the payload for 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 Additional keys: not allowed
fields	array	Optional	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
fields[]	Model	Each item	Expand Create custom project — request body — body template project pcri
name	string	Optional	The name of the tab

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template issue Type

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The payload for creating issue types in a project Additional keys: not allowed
$ (anyOf 1).issueTypeHierarchy	JSON	Optional
$ (anyOf 1).issueTypeHierarchy (anyOf 1)	array	Alternative	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
$ (anyOf 1).issueTypeHierarchy (anyOf 1)[]	Model	Each item	Expand Create custom project — request body — body template issue Type The payload for creating issue types in a project issue Type Hierarchy array item
$ (anyOf 1).issueTypeHierarchy (anyOf 2)	null	Alternative
$ (anyOf 1).issueTypeScheme	Model	Optional	Expand Create custom project — request body — body template issue Type The payload for creating issue types in a project issue Type Scheme
$ (anyOf 1).issueTypes	JSON	Optional
$ (anyOf 1).issueTypes (anyOf 1)	array	Alternative	Only needed if you want to create issue types, you can otherwise use the ids of issue types in the scheme configuration
$ (anyOf 1).issueTypes (anyOf 1)[]	Model	Each item	Expand Create custom project — request body — body template issue Type The payload for creating issue types in a project issue Types array item
$ (anyOf 1).issueTypes (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template issue Type The payload for creating issue types in a project issue Type Hierarchy array item, Create custom project — request body — body template issue Type The payload for creating issue types in a project issue Types array item, Create custom project — request body — body template issue Type The payload for creating issue types in a project issue Type Scheme

Create custom project — request body — body template issue Type The payload for creating issue types in a project issue Type Hierarchy array item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The payload for creating an issue type hierarchy Additional keys: not allowed
$ (anyOf 1).hierarchyLevel	integer	Optional	The hierarchy level of the issue type. 0, 1, 2, 3 .. n; Negative values for subtasks Format: int32
$ (anyOf 1).name	string	Optional	The name of the issue type
$ (anyOf 1).onConflict	string	Optional	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 One of: FAIL, USE, NEW
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template issue Type The payload for creating issue types in a project issue Type Scheme

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating issue type schemes Additional keys: not allowed
defaultIssueTypeId	Model	Optional	Expand Create custom project — request body — body template project pcri
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the issue type scheme
description (anyOf 2)	null	Alternative
issueTypeIds	array	Optional	The issue type IDs for the issue type scheme
issueTypeIds[]	Model	Each item	Expand Create custom project — request body — body template project pcri
name	string	Optional	The name of the issue type scheme
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template issue Type The payload for creating issue types in a project issue Types array item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The payload for creating an issue type Additional keys: not allowed
$ (anyOf 1).avatarId	JSON	Optional
$ (anyOf 1).avatarId (anyOf 1)	integer	Alternative	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 Format: int64
$ (anyOf 1).avatarId (anyOf 2)	null	Alternative
$ (anyOf 1).description	JSON	Optional
$ (anyOf 1).description (anyOf 1)	string	Alternative	The description of the issue type
$ (anyOf 1).description (anyOf 2)	null	Alternative
$ (anyOf 1).hierarchyLevel	integer	Optional	The hierarchy level of the issue type. 0, 1, 2, 3 .. n; Negative values for subtasks Format: int32
$ (anyOf 1).name	string	Optional	The name of the issue type
$ (anyOf 1).onConflict	string	Optional	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 One of: FAIL, USE, NEW
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template notification

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	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 Additional keys: not allowed
$ (anyOf 1).description	string	Optional	The description of the notification scheme
$ (anyOf 1).name	string	Optional	The name of the notification scheme
$ (anyOf 1).notificationSchemeEvents	array	Optional	The events and notifications for the notification scheme
$ (anyOf 1).notificationSchemeEvents[]	Model	Each item	Expand Create custom project — request body — body / template / notification / onConflict: FAIL, USE, NEW notification Scheme Events item
$ (anyOf 1).onConflict	string	Optional	The strategy to use when there is a conflict with an existing entity One of: FAIL, USE, NEW
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body / template / notification / onConflict: FAIL, USE, NEW notification Scheme Events item, Create custom project — request body — body template project pcri

Create custom project — request body — body template permission Scheme

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The payload to create a permission scheme Additional keys: not allowed
$ (anyOf 1).addAddonRole	boolean	Optional	Configuration to generate addon role. Default is false if null. Only applies to GLOBAL-scoped permission scheme
$ (anyOf 1).description	string	Optional	The description of the permission scheme
$ (anyOf 1).grants	array	Optional	List of permission grants Unique items: true
$ (anyOf 1).grants[]	Model	Each item	Expand Create custom project — request body — body / template / permissionScheme / onConflict: FAIL, USE, NEW grants item
$ (anyOf 1).name	string	Optional	The name of the permission scheme
$ (anyOf 1).onConflict	string	Optional	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 Default: FAIL One of: FAIL, USE, NEW
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body / template / permissionScheme / onConflict: FAIL, USE, NEW grants item, Create custom project — request body — body template project pcri

Create custom project — request body — body template project

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a project Additional keys: not allowed
fieldLayoutSchemeId	Model	Optional	Expand Create custom project — request body — body template project pcri
issueSecuritySchemeId	Model	Optional	Expand Create custom project — request body — body template project pcri
issueTypeSchemeId	Model	Optional	Expand Create custom project — request body — body template project pcri
issueTypeScreenSchemeId	Model	Optional	Expand Create custom project — request body — body template project pcri
notificationSchemeId	Model	Optional	Expand Create custom project — request body — body template project pcri
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
permissionSchemeId	Model	Optional	Expand Create custom project — request body — body template project pcri
projectTypeKey	string	Optional	The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which defines the application-specific feature set. If you don't specify the project template you have to specify the project type. One of: software, business, service_desk, product_discovery
workflowSchemeId	Model	Optional	Expand Create custom project — request body — body template project pcri

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template project pcri

Field	Type	Presence	Description and constraints
$	object	Root	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 `id` - The ID of an entity that already exists in the target site, or `ref` - A unique reference to an entity that is being created entityId - entity identifier, if type is `id` - must be an existing entity ID that exists in the Jira site, if `ref` - must be unique across all entities in the scope of this project template creation Additional keys: not allowed
anID	boolean	Optional
areference	boolean	Optional
entityId	string	Optional
entityType	string	Optional
id	string	Optional
type	string	Optional	One of: id, ref

Create custom project — request body — body template role

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Additional keys: not allowed
$ (anyOf 1).roleToProjectActors	object	Optional	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. Additional keys: see wildcard field
$ (anyOf 1).roleToProjectActors.*	array	Additional keys	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.
$ (anyOf 1).roleToProjectActors.*[]	Model	Each item	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).roles	array	Optional	The list of roles to create.
$ (anyOf 1).roles[]	Model	Each item	Expand Create custom project — request body — body template role role To Project Actors, roles roles item
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template project pcri, Create custom project — request body — body template role role To Project Actors, roles roles item

Create custom project — request body — body template role role To Project Actors, roles roles item

Field	Type	Presence	Description and constraints
$	object	Root	The payload used to create a project role. It is optional for CMP projects, as a default role actor will be provided. TMP will add new role actors to the table. Additional keys: not allowed
defaultActors	array	Optional	The default actors for the role. By adding default actors, the role will be added to any future projects created
defaultActors[]	Model	Each item	Expand Create custom project — request body — body template project pcri
description	string	Optional	The description of the role
name	string	Optional	The name of the role
onConflict	string	Optional	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 Default: USE One of: FAIL, USE, NEW
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
type	string	Optional	The type of the role. Only used by project-scoped project One of: HIDDEN, VIEWABLE, AI_AGENT, EDITABLE, GUEST

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template scope

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The payload for creating a scope. Defines if a project is team-managed project or company-managed project Additional keys: not allowed
$ (anyOf 1).type	string	Optional	The type of the scope. Use `GLOBAL` or empty for company-managed project, and `PROJECT` for team-managed project One of: GLOBAL, PROJECT
$ (anyOf 2)	null	Alternative

Create custom project — request body — body template security

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The payload for creating a security scheme. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/ Additional keys: not allowed
$ (anyOf 1).description	string	Optional	The description of the security scheme
$ (anyOf 1).name	string	Optional	The name of the security scheme
$ (anyOf 1).pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
$ (anyOf 1).securityLevels	array	Optional	The security levels for the security scheme
$ (anyOf 1).securityLevels[]	Model	Each item	Expand Create custom project — request body — body template security description, name, pcri, security Levels security Levels item
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template project pcri, Create custom project — request body — body template security description, name, pcri, security Levels security Levels item

Create custom project — request body — body template security description, name, pcri, security Levels security Levels item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a security level. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/ Additional keys: not allowed
description	string	Optional	The description of the security level
isDefault	boolean	Optional	Whether the security level is default for the security scheme One of: true, false
name	string	Optional	The name of the security level
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
securityLevelMembers	array	Optional	The members of the security level
securityLevelMembers[]	Model	Each item	Expand Create custom project — request body — body template security description, name, pcri, security Levels security Levels item security Level Members item

Referenced models: Create custom project — request body — body template project pcri, Create custom project — request body — body template security description, name, pcri, security Levels security Levels item security Level Members item

Create custom project — request body — body template security description, name, pcri, security Levels security Levels item security Level Members item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a security level member. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/ Additional keys: not allowed
parameter	string	Optional	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"\}
type	string	Optional	The type of the security level member One of: group, reporter, users

Create custom project — request body — body template workflow

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The payload for creating a workflows. See https://www.atlassian.com/software/jira/guides/workflows/overview\#what-is-a-jira-workflow Additional keys: not allowed
$ (anyOf 1).statuses	array	Optional	The statuses for the workflow
$ (anyOf 1).statuses[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows statuses item
$ (anyOf 1).workflowScheme	Model	Optional	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflow Scheme
$ (anyOf 1).workflows	array	Optional	The transitions for the workflow
$ (anyOf 1).workflows[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item
$ (anyOf 2)	null	Alternative

Referenced models: Create custom project — request body — body template workflow statuses, workflow Scheme, workflows statuses item, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflow Scheme

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows statuses item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a status Additional keys: not allowed
description	string	Optional	The description of the status
name	string	Optional	The name of the status
onConflict	string	Optional	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 One of: FAIL, USE, NEW
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
scope	string	Optional	The scope of the status. Set to GLOBAL to make the status shared across projects. Leave null for the default (project-scoped) behaviour. One of: GLOBAL
statusCategory	string	Optional	The status category of the status. The value is case-sensitive. One of: TODO, IN_PROGRESS, DONE

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflow Scheme

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a workflow scheme. See https://www.atlassian.com/software/jira/guides/workflows/overview\#what-is-a-jira-workflow-scheme Additional keys: not allowed
defaultWorkflow	Model	Optional	Expand Create custom project — request body — body template project pcri
description	string	Optional	The description of the workflow scheme
explicitMappings	object	Optional	Association between issuetypes and workflows Additional keys: see wildcard field
explicitMappings.*	Model	Additional keys	Expand Create custom project — request body — body template project pcri
name	string	Optional	The name of the workflow scheme
onConflict	string	Optional	The strategy to use if there is a conflict with another workflow scheme One of: FAIL, USE, NEW
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating workflow, see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/\#api-rest-api-3-workflows-create-post Additional keys: not allowed
description	string	Optional	The description of the workflow
loopedTransitionContainerLayout	Model	Optional	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item start Point Layout
name	string	Optional	The name of the workflow
onConflict	string	Optional	The strategy to use if there is a conflict with another workflow Default: NEW One of: FAIL, USE, NEW
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
startPointLayout	Model	Optional	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item start Point Layout
statuses	array	Optional	The statuses to be used in the workflow
statuses[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item statuses item
transitions	array	Optional	The transitions for the workflow
transitions[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item

Referenced models: Create custom project — request body — body template project pcri, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item start Point Layout, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item statuses item

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item start Point Layout

Field	Type	Presence	Description and constraints
$	object	Root	The layout of the workflow status. Additional keys: not allowed
x	number	Optional	The x coordinate of the status. Format: double
y	number	Optional	The y coordinate of the status. Format: double

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item statuses item

Field	Type	Presence	Description and constraints
$	object	Root	The statuses to be used in the workflow Additional keys: not allowed
layout	Model	Optional	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item start Point Layout
pcri	Model	Optional	Expand Create custom project — request body — body template project pcri
properties	object	Optional	The properties of the workflow status. Additional keys: see wildcard field
properties.*	string	Additional keys	The properties of the workflow status.

Referenced models: Create custom project — request body — body template project pcri, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item start Point Layout

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a transition in a workflow. Can be DIRECTED, GLOBAL, SELF-LOOPED, GLOBAL LOOPED Additional keys: not allowed
actions	array	Optional	The actions that are performed when the transition is made
actions[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item transition Screen
conditions	Model	Optional	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item conditions
customIssueEventId	string	Optional	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
description	string	Optional	The description of the transition
from	array	Optional	The statuses that the transition can be made from
from[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item from item
id	integer	Optional	The id of the transition Format: int32
name	string	Optional	The name of the transition
properties	object	Optional	The properties of the transition Additional keys: see wildcard field
properties.*	string	Additional keys	The properties of the transition
to	Model	Optional	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item to
transitionScreen	Model	Optional	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item transition Screen
triggers	array	Optional	The triggers that are performed when the transition is made
triggers[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item transition Screen
type	string	Optional	The type of the transition One of: global, initial, directed
validators	array	Optional	The validators that are performed when the transition is made
validators[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item transition Screen

Referenced models: Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item conditions, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item from item, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item transition Screen, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item to

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item conditions

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating a condition group in a workflow Additional keys: not allowed
conditionGroup	array	Optional	The nested conditions of the condition group.
conditionGroup[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item conditions
conditions	array	Optional	The rules for this condition.
conditions[]	Model	Each item	Expand Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item transition Screen
operation	string	Optional	Determines how the conditions in the group are evaluated. Accepts either `ANY` or `ALL`. If `ANY` is used, at least one condition in the group must be true for the group to evaluate to true. If `ALL` is used, all conditions in the group must be true for the group to evaluate to true. One of: ANY, ALL

Referenced models: Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item conditions, Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item transition Screen

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item from item

Field	Type	Presence	Description and constraints
$	object	Root	The payload for the layout details for the start end of a transition Additional keys: not allowed
fromPort	integer	Optional	The port that the transition can be made from Format: int32
status	Model	Optional	Expand Create custom project — request body — body template project pcri
toPortOverride	integer	Optional	The port that the transition goes to Format: int32

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item to

Field	Type	Presence	Description and constraints
$	object	Root	The payload for the layout details for the destination end of a transition Additional keys: not allowed
port	integer	Optional	Defines where the transition line will be connected to a status. Port 0 to 7 are acceptable values. Format: int32
status	Model	Optional	Expand Create custom project — request body — body template project pcri

Referenced models: Create custom project — request body — body template project pcri

Create custom project — request body — body template workflow statuses, workflow Scheme, workflows workflows item transitions item transition Screen

Field	Type	Presence	Description and constraints
$	object	Root	The payload for creating rules in a workflow Additional keys: not allowed
parameters	object	Optional	The parameters of the rule Additional keys: see wildcard field
parameters.*	string	Additional keys	The parameters of the rule
ruleKey	string	Optional	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

Edit a custom project template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request to edit a custom template Additional keys: not allowed
templateDescription	string	Optional	The description of the template Maximum length: 150
templateGenerationOptions	Model	Optional	Expand Edit a custom project template — request body — body template Generation Options
templateKey	string	Optional	The unique identifier of the template
templateName	string	Optional	The name of the template Maximum length: 50

Referenced models: Edit a custom project template — request body — body template Generation Options

Edit a custom project template — request body — body template Generation Options

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
enableScreenDelegatedAdminSupport	boolean	Optional	Enable screen delegated admin support for the template. This means screen and associated schemes will be copied rather than referenced.
enableWorkflowDelegatedAdminSupport	boolean	Optional	Enable workflow delegated admin support for the template. This means workflows and workflow schemes will be copied rather than referenced.

Gets a custom project template — response body

Field	Type	Presence	Description and constraints
$	object	Root
archetype	JSON	Optional
archetype (anyOf 1)	Model	Alternative	Expand Gets a custom project template — response body — archetype real Type, style, type
archetype (anyOf 2)	null	Alternative
defaultBoardView	JSON	Optional
defaultBoardView (anyOf 1)	string	Alternative
defaultBoardView (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
liveTemplateProjectIdReference	JSON	Optional
liveTemplateProjectIdReference (anyOf 1)	JSON	Alternative
liveTemplateProjectIdReference (anyOf 1) (anyOf 1)	integer	Alternative	Format: int64
liveTemplateProjectIdReference (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
liveTemplateProjectIdReference (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative
name (anyOf 2)	null	Alternative
projectTemplateKey	JSON	Optional
projectTemplateKey (anyOf 1)	Model	Alternative	Expand Gets a custom project template — response body — project Template Key key, uuid
projectTemplateKey (anyOf 2)	null	Alternative
snapshotTemplate	JSON	Optional
snapshotTemplate (anyOf 1)	object	Alternative	Additional keys: see wildcard field
snapshotTemplate (anyOf 1).*	JSON	Additional keys
snapshotTemplate (anyOf 2)	null	Alternative
templateGenerationOptions	JSON	Optional
templateGenerationOptions (anyOf 1)	Model	Alternative	Expand Gets a custom project template — response body — template Generation Options enable Screen Delegated Admin Support, enable Workflow Delegated Admin Support
templateGenerationOptions (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	Known values: LIVE, SNAPSHOT
type (anyOf 2)	null	Alternative

Referenced models: Gets a custom project template — response body — template Generation Options enable Screen Delegated Admin Support, enable Workflow Delegated Admin Support, Gets a custom project template — response body — archetype real Type, style, type, Gets a custom project template — response body — project Template Key key, uuid

Gets a custom project template — response body — archetype real Type, style, type

Field	Type	Presence	Description and constraints
$	object	Root
realType	JSON	Optional
realType (anyOf 1)	string	Alternative	Known values: BUSINESS, SOFTWARE, PRODUCT_DISCOVERY, SERVICE_DESK, CUSTOMER_SERVICE, OPS
realType (anyOf 2)	null	Alternative
style	JSON	Optional
style (anyOf 1)	string	Alternative	Known values: classic, next-gen
style (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	Known values: BUSINESS, SOFTWARE, PRODUCT_DISCOVERY, SERVICE_DESK, CUSTOMER_SERVICE, OPS
type (anyOf 2)	null	Alternative

Gets a custom project template — response body — project Template Key key, uuid

Field	Type	Presence	Description and constraints
$	object	Root
key	JSON	Optional
key (anyOf 1)	string	Alternative
key (anyOf 2)	null	Alternative
uuid	JSON	Optional
uuid (anyOf 1)	string	Alternative	Format: uuid
uuid (anyOf 2)	null	Alternative

Gets a custom project template — response body — template Generation Options enable Screen Delegated Admin Support, enable Workflow Delegated Admin Support

Field	Type	Presence	Description and constraints
$	object	Root
enableScreenDelegatedAdminSupport	JSON	Optional
enableScreenDelegatedAdminSupport (anyOf 1)	boolean	Alternative	Enable screen delegated admin support for the template. This means screen and associated schemes will be copied rather than referenced.
enableScreenDelegatedAdminSupport (anyOf 2)	null	Alternative
enableWorkflowDelegatedAdminSupport	JSON	Optional
enableWorkflowDelegatedAdminSupport (anyOf 1)	boolean	Alternative	Enable workflow delegated admin support for the template. This means workflows and workflow schemes will be copied rather than referenced.
enableWorkflowDelegatedAdminSupport (anyOf 2)	null	Alternative

Save a custom project template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request to save a custom template Additional keys: not allowed
templateDescription	string	Optional	The description of the template Maximum length: 150
templateFromProjectRequest	Model	Optional	Expand Save a custom project template — request body — body template From Project Request
templateName	string	Optional	The name of the template Maximum length: 50

Referenced models: Save a custom project template — request body — body template From Project Request

Save a custom project template — request body — body template From Project Request

Field	Type	Presence	Description and constraints
$	object	Root	The request details to generate template from a project Additional keys: not allowed
projectId	integer	Optional	The ID of the target project Format: int64
templateGenerationOptions	Model	Optional	Expand Edit a custom project template — request body — body template Generation Options
templateType	string	Optional	The type of the template: LIVE | SNAPSHOT One of: LIVE, SNAPSHOT

Referenced models: Edit a custom project template — request body — body template Generation Options

Save a custom project template — response body

Field	Type	Presence	Description and constraints
$	object	Root
projectTemplateKey	JSON	Optional
projectTemplateKey (anyOf 1)	Model	Alternative	Expand Gets a custom project template — response body — project Template Key key, uuid
projectTemplateKey (anyOf 2)	null	Alternative

Referenced models: Gets a custom project template — response body — project Template Key key, uuid