Function: getProject()
function getProject(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
archived?: boolean;
archivedBy?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: string]: unknown;
};
items?: object[];
max-results?: number;
pagingCallback?: {
[key: string]: unknown;
};
size?: number;
};
appType?: string;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
expand?: string;
groups?: {
[key: string]: unknown;
callback?: {
[key: string]: unknown;
};
items?: object[];
max-results?: number;
pagingCallback?: {
[key: string]: unknown;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
archivedDate?: Date;
assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED";
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
components?: object[];
deleted?: boolean;
deletedBy?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: string]: unknown;
};
items?: object[];
max-results?: number;
pagingCallback?: {
[key: string]: unknown;
};
size?: number;
};
appType?: string;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
expand?: string;
groups?: {
[key: string]: unknown;
callback?: {
[key: string]: unknown;
};
items?: object[];
max-results?: number;
pagingCallback?: {
[key: string]: unknown;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
deletedDate?: Date;
description?: string;
email?: string;
entityId?: string;
expand?: string;
favourite?: boolean;
id?: string;
insight?: {
[key: string]: unknown;
lastIssueUpdateTime?: Date;
totalIssueCount?: number;
};
isPrivate?: boolean;
issueTypeHierarchy?: {
[key: string]: unknown;
levels?: object[];
};
issueTypes?: object[];
key?: string;
landingPageInfo?: {
[key: string]: unknown;
attributes?: Record<string, string>;
boardId?: number;
boardName?: string;
projectKey?: string;
projectType?: string;
queueCategory?: string;
queueId?: number;
queueName?: string;
simpleBoard?: boolean;
simplified?: boolean;
url?: string;
};
lead?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: string]: unknown;
};
items?: object[];
max-results?: number;
pagingCallback?: {
[key: string]: unknown;
};
size?: number;
};
appType?: string;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
expand?: string;
groups?: {
[key: string]: unknown;
callback?: {
[key: string]: unknown;
};
items?: object[];
max-results?: number;
pagingCallback?: {
[key: string]: unknown;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
permissions?: {
[key: string]: unknown;
canEdit?: boolean;
};
projectCategory?: {
[key: string]: unknown;
description?: string;
id?: string;
name?: string;
self?: string;
};
projectTypeKey?: | string & object
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
properties?: Record<string, any>;
retentionTillDate?: Date;
roles?: Record<string, string>;
self?: string;
simplified?: boolean;
style?: "classic" | string & object | "next-gen";
url?: string;
uuid?: string;
versions?: object[];
}>;Defined in: src/cloud/api/projects.ts:129
Returns the project details for a project.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for the project.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { expand?: | "description" | string & object | "issueTypes" | "lead" | "issueTypeHierarchy" | "projectKeys" | ( | "description" | string & object | "issueTypes" | "lead" | "issueTypeHierarchy" | "projectKeys")[]; projectIdOrKey: string; properties?: string[]; } | - |
parameters.expand? | | "description" | string & object | "issueTypes" | "lead" | "issueTypeHierarchy" | "projectKeys" | ( | "description" | string & object | "issueTypes" | "lead" | "issueTypeHierarchy" | "projectKeys")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: - description The project description. - issueTypes The issue types associated with the project. - lead The project lead. - projectKeys All project keys associated with the project. - issueTypeHierarchy The project issue type hierarchy. |
parameters.projectIdOrKey? | string | The project ID or project key (case sensitive). |
parameters.properties? | string[] | A list of project properties to return for the project. This parameter accepts a comma-separated list. Note that only the properties named here are returned in properties in the response; that object is empty when this parameter is omitted. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; archived?: boolean; archivedBy?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; appType?: string; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; archivedDate?: Date; assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED"; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; components?: object[]; deleted?: boolean; deletedBy?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; appType?: string; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; deletedDate?: Date; description?: string; email?: string; entityId?: string; expand?: string; favourite?: boolean; id?: string; insight?: { [key: string]: unknown; lastIssueUpdateTime?: Date; totalIssueCount?: number; }; isPrivate?: boolean; issueTypeHierarchy?: { [key: string]: unknown; levels?: object[]; }; issueTypes?: object[]; key?: string; landingPageInfo?: { [key: string]: unknown; attributes?: Record<string, string>; boardId?: number; boardName?: string; projectKey?: string; projectType?: string; queueCategory?: string; queueId?: number; queueName?: string; simpleBoard?: boolean; simplified?: boolean; url?: string; }; lead?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; appType?: string; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; permissions?: { [key: string]: unknown; canEdit?: boolean; }; projectCategory?: { [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; properties?: Record<string, any>; retentionTillDate?: Date; roles?: Record<string, string>; self?: string; simplified?: boolean; style?: "classic" | string & object | "next-gen"; url?: string; uuid?: string; versions?: object[]; }>