Interface Project

Details about a project.

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

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

Optional archived

archived?: boolean

Whether the project is archived.

Optional archivedBy

archivedBy?: Version3.Version3Models.User

Optional archivedDate

archivedDate?: string

The date when the project was archived.

Optional assigneeType

assigneeType?: string

The default assignee when creating issues for this project.

Optional avatarUrls

avatarUrls?: Version3.Version3Models.AvatarUrls

Optional components

components?: Version3.Version3Models.ProjectComponent[]

List of the components contained in the project.

Optional deleted

deleted?: boolean

Whether the project is marked as deleted.

Optional deletedBy

deletedBy?: Version3.Version3Models.User

Optional deletedDate

deletedDate?: string

The date when the project was marked as deleted.

Optional description

description?: string

A brief description of the project.

Optional email

email?: string

An email address associated with the project.

Optional expand

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

Expand options that include additional project details in the response.

Optional favourite

favourite?: boolean

Whether the project is selected as a favorite.

id

id: string

The ID of the project.

Optional insight

insight?: Version3.Version3Models.ProjectInsight

Optional isPrivate

isPrivate?: boolean

Whether the project is private.

Optional issueTypeHierarchy

issueTypeHierarchy?: Version3.Version3Models.Hierarchy

Optional issueTypes

issueTypes?: Version3.Version3Models.IssueTypeDetails[]

List of the issue types available in the project.

key

key: string

The key of the project.

Optional landingPageInfo

landingPageInfo?: Version3.Version3Models.ProjectLandingPageInfo

lead

lead: Version3.Version3Models.User

name

name: string

The name of the project.

Optional permissions

permissions?: Version3.Version3Models.ProjectPermissions

Optional projectCategory

projectCategory?: Version3.Version3Models.ProjectCategory

Optional projectTypeKey

projectTypeKey?: string

The project type of the project.

Optional properties

properties?: {}

Map of project properties

Type declaration

    Optional retentionTillDate

    retentionTillDate?: string

    The date when the project is deleted permanently.

    Optional roles

    roles?: {}

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

    Type declaration

      Optional self

      self?: string

      The URL of the project details.

      Optional simplified

      simplified?: boolean

      Whether the project is simplified.

      Optional style

      style?: string

      The type of the project.

      Optional url

      url?: string

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

      Optional uuid

      uuid?: string

      Unique ID for next-gen projects.

      Optional versions

      versions?: Version3.Version3Models.Version[]

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

      Settings

      Member Visibility

      Theme

      On This Page

      archivedarchivedByarchivedDateassigneeTypeavatarUrlscomponentsdeleteddeletedBydeletedDatedescriptionemailexpandfavouriteidinsightisPrivateissueTypeHierarchyissueTypeskeylandingPageInfoleadnamepermissionsprojectCategoryprojectTypeKeypropertiesretentionTillDaterolesselfsimplifiedstyleurluuidversions