Options
All
  • Public
  • Public/Protected
  • All
Menu

Details about a project.

Hierarchy

  • Project

Index

Properties

Optional archived

archived: boolean

Whether the project is archived.

Optional archivedBy

archivedBy: User

The user who archived the project.

Optional archivedDate

archivedDate: string

The date when the project was archived.

format

date-time

Optional assigneeType

assigneeType: "PROJECT_LEAD" | "UNASSIGNED"

The default assignee when creating issues for this project.

Optional avatarUrls

avatarUrls: AvatarUrlsBean

The URLs of the project's avatars.

Optional components

components: ProjectComponent[]

List of the components contained in the project.

Optional deleted

deleted: boolean

Whether the project is marked as deleted.

Optional deletedBy

deletedBy: User

The user who marked the project as deleted.

Optional deletedDate

deletedDate: string

The date when the project was marked as deleted.

format

date-time

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

Expand options that include additional project details in the response.

Optional favourite

favourite: boolean

Whether the project is selected as a favorite.

Optional id

id: string

The ID of the project.

Optional insight

Insights about the project.

Optional isPrivate

isPrivate: boolean

Whether the project is private.

Optional issueTypeHierarchy

issueTypeHierarchy: Hierarchy

The issue type hierarchy for the project.

Optional issueTypes

issueTypes: IssueTypeDetails[]

List of the issue types available in the project.

Optional key

key: string

The key of the project.

Optional landingPageInfo

landingPageInfo: ProjectLandingPageInfo

The project landing page info.

Optional lead

lead: User

The username of the project lead.

Optional name

name: string

The name of the project.

Optional permissions

permissions: ProjectPermissions

User permissions on the project

Optional projectCategory

projectCategory: ProjectCategory

The category the project belongs to.

Optional projectTypeKey

projectTypeKey: "software" | "service_desk" | "business"

The project type of the project.

Optional properties

properties: Record<string, any>

Map of project properties

Optional retentionTillDate

retentionTillDate: string

The date when the project is deleted permanently.

format

date-time

Optional roles

roles: Record<string, string>

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

Optional self

self: string

The URL of the project details.

format

uri

Optional simplified

simplified: boolean

Whether the project is simplified.

Optional style

style: "classic" | "next-gen"

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.

format

uuid

Optional versions

versions: Version[]

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

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc