Jira.js - Jira Cloud API library
    Preparing search index...

    Interface Project

    Details about a project.

    interface Project {
        archived?: boolean;
        archivedBy?: Version3Models.User;
        archivedDate?: string;
        assigneeType?: string;
        avatarUrls?: Version3Models.AvatarUrls;
        components?: Version3Models.ProjectComponent[];
        deleted?: boolean;
        deletedBy?: Version3Models.User;
        deletedDate?: string;
        description?: string;
        email?: string;
        expand?:
            | string
            | string[]
            | (
                | "description"
                | "issueTypes"
                | "lead"
                | "projectKeys"
                | "issueTypeHierarchy"
            )[];
        favourite?: boolean;
        id: string;
        insight?: Version3Models.ProjectInsight;
        isPrivate?: boolean;
        issueTypeHierarchy?: Version3Models.Hierarchy;
        issueTypes?: Version3Models.IssueTypeDetails[];
        key: string;
        landingPageInfo?: Version3Models.ProjectLandingPageInfo;
        lead: Version3Models.User;
        name: string;
        permissions?: Version3Models.ProjectPermissions;
        projectCategory?: Version3Models.ProjectCategory;
        projectTypeKey?: string;
        properties?: unknown;
        retentionTillDate?: string;
        roles?: unknown;
        self?: string;
        simplified?: boolean;
        style?: string;
        url?: string;
        uuid?: string;
        versions?: Version3Models.Version[];
    }
    Index

    Properties

    archived? archivedBy? archivedDate? assigneeType? avatarUrls? components? deleted? deletedBy? deletedDate? description? email? expand? favourite? id insight? isPrivate? issueTypeHierarchy? issueTypes? key landingPageInfo? lead name permissions? projectCategory? projectTypeKey? properties? retentionTillDate? roles? self? simplified? style? url? uuid? versions?

    Properties

    archived?: boolean

    Whether the project is archived.

    archivedBy?: Version3Models.User
    archivedDate?: string

    The date when the project was archived.

    assigneeType?: string

    The default assignee when creating issues for this project.

    avatarUrls?: Version3Models.AvatarUrls
    components?: Version3Models.ProjectComponent[]

    List of the components contained in the project.

    deleted?: boolean

    Whether the project is marked as deleted.

    deletedBy?: Version3Models.User
    deletedDate?: string

    The date when the project was marked as deleted.

    description?: string

    A brief description of the project.

    email?: string

    An email address associated with the project.

    expand?:
        | string
        | string[]
        | (
            | "description"
            | "issueTypes"
            | "lead"
            | "projectKeys"
            | "issueTypeHierarchy"
        )[]

    Expand options that include additional project details in the response.

    favourite?: boolean

    Whether the project is selected as a favorite.

    id: string

    The ID of the project.

    insight?: Version3Models.ProjectInsight
    isPrivate?: boolean

    Whether the project is private.

    issueTypeHierarchy?: Version3Models.Hierarchy
    issueTypes?: Version3Models.IssueTypeDetails[]

    List of the issue types available in the project.

    key: string

    The key of the project.

    landingPageInfo?: Version3Models.ProjectLandingPageInfo
    lead: Version3Models.User
    name: string

    The name of the project.

    permissions?: Version3Models.ProjectPermissions
    projectCategory?: Version3Models.ProjectCategory
    projectTypeKey?: string

    The project type of the project.

    properties?: unknown

    Map of project properties

    retentionTillDate?: string

    The date when the project is deleted permanently.

    roles?: unknown

    The name and self URL for each role defined in the project. For more information, see Create project role.

    self?: string

    The URL of the project details.

    simplified?: boolean

    Whether the project is simplified.

    style?: string

    The type of the project.

    url?: string

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

    uuid?: string

    Unique ID for next-gen projects.

    versions?: Version3Models.Version[]

    The versions defined in the project. For more information, see Create version.

    Settings

    Member Visibility

    On This Page

    Properties