Function: createProjectWithCustomTemplate()
ts
function createProjectWithCustomTemplate(
client,
parameters,
options?
): Promise<void>;Defined in: src/cloud/api/projectTemplates.ts:26
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
Locationlink 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.
Permissions required:Administer Jira global permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { details?: { accessLevel?: "open" | "private" | string & object | "limited" | "free"; additionalProperties?: Record<string, string>; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; avatarId?: number; categoryId?: number; description?: string; enableComponents?: boolean; key?: string; language?: string; leadAccountId?: string; name?: string; url?: string; }; template?: { boardFeatures?: { boardFeatures?: Record<string, object[]>; }; boards?: { boards?: object[]; }; field?: { customFieldDefinitions?: object[] | null; fieldLayoutScheme?: { defaultFieldLayout?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; fieldScheme?: { description?: string; items?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; issueLayouts?: object[] | null; issueTypeScreenScheme?: { defaultScreenScheme?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; screens?: object[] | null; screenScheme?: object[] | null; }; issueType?: { issueTypeHierarchy?: object[] | null; issueTypes?: object[] | null; issueTypeScheme?: { defaultIssueTypeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string | null; issueTypeIds?: object[]; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; }; notification?: { description?: string; name?: string; notificationSchemeEvents?: object[]; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; }; permissionScheme?: { addAddonRole?: boolean; description?: string; grants?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; }; project?: { fieldLayoutSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; issueSecuritySchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; issueTypeSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; issueTypeScreenSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; notificationSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; permissionSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; workflowSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; }; role?: { roles?: object[]; roleToProjectActors?: Record<string, object[]>; }; scope?: { type?: string & object | "PROJECT" | "GLOBAL"; }; security?: { description?: string; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; securityLevels?: object[]; }; workflow?: { statuses?: object[]; workflows?: object[]; workflowScheme?: { defaultWorkflow?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; }; }; } | - |
parameters.details? | { accessLevel?: "open" | "private" | string & object | "limited" | "free"; additionalProperties?: Record<string, string>; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; avatarId?: number; categoryId?: number; description?: string; enableComponents?: boolean; key?: string; language?: string; leadAccountId?: string; name?: string; url?: string; } | - |
parameters.details.accessLevel? | "open" | "private" | string & object | "limited" | "free" | The access level of the project. Only used by team-managed project |
parameters.details.additionalProperties? | Record<string, string> | Additional properties of the project |
parameters.details.assigneeType? | | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED" | The default assignee when creating issues in the project |
parameters.details.avatarId? | number | The ID of the project's avatar. Use the Get project avatars operation to list the available avatars in a project. |
parameters.details.categoryId? | number | The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. |
parameters.details.description? | string | Brief description of the project |
parameters.details.enableComponents? | boolean | Whether components are enabled for the project. Only used by company-managed project |
parameters.details.key? | string | 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. |
parameters.details.language? | string | The default language for the project |
parameters.details.leadAccountId? | string | The account ID of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with lead. |
parameters.details.name? | string | Name of the project |
parameters.details.url? | string | A link to information about this project, such as project documentation |
parameters.template? | { boardFeatures?: { boardFeatures?: Record<string, object[]>; }; boards?: { boards?: object[]; }; field?: { customFieldDefinitions?: object[] | null; fieldLayoutScheme?: { defaultFieldLayout?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; fieldScheme?: { description?: string; items?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; issueLayouts?: object[] | null; issueTypeScreenScheme?: { defaultScreenScheme?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; screens?: object[] | null; screenScheme?: object[] | null; }; issueType?: { issueTypeHierarchy?: object[] | null; issueTypes?: object[] | null; issueTypeScheme?: { defaultIssueTypeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string | null; issueTypeIds?: object[]; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; }; notification?: { description?: string; name?: string; notificationSchemeEvents?: object[]; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; }; permissionScheme?: { addAddonRole?: boolean; description?: string; grants?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; }; project?: { fieldLayoutSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; issueSecuritySchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; issueTypeSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; issueTypeScreenSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; notificationSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; permissionSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; workflowSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; }; role?: { roles?: object[]; roleToProjectActors?: Record<string, object[]>; }; scope?: { type?: string & object | "PROJECT" | "GLOBAL"; }; security?: { description?: string; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; securityLevels?: object[]; }; workflow?: { statuses?: object[]; workflows?: object[]; workflowScheme?: { defaultWorkflow?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; }; } | - |
parameters.template.boardFeatures? | { boardFeatures?: Record<string, object[]>; } | - |
parameters.template.boardFeatures.boardFeatures? | Record<string, object[]> | A map of board PCRIs to the list of features to enable on each board. |
parameters.template.boards? | { boards?: object[]; } | - |
parameters.template.boards.boards? | object[] | The boards to be associated with the project. |
parameters.template.field? | { customFieldDefinitions?: object[] | null; fieldLayoutScheme?: { defaultFieldLayout?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; fieldScheme?: { description?: string; items?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; issueLayouts?: object[] | null; issueTypeScreenScheme?: { defaultScreenScheme?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; screens?: object[] | null; screenScheme?: object[] | null; } | - |
parameters.template.field.customFieldDefinitions? | object[] | null | The custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-post |
parameters.template.field.fieldLayoutScheme? | { defaultFieldLayout?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; } | - |
parameters.template.field.fieldLayoutScheme.defaultFieldLayout? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; } | - |
parameters.template.field.fieldLayoutScheme.defaultFieldLayout.anID? | boolean | - |
parameters.template.field.fieldLayoutScheme.defaultFieldLayout.areference? | boolean | - |
parameters.template.field.fieldLayoutScheme.defaultFieldLayout.entityId? | string | - |
parameters.template.field.fieldLayoutScheme.defaultFieldLayout.entityType? | string | - |
parameters.template.field.fieldLayoutScheme.defaultFieldLayout.id? | string | - |
parameters.template.field.fieldLayoutScheme.defaultFieldLayout.type? | "id" | "ref" | ... & ... | - |
parameters.template.field.fieldLayoutScheme.description? | string | The description of the field layout scheme |
parameters.template.field.fieldLayoutScheme.explicitMappings? | Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }> | 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 |
parameters.template.field.fieldLayoutScheme.name? | string | The name of the field layout scheme |
parameters.template.field.fieldLayoutScheme.pcri? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; } | - |
parameters.template.field.fieldLayoutScheme.pcri.anID? | boolean | - |
parameters.template.field.fieldLayoutScheme.pcri.areference? | boolean | - |
parameters.template.field.fieldLayoutScheme.pcri.entityId? | string | - |
parameters.template.field.fieldLayoutScheme.pcri.entityType? | string | - |
parameters.template.field.fieldLayoutScheme.pcri.id? | string | - |
parameters.template.field.fieldLayoutScheme.pcri.type? | "id" | "ref" | ... & ... | - |
parameters.template.field.fieldScheme? | { description?: string; items?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; } | - |
parameters.template.field.fieldScheme.description? | string | The description of the field scheme |
parameters.template.field.fieldScheme.items? | object[] | The field association items for this field scheme. |
parameters.template.field.fieldScheme.name? | string | The name of the field scheme |
parameters.template.field.fieldScheme.onConflict? | string & object | "FAIL" | "USE" | "NEW" | 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 |
parameters.template.field.fieldScheme.pcri? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; } | - |
parameters.template.field.fieldScheme.pcri.anID? | boolean | - |
parameters.template.field.fieldScheme.pcri.areference? | boolean | - |
parameters.template.field.fieldScheme.pcri.entityId? | string | - |
parameters.template.field.fieldScheme.pcri.entityType? | string | - |
parameters.template.field.fieldScheme.pcri.id? | string | - |
parameters.template.field.fieldScheme.pcri.type? | "id" | "ref" | ... & ... | - |
parameters.template.field.issueLayouts? | object[] | null | The issue layouts configuration |
parameters.template.field.issueTypeScreenScheme? | { defaultScreenScheme?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; } | - |
parameters.template.field.issueTypeScreenScheme.defaultScreenScheme? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; } | - |
parameters.template.field.issueTypeScreenScheme.defaultScreenScheme.anID? | boolean | - |
parameters.template.field.issueTypeScreenScheme.defaultScreenScheme.areference? | boolean | - |
parameters.template.field.issueTypeScreenScheme.defaultScreenScheme.entityId? | string | - |
parameters.template.field.issueTypeScreenScheme.defaultScreenScheme.entityType? | string | - |
parameters.template.field.issueTypeScreenScheme.defaultScreenScheme.id? | string | - |
parameters.template.field.issueTypeScreenScheme.defaultScreenScheme.type? | "id" | "ref" | ... & ... | - |
parameters.template.field.issueTypeScreenScheme.description? | string | The description of the issue type screen scheme |
parameters.template.field.issueTypeScreenScheme.explicitMappings? | Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }> | 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. |
parameters.template.field.issueTypeScreenScheme.name? | string | The name of the issue type screen scheme |
parameters.template.field.issueTypeScreenScheme.pcri? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; } | - |
parameters.template.field.issueTypeScreenScheme.pcri.anID? | boolean | - |
parameters.template.field.issueTypeScreenScheme.pcri.areference? | boolean | - |
parameters.template.field.issueTypeScreenScheme.pcri.entityId? | string | - |
parameters.template.field.issueTypeScreenScheme.pcri.entityType? | string | - |
parameters.template.field.issueTypeScreenScheme.pcri.id? | string | - |
parameters.template.field.issueTypeScreenScheme.pcri.type? | "id" | "ref" | ... & ... | - |
parameters.template.field.screens? | object[] | null | The screens. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens/#api-rest-api-3-screens-post |
parameters.template.field.screenScheme? | object[] | null | The screen schemes See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes/#api-rest-api-3-screenscheme-post |
parameters.template.issueType? | { issueTypeHierarchy?: object[] | null; issueTypes?: object[] | null; issueTypeScheme?: { defaultIssueTypeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string | null; issueTypeIds?: object[]; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; } | - |
parameters.template.issueType.issueTypeHierarchy? | object[] | null | 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 |
parameters.template.issueType.issueTypes? | object[] | null | Only needed if you want to create issue types, you can otherwise use the ids of issue types in the scheme configuration |
parameters.template.issueType.issueTypeScheme? | { defaultIssueTypeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string | null; issueTypeIds?: object[]; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; } | - |
parameters.template.issueType.issueTypeScheme.defaultIssueTypeId? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; } | - |
parameters.template.issueType.issueTypeScheme.defaultIssueTypeId.anID? | boolean | - |
parameters.template.issueType.issueTypeScheme.defaultIssueTypeId.areference? | boolean | - |
parameters.template.issueType.issueTypeScheme.defaultIssueTypeId.entityId? | string | - |
parameters.template.issueType.issueTypeScheme.defaultIssueTypeId.entityType? | string | - |
parameters.template.issueType.issueTypeScheme.defaultIssueTypeId.id? | string | - |
parameters.template.issueType.issueTypeScheme.defaultIssueTypeId.type? | "id" | "ref" | ... & ... | - |
parameters.template.issueType.issueTypeScheme.description? | string | null | The description of the issue type scheme |
parameters.template.issueType.issueTypeScheme.issueTypeIds? | object[] | The issue type IDs for the issue type scheme |
parameters.template.issueType.issueTypeScheme.name? | string | The name of the issue type scheme |
parameters.template.issueType.issueTypeScheme.pcri? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; } | - |
parameters.template.issueType.issueTypeScheme.pcri.anID? | boolean | - |
parameters.template.issueType.issueTypeScheme.pcri.areference? | boolean | - |
parameters.template.issueType.issueTypeScheme.pcri.entityId? | string | - |
parameters.template.issueType.issueTypeScheme.pcri.entityType? | string | - |
parameters.template.issueType.issueTypeScheme.pcri.id? | string | - |
parameters.template.issueType.issueTypeScheme.pcri.type? | "id" | "ref" | ... & ... | - |
parameters.template.notification? | { description?: string; name?: string; notificationSchemeEvents?: object[]; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; } | - |
parameters.template.notification.description? | string | The description of the notification scheme |
parameters.template.notification.name? | string | The name of the notification scheme |
parameters.template.notification.notificationSchemeEvents? | object[] | The events and notifications for the notification scheme |
parameters.template.notification.onConflict? | string & object | "FAIL" | "USE" | "NEW" | The strategy to use when there is a conflict with an existing entity |
parameters.template.notification.pcri? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.notification.pcri.anID? | boolean | - |
parameters.template.notification.pcri.areference? | boolean | - |
parameters.template.notification.pcri.entityId? | string | - |
parameters.template.notification.pcri.entityType? | string | - |
parameters.template.notification.pcri.id? | string | - |
parameters.template.notification.pcri.type? | "id" | "ref" | string & object | - |
parameters.template.permissionScheme? | { addAddonRole?: boolean; description?: string; grants?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; } | - |
parameters.template.permissionScheme.addAddonRole? | boolean | Configuration to generate addon role. Default is false if null. Only applies to GLOBAL-scoped permission scheme |
parameters.template.permissionScheme.description? | string | The description of the permission scheme |
parameters.template.permissionScheme.grants? | object[] | List of permission grants |
parameters.template.permissionScheme.name? | string | The name of the permission scheme |
parameters.template.permissionScheme.onConflict? | string & object | "FAIL" | "USE" | "NEW" | 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 |
parameters.template.permissionScheme.pcri? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.permissionScheme.pcri.anID? | boolean | - |
parameters.template.permissionScheme.pcri.areference? | boolean | - |
parameters.template.permissionScheme.pcri.entityId? | string | - |
parameters.template.permissionScheme.pcri.entityType? | string | - |
parameters.template.permissionScheme.pcri.id? | string | - |
parameters.template.permissionScheme.pcri.type? | "id" | "ref" | string & object | - |
parameters.template.project? | { fieldLayoutSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; issueSecuritySchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; issueTypeSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; issueTypeScreenSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; notificationSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; permissionSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; workflowSchemeId?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; } | - |
parameters.template.project.fieldLayoutSchemeId? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.project.fieldLayoutSchemeId.anID? | boolean | - |
parameters.template.project.fieldLayoutSchemeId.areference? | boolean | - |
parameters.template.project.fieldLayoutSchemeId.entityId? | string | - |
parameters.template.project.fieldLayoutSchemeId.entityType? | string | - |
parameters.template.project.fieldLayoutSchemeId.id? | string | - |
parameters.template.project.fieldLayoutSchemeId.type? | "id" | "ref" | string & object | - |
parameters.template.project.issueSecuritySchemeId? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.project.issueSecuritySchemeId.anID? | boolean | - |
parameters.template.project.issueSecuritySchemeId.areference? | boolean | - |
parameters.template.project.issueSecuritySchemeId.entityId? | string | - |
parameters.template.project.issueSecuritySchemeId.entityType? | string | - |
parameters.template.project.issueSecuritySchemeId.id? | string | - |
parameters.template.project.issueSecuritySchemeId.type? | "id" | "ref" | string & object | - |
parameters.template.project.issueTypeSchemeId? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.project.issueTypeSchemeId.anID? | boolean | - |
parameters.template.project.issueTypeSchemeId.areference? | boolean | - |
parameters.template.project.issueTypeSchemeId.entityId? | string | - |
parameters.template.project.issueTypeSchemeId.entityType? | string | - |
parameters.template.project.issueTypeSchemeId.id? | string | - |
parameters.template.project.issueTypeSchemeId.type? | "id" | "ref" | string & object | - |
parameters.template.project.issueTypeScreenSchemeId? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.project.issueTypeScreenSchemeId.anID? | boolean | - |
parameters.template.project.issueTypeScreenSchemeId.areference? | boolean | - |
parameters.template.project.issueTypeScreenSchemeId.entityId? | string | - |
parameters.template.project.issueTypeScreenSchemeId.entityType? | string | - |
parameters.template.project.issueTypeScreenSchemeId.id? | string | - |
parameters.template.project.issueTypeScreenSchemeId.type? | "id" | "ref" | string & object | - |
parameters.template.project.notificationSchemeId? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.project.notificationSchemeId.anID? | boolean | - |
parameters.template.project.notificationSchemeId.areference? | boolean | - |
parameters.template.project.notificationSchemeId.entityId? | string | - |
parameters.template.project.notificationSchemeId.entityType? | string | - |
parameters.template.project.notificationSchemeId.id? | string | - |
parameters.template.project.notificationSchemeId.type? | "id" | "ref" | string & object | - |
parameters.template.project.pcri? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.project.pcri.anID? | boolean | - |
parameters.template.project.pcri.areference? | boolean | - |
parameters.template.project.pcri.entityId? | string | - |
parameters.template.project.pcri.entityType? | string | - |
parameters.template.project.pcri.id? | string | - |
parameters.template.project.pcri.type? | "id" | "ref" | string & object | - |
parameters.template.project.permissionSchemeId? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.project.permissionSchemeId.anID? | boolean | - |
parameters.template.project.permissionSchemeId.areference? | boolean | - |
parameters.template.project.permissionSchemeId.entityId? | string | - |
parameters.template.project.permissionSchemeId.entityType? | string | - |
parameters.template.project.permissionSchemeId.id? | string | - |
parameters.template.project.permissionSchemeId.type? | "id" | "ref" | string & object | - |
parameters.template.project.projectTypeKey? | | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service" | 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. |
parameters.template.project.workflowSchemeId? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.project.workflowSchemeId.anID? | boolean | - |
parameters.template.project.workflowSchemeId.areference? | boolean | - |
parameters.template.project.workflowSchemeId.entityId? | string | - |
parameters.template.project.workflowSchemeId.entityType? | string | - |
parameters.template.project.workflowSchemeId.id? | string | - |
parameters.template.project.workflowSchemeId.type? | "id" | "ref" | string & object | - |
parameters.template.role? | { roles?: object[]; roleToProjectActors?: Record<string, object[]>; } | - |
parameters.template.role.roles? | object[] | The list of roles to create. |
parameters.template.role.roleToProjectActors? | Record<string, object[]> | 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. |
parameters.template.scope? | { type?: string & object | "PROJECT" | "GLOBAL"; } | - |
parameters.template.scope.type? | string & object | "PROJECT" | "GLOBAL" | The type of the scope. Use GLOBAL or empty for company-managed project, and PROJECT for team-managed project |
parameters.template.security? | { description?: string; name?: string; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; }; securityLevels?: object[]; } | - |
parameters.template.security.description? | string | The description of the security scheme |
parameters.template.security.name? | string | The name of the security scheme |
parameters.template.security.pcri? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | string & object; } | - |
parameters.template.security.pcri.anID? | boolean | - |
parameters.template.security.pcri.areference? | boolean | - |
parameters.template.security.pcri.entityId? | string | - |
parameters.template.security.pcri.entityType? | string | - |
parameters.template.security.pcri.id? | string | - |
parameters.template.security.pcri.type? | "id" | "ref" | string & object | - |
parameters.template.security.securityLevels? | object[] | The security levels for the security scheme |
parameters.template.workflow? | { statuses?: object[]; workflows?: object[]; workflowScheme?: { defaultWorkflow?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; }; } | - |
parameters.template.workflow.statuses? | object[] | The statuses for the workflow |
parameters.template.workflow.workflows? | object[] | The transitions for the workflow |
parameters.template.workflow.workflowScheme? | { defaultWorkflow?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; description?: string; explicitMappings?: Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }>; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; }; } | - |
parameters.template.workflow.workflowScheme.defaultWorkflow? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; } | - |
parameters.template.workflow.workflowScheme.defaultWorkflow.anID? | boolean | - |
parameters.template.workflow.workflowScheme.defaultWorkflow.areference? | boolean | - |
parameters.template.workflow.workflowScheme.defaultWorkflow.entityId? | string | - |
parameters.template.workflow.workflowScheme.defaultWorkflow.entityType? | string | - |
parameters.template.workflow.workflowScheme.defaultWorkflow.id? | string | - |
parameters.template.workflow.workflowScheme.defaultWorkflow.type? | "id" | "ref" | ... & ... | - |
parameters.template.workflow.workflowScheme.description? | string | The description of the workflow scheme |
parameters.template.workflow.workflowScheme.explicitMappings? | Record<string, { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }> | Association between issuetypes and workflows |
parameters.template.workflow.workflowScheme.name? | string | The name of the workflow scheme |
parameters.template.workflow.workflowScheme.onConflict? | string & object | "FAIL" | "USE" | "NEW" | The strategy to use if there is a conflict with another workflow scheme |
parameters.template.workflow.workflowScheme.pcri? | { anID?: boolean; areference?: boolean; entityId?: string; entityType?: string; id?: string; type?: "id" | "ref" | ... & ...; } | - |
parameters.template.workflow.workflowScheme.pcri.anID? | boolean | - |
parameters.template.workflow.workflowScheme.pcri.areference? | boolean | - |
parameters.template.workflow.workflowScheme.pcri.entityId? | string | - |
parameters.template.workflow.workflowScheme.pcri.entityType? | string | - |
parameters.template.workflow.workflowScheme.pcri.id? | string | - |
parameters.template.workflow.workflowScheme.pcri.type? | "id" | "ref" | ... & ... | - |
options? | RequestOptions | - |
Returns
Promise<void>