Interface CreateProjectDetails

Details about the project.

interface CreateProjectDetails {
    assigneeType?: "PROJECT_LEAD" | "UNASSIGNED";
    avatarId?: number;
    categoryId?: number;
    description?: string;
    fieldConfigurationScheme?: number;
    issueSecurityScheme?: number;
    issueTypeScheme?: number;
    issueTypeScreenScheme?: number;
    key: string;
    lead?: string;
    leadAccountId?: string;
    name: string;
    notificationScheme?: number;
    permissionScheme?: number;
    projectTemplateKey?:
        | "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-general-service-desk"
        | "com.atlassian.servicedesk:simplified-general-service-desk-it"
        | "com.atlassian.servicedesk:simplified-general-service-desk-business"
        | "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:simplified-blank-project-it"
        | "com.atlassian.servicedesk:simplified-blank-project-business"
        | "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-general-service-desk"
        | "com.atlassian.servicedesk:next-gen-general-it-service-desk"
        | "com.atlassian.servicedesk:next-gen-general-business-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.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-";
    projectTypeKey?:
        | "software"
        | "service_desk"
        | "product_discovery"
        | "business";
    url?: string;
    workflowScheme?: number;
}

Properties

assigneeType? avatarId? categoryId? description? fieldConfigurationScheme? issueSecurityScheme? issueTypeScheme? issueTypeScreenScheme? key lead? leadAccountId? name notificationScheme? permissionScheme? projectTemplateKey? projectTypeKey? url? workflowScheme?

Properties

OptionalassigneeType

assigneeType?: "PROJECT_LEAD" | "UNASSIGNED"

The default assignee when creating issues for this project.

OptionalavatarId

avatarId?: number

An integer value for the project's avatar.

OptionalcategoryId

categoryId?: number

The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.

Optionaldescription

description?: string

A brief description of the project.

OptionalfieldConfigurationScheme

fieldConfigurationScheme?: number

The ID of the field configuration scheme for the project. Use the Get all field configuration schemes operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key.

OptionalissueSecurityScheme

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.

OptionalissueTypeScheme

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.

OptionalissueTypeScreenScheme

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.

key

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.

Optionallead

lead?: string

This parameter is deprecated because of privacy changes. Use leadAccountId instead. See the migration guide for details. The user name of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with leadAccountId.

Deprecated

OptionalleadAccountId

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.

name

name: string

The name of the project.

OptionalnotificationScheme

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.

OptionalpermissionScheme

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.

OptionalprojectTemplateKey

projectTemplateKey?:
    | "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-general-service-desk"
    | "com.atlassian.servicedesk:simplified-general-service-desk-it"
    | "com.atlassian.servicedesk:simplified-general-service-desk-business"
    | "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:simplified-blank-project-it"
    | "com.atlassian.servicedesk:simplified-blank-project-business"
    | "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-general-service-desk"
    | "com.atlassian.servicedesk:next-gen-general-it-service-desk"
    | "com.atlassian.servicedesk:next-gen-general-business-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.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-"

A predefined configuration for a project. The type of the projectTemplateKey must match with the type of the projectTypeKey.

OptionalprojectTypeKey

projectTypeKey?:
    | "software"
    | "service_desk"
    | "product_discovery"
    | "business"

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.

Optionalurl

url?: string

A link to information about this project, such as project documentation

OptionalworkflowScheme

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.

Settings

Member Visibility

On This Page

Properties