Interface CustomTemplatesProjectDetails

Project Details

interface CustomTemplatesProjectDetails {
    accessLevel?:
        | "open"
        | "private"
        | "limited"
        | "free";
    additionalProperties?: {
        [key: string]: string;
    };
    assigneeType?:
        | "PROJECT_LEAD"
        | "UNASSIGNED"
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD";
    avatarId?: number;
    categoryId?: number;
    description?: string;
    enableComponents?: boolean;
    key?: string;
    language?: string;
    leadAccountId?: string;
    name?: string;
    url?: string;
}

Properties

accessLevel? additionalProperties? assigneeType? avatarId? categoryId? description? enableComponents? key? language? leadAccountId? name? url?

Properties

OptionalaccessLevel

accessLevel?:
    | "open"
    | "private"
    | "limited"
    | "free"

The access level of the project. Only used by team-managed project

Example

private

OptionaladditionalProperties

additionalProperties?: {
    [key: string]: string;
}

Additional properties of the project

Type declaration

  • [key: string]: string

    Additional properties of the project

OptionalassigneeType

assigneeType?:
    | "PROJECT_LEAD"
    | "UNASSIGNED"
    | "PROJECT_DEFAULT"
    | "COMPONENT_LEAD"

The default assignee when creating issues in the project

Example

PROJECT_LEAD

OptionalavatarId

avatarId?: number

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.

Example

10200

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

Brief description of the project

Example

Thisis a project for Foo Bar

OptionalenableComponents

enableComponents?: boolean

Whether components are enabled for the project. Only used by company-managed project

Example

false

Optionalkey

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.

Example

PRJ

Optionallanguage

language?: string

The default language for the project

Example

en

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.

Example

1234567890

Optionalname

name?: string

Name of the project

Example

ProjectFoo Bar

Optionalurl

url?: string

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

Example

https://www.example.com

Settings

Member Visibility

On This Page

Properties