Function: updateProject()
function updateProject(
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:155
Updates the project details of a project.
All parameters are optional in the body of the request. Schemes will only be updated if they are included in the request, any omitted schemes will be left unchanged.
Permissions required:Administer Jira global permission. is only needed when changing the schemes or project key. Otherwise you will only need Administer Projects project permission
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED"; avatarId?: number; categoryId?: number; description?: string; expand?: | "description" | string & object | "issueTypes" | "lead" | "projectKeys" | ( | "description" | string & object | "issueTypes" | "lead" | "projectKeys")[]; issueSecurityScheme?: number; key?: string; leadAccountId?: string; name?: string; notificationScheme?: number; permissionScheme?: number; projectIdOrKey: string; releasedProjectKeys?: string[]; url?: string; } | - |
parameters.assigneeType? | string & object | "PROJECT_LEAD" | "UNASSIGNED" | The default assignee when creating issues for this project. |
parameters.avatarId? | number | An integer value for the project's avatar. |
parameters.categoryId? | number | The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. To remove the project category from the project, set the value to -1. |
parameters.description? | string | A brief description of the project. |
parameters.expand? | | "description" | string & object | "issueTypes" | "lead" | "projectKeys" | ( | "description" | string & object | "issueTypes" | "lead" | "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. |
parameters.issueSecurityScheme? | number | The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the Get issue security schemes resource to get all issue security scheme IDs. |
parameters.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. |
parameters.leadAccountId? | string | The account ID of the project lead. Cannot be provided with lead. |
parameters.name? | string | The name of the project. |
parameters.notificationScheme? | number | The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs. |
parameters.permissionScheme? | number | The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs. |
parameters.projectIdOrKey? | string | The project ID or project key (case sensitive). |
parameters.releasedProjectKeys? | string[] | Previous project keys to be released from the current project. Released keys must belong to the current project and not contain the current project key |
parameters.url? | string | A link to information about this project, such as project documentation |
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[]; }>