Function: createProject()
ts
function createProject(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
id: number;
key: string;
self: string;
}>;Defined in: src/cloud/api/projects.ts:44
Creates a project based on a project type template, as shown in the following table:
| Project Type Key | Project Template Key |
|---|---|
business | com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-core-project-templates:jira-core-simplified-procurement, com.atlassian.jira-core-project-templates:jira-core-simplified-project-management, com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment, com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking |
service_desk | com.atlassian.servicedesk:simplified-it-service-management, com.atlassian.servicedesk:simplified-external-service-desk, com.atlassian.servicedesk:simplified-hr-service-desk, com.atlassian.servicedesk:simplified-facilities-service-desk, com.atlassian.servicedesk:simplified-legal-service-desk, com.atlassian.servicedesk:simplified-analytics-service-desk, com.atlassian.servicedesk:simplified-marketing-service-desk, com.atlassian.servicedesk:simplified-design-service-desk, com.atlassian.servicedesk:simplified-sales-service-desk, com.atlassian.servicedesk:simplified-finance-service-desk, com.atlassian.servicedesk:company-managed-blank-service-project, com.atlassian.servicedesk:company-managed-general-service-project, com.atlassian.servicedesk:team-managed-general-service-project, com.atlassian.servicedesk:next-gen-it-service-desk, com.atlassian.servicedesk:next-gen-hr-service-desk, com.atlassian.servicedesk:next-gen-legal-service-desk, com.atlassian.servicedesk:next-gen-marketing-service-desk, com.atlassian.servicedesk:next-gen-facilities-service-desk, com.atlassian.servicedesk:next-gen-analytics-service-desk, com.atlassian.servicedesk:next-gen-finance-service-desk, com.atlassian.servicedesk:next-gen-design-service-desk, com.atlassian.servicedesk:next-gen-sales-service-desk |
software | com.pyxis.greenhopper.jira:gh-simplified-agility-kanban, com.pyxis.greenhopper.jira:gh-simplified-agility-scrum, com.pyxis.greenhopper.jira:gh-simplified-basic, com.pyxis.greenhopper.jira:gh-simplified-kanban-classic, com.pyxis.greenhopper.jira:gh-simplified-scrum-classic |
customer_service | com.atlassian.jcs:customer-service-management |
The project types are available according to the installed Jira features as follows:
- Jira Core, the default, enables
businessprojects. - Jira Service Management enables
service_deskprojects. - Jira Software enables
softwareprojects. - Jira Customer Service enables
customer_serviceprojects.
To determine which features are installed, go to Jira settings > Apps > Manage apps and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see Managing add-ons.
Permissions required:Administer Jira global permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED"; avatarId?: number; categoryId?: number; description?: string; fieldScheme?: number; issueSecurityScheme?: number; issueTypeScheme?: number; issueTypeScreenScheme?: number; key: string; leadAccountId: string; name: string; notificationScheme?: number; permissionScheme?: number; projectTemplateKey?: | string & object | "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban" | "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum" | "com.pyxis.greenhopper.jira:gh-simplified-basic" | "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic" | "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic" | "com.pyxis.greenhopper.jira:gh-cross-team-template" | "com.pyxis.greenhopper.jira:gh-cross-team-planning-template" | "com.atlassian.servicedesk:simplified-it-service-management" | "com.atlassian.servicedesk:simplified-it-service-management-basic" | "com.atlassian.servicedesk:simplified-it-service-management-operations" | "com.atlassian.servicedesk:simplified-internal-service-desk" | "com.atlassian.servicedesk:simplified-external-service-desk" | "com.atlassian.servicedesk:simplified-hr-service-desk" | "com.atlassian.servicedesk:simplified-facilities-service-desk" | "com.atlassian.servicedesk:simplified-legal-service-desk" | "com.atlassian.servicedesk:simplified-marketing-service-desk" | "com.atlassian.servicedesk:simplified-finance-service-desk" | "com.atlassian.servicedesk:simplified-analytics-service-desk" | "com.atlassian.servicedesk:simplified-design-service-desk" | "com.atlassian.servicedesk:simplified-sales-service-desk" | "com.atlassian.servicedesk:simplified-halp-service-desk" | "com.atlassian.servicedesk:next-gen-it-service-desk" | "com.atlassian.servicedesk:next-gen-hr-service-desk" | "com.atlassian.servicedesk:next-gen-legal-service-desk" | "com.atlassian.servicedesk:next-gen-marketing-service-desk" | "com.atlassian.servicedesk:next-gen-facilities-service-desk" | "com.atlassian.servicedesk:next-gen-analytics-service-desk" | "com.atlassian.servicedesk:next-gen-finance-service-desk" | "com.atlassian.servicedesk:next-gen-design-service-desk" | "com.atlassian.servicedesk:next-gen-sales-service-desk" | "com.atlassian.servicedesk:company-managed-blank-service-project" | "com.atlassian.servicedesk:company-managed-general-service-project" | "com.atlassian.servicedesk:team-managed-general-service-project" | "com.atlassian.jira-core-project-templates:jira-core-simplified-content-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval" | "com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking" | "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control" | "com.atlassian.jira-core-project-templates:jira-core-simplified-procurement" | "com.atlassian.jira-core-project-templates:jira-core-simplified-project-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment" | "com.atlassian.jira-core-project-templates:jira-core-simplified-task-" | "com.atlassian.jcs:customer-service-management"; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; url?: string; workflowScheme?: number; } | - |
parameters.assigneeType? | string & object | "PROJECT_LEAD" | "UNASSIGNED" | The default assignee when creating issues for this project. |
parameters.avatarId? | number | An integer value for the project's avatar. |
parameters.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.description? | string | A brief description of the project. |
parameters.fieldScheme? | number | The ID of the field scheme for the project. Use the Get field schemes operation to get a list of field scheme IDs. If you specify the field scheme you cannot specify the project template key. |
parameters.issueSecurityScheme? | number | The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the Get issue security schemes resource to get all issue security scheme IDs. |
parameters.issueTypeScheme? | number | The ID of the issue type scheme for the project. Use the Get all issue type schemes operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key. |
parameters.issueTypeScreenScheme? | number | The ID of the issue type screen scheme for the project. Use the Get all issue type screen schemes operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key. |
parameters.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.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.name? | string | The name of the project. |
parameters.notificationScheme? | number | The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs. |
parameters.permissionScheme? | number | The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs. |
parameters.projectTemplateKey? | | string & object | "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban" | "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum" | "com.pyxis.greenhopper.jira:gh-simplified-basic" | "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic" | "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic" | "com.pyxis.greenhopper.jira:gh-cross-team-template" | "com.pyxis.greenhopper.jira:gh-cross-team-planning-template" | "com.atlassian.servicedesk:simplified-it-service-management" | "com.atlassian.servicedesk:simplified-it-service-management-basic" | "com.atlassian.servicedesk:simplified-it-service-management-operations" | "com.atlassian.servicedesk:simplified-internal-service-desk" | "com.atlassian.servicedesk:simplified-external-service-desk" | "com.atlassian.servicedesk:simplified-hr-service-desk" | "com.atlassian.servicedesk:simplified-facilities-service-desk" | "com.atlassian.servicedesk:simplified-legal-service-desk" | "com.atlassian.servicedesk:simplified-marketing-service-desk" | "com.atlassian.servicedesk:simplified-finance-service-desk" | "com.atlassian.servicedesk:simplified-analytics-service-desk" | "com.atlassian.servicedesk:simplified-design-service-desk" | "com.atlassian.servicedesk:simplified-sales-service-desk" | "com.atlassian.servicedesk:simplified-halp-service-desk" | "com.atlassian.servicedesk:next-gen-it-service-desk" | "com.atlassian.servicedesk:next-gen-hr-service-desk" | "com.atlassian.servicedesk:next-gen-legal-service-desk" | "com.atlassian.servicedesk:next-gen-marketing-service-desk" | "com.atlassian.servicedesk:next-gen-facilities-service-desk" | "com.atlassian.servicedesk:next-gen-analytics-service-desk" | "com.atlassian.servicedesk:next-gen-finance-service-desk" | "com.atlassian.servicedesk:next-gen-design-service-desk" | "com.atlassian.servicedesk:next-gen-sales-service-desk" | "com.atlassian.servicedesk:company-managed-blank-service-project" | "com.atlassian.servicedesk:company-managed-general-service-project" | "com.atlassian.servicedesk:team-managed-general-service-project" | "com.atlassian.jira-core-project-templates:jira-core-simplified-content-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval" | "com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking" | "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control" | "com.atlassian.jira-core-project-templates:jira-core-simplified-procurement" | "com.atlassian.jira-core-project-templates:jira-core-simplified-project-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment" | "com.atlassian.jira-core-project-templates:jira-core-simplified-task-" | "com.atlassian.jcs:customer-service-management" | A predefined configuration for a project. The type of the projectTemplateKey must match with the type of the projectTypeKey. |
parameters.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.url? | string | A link to information about this project, such as project documentation |
parameters.workflowScheme? | number | The ID of the workflow scheme for the project. Use the Get all workflow schemes operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; id: number; key: string; self: string; }>