Function: createCloudClient()
ts
function createCloudClient(clientConfig): object;Defined in: src/cloud/createCloudClient.ts:744
Parameters
| Parameter | Type |
|---|---|
clientConfig | | ClientConfig | Client |
Returns
object
announcementBanner
ts
announcementBanner: object;announcementBanner.getBanner
ts
getBanner: () => Promise<{
[key: string]: unknown;
hashId?: string;
isDismissible?: boolean;
isEnabled?: boolean;
message?: string;
visibility?: "private" | "public" | string & object;
}>;Returns
Promise<{ [key: string]: unknown; hashId?: string; isDismissible?: boolean; isEnabled?: boolean; message?: string; visibility?: "private" | "public" | string & object; }>
announcementBanner.setBanner
ts
setBanner: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { isDismissible?: boolean; isEnabled?: boolean; message?: string; visibility?: string; } | - |
parameters.isDismissible? | boolean | Flag indicating if the announcement banner can be dismissed by the user. |
parameters.isEnabled? | boolean | Flag indicating if the announcement banner is enabled or not. |
parameters.message? | string | The text on the announcement banner. |
parameters.visibility? | string | Visibility of the announcement banner. Can be public or private. |
Returns
Promise<void>
api
ts
api: object;api.getWorklogsByIssueIdAndWorklogId
ts
getWorklogsByIssueIdAndWorklogId: (parameters) => Promise<{
[key: string]: unknown;
worklogs?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { requests?: object[]; } | - |
parameters.requests? | object[] | A list of issue and worklog ID pairs. |
Returns
Promise<{ [key: string]: unknown; worklogs?: object[]; }>
appDataPolicies
ts
appDataPolicies: object;appDataPolicies.getPolicies
ts
getPolicies: (parameters?) => Promise<{
[key: string]: unknown;
projectDataPolicies?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { ids?: string | string[]; } | - |
parameters.ids? | string | string[] | A list of project identifiers. This parameter accepts a comma-separated list. |
Returns
Promise<{ [key: string]: unknown; projectDataPolicies?: object[]; }>
appDataPolicies.getPolicy
ts
getPolicy: () => Promise<{
[key: string]: unknown;
anyContentBlocked?: boolean;
}>;Returns
Promise<{ [key: string]: unknown; anyContentBlocked?: boolean; }>
applicationRoles
ts
applicationRoles: object;applicationRoles.getAllApplicationRoles
ts
getAllApplicationRoles: () => Promise<object[]>;Returns
Promise<object[]>
applicationRoles.getApplicationRole
ts
getApplicationRole: (parameters) => Promise<{
[key: string]: unknown;
defaultGroups?: string[];
defaultGroupsDetails?: object[];
defined?: boolean;
groupDetails?: object[];
groups?: string[];
hasUnlimitedSeats?: boolean;
key?: string;
name?: string;
numberOfSeats?: number;
platform?: boolean;
remainingSeats?: number;
selectedByDefault?: boolean;
userCount?: number;
userCountDescription?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { key: string; } | - |
parameters.key | string | The key of the application role. Use the Get all application roles operation to get the key for each application role. |
Returns
Promise<{ [key: string]: unknown; defaultGroups?: string[]; defaultGroupsDetails?: object[]; defined?: boolean; groupDetails?: object[]; groups?: string[]; hasUnlimitedSeats?: boolean; key?: string; name?: string; numberOfSeats?: number; platform?: boolean; remainingSeats?: number; selectedByDefault?: boolean; userCount?: number; userCountDescription?: string; }>
appMigration
ts
appMigration: object;appMigration.updateEntityPropertiesValue
ts
updateEntityPropertiesValue: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { Atlassian-Transfer-Id: string; body: Record<string, any>; entityType: | string & object | "IssueProperty" | "CommentProperty" | "DashboardItemProperty" | "IssueTypeProperty" | "ProjectProperty" | "UserProperty" | "WorklogProperty" | "BoardProperty" | "SprintProperty"; } | - |
parameters.Atlassian-Transfer-Id | string | The app migration transfer ID. |
parameters.body | Record<string, any> | - |
parameters.entityType | | string & object | "IssueProperty" | "CommentProperty" | "DashboardItemProperty" | "IssueTypeProperty" | "ProjectProperty" | "UserProperty" | "WorklogProperty" | "BoardProperty" | "SprintProperty" | The type indicating the object that contains the entity properties. |
Returns
Promise<void>
appMigration.updateIssueFields
ts
updateIssueFields: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { Atlassian-Transfer-Id: string; updateValueList?: object[]; } | - |
parameters.Atlassian-Transfer-Id | string | The ID of the transfer. |
parameters.updateValueList? | object[] | The list of custom field update details. |
Returns
Promise<void>
appMigration.workflowRuleSearch
ts
workflowRuleSearch: (parameters) => Promise<{
[key: string]: unknown;
invalidRules?: string[];
validRules?: object[];
workflowEntityId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { Atlassian-Transfer-Id: string; expand?: string; ruleIds: string[]; workflowEntityId: string; } | - |
parameters.Atlassian-Transfer-Id | string | The app migration transfer ID. |
parameters.expand? | string | Use expand to include additional information in the response. This parameter accepts transition which, for each rule, returns information about the transition the rule is assigned to. |
parameters.ruleIds | string[] | The list of workflow rule IDs. |
parameters.workflowEntityId | string | The workflow ID. |
Returns
Promise<{ [key: string]: unknown; invalidRules?: string[]; validRules?: object[]; workflowEntityId?: string; }>
appProperties
ts
appProperties: object;appProperties.deleteAddonProperty
ts
deleteAddonProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { addonKey: string; propertyKey: string; } | - |
parameters.addonKey | string | The key of the app, as defined in its descriptor. |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<void>
appProperties.deleteForgeAppProperty
ts
deleteForgeAppProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { propertyKey: string; } | - |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<void>
appProperties.getAddonProperties
ts
getAddonProperties: (parameters) => Promise<{
[key: string]: unknown;
keys?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { addonKey: string; } | - |
parameters.addonKey | string | The key of the app, as defined in its descriptor. |
Returns
Promise<{ [key: string]: unknown; keys?: object[]; }>
appProperties.getAddonProperty
ts
getAddonProperty: (parameters) => Promise<{
[key: string]: unknown;
key?: string;
value?: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { addonKey: string; propertyKey: string; } | - |
parameters.addonKey | string | The key of the app, as defined in its descriptor. |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>
appProperties.getForgeAppProperty
ts
getForgeAppProperty: (parameters) => Promise<{
[key: string]: unknown;
key?: string;
value?: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { propertyKey: string; } | - |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>
appProperties.getForgeAppPropertyKeys
ts
getForgeAppPropertyKeys: () => Promise<{
[key: string]: unknown;
keys?: object[];
}>;Returns
Promise<{ [key: string]: unknown; keys?: object[]; }>
appProperties.putAddonProperty
ts
putAddonProperty: (parameters) => Promise<{
[key: string]: unknown;
message: string;
statusCode: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { addonKey: string; body: Record<string, any>; propertyKey: string; } | - |
parameters.addonKey | string | The key of the app, as defined in its descriptor. |
parameters.body | Record<string, any> | - |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<{ [key: string]: unknown; message: string; statusCode: number; }>
appProperties.putForgeAppProperty
ts
putForgeAppProperty: (parameters) => Promise<{
[key: string]: unknown;
message: string;
statusCode: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; propertyKey: string; } | - |
parameters.body | Record<string, any> | - |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<{ [key: string]: unknown; message: string; statusCode: number; }>
auditRecords
ts
auditRecords: object;auditRecords.getAuditRecords
ts
getAuditRecords: (parameters?) => Promise<{
[key: string]: unknown;
limit?: number;
offset?: number;
records?: object[];
total?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { filter?: string; from?: string; limit?: number; offset?: number; to?: string; } | - |
parameters.filter? | string | The strings to match with audit field content, space separated. |
parameters.from? | string | The date and time on or after which returned audit records must have been created. If to is provided from must be before to or no audit records are returned. |
parameters.limit? | number | The maximum number of results to return. |
parameters.offset? | number | The number of records to skip before returning the first result. |
parameters.to? | string | The date and time on or before which returned audit results must have been created. If from is provided to must be after from or no audit records are returned. |
Returns
Promise<{ [key: string]: unknown; limit?: number; offset?: number; records?: object[]; total?: number; }>
avatars
ts
avatars: object;avatars.deleteAvatar
ts
deleteAvatar: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; owningObjectId: string; type: "priority" | string & object | "project" | "issuetype"; } | - |
parameters.id | number | The ID of the avatar. |
parameters.owningObjectId | string | The ID of the item the avatar is associated with. |
parameters.type | "priority" | string & object | "project" | "issuetype" | The avatar type. |
Returns
Promise<void>
avatars.getAllSystemAvatars
ts
getAllSystemAvatars: (parameters) => Promise<{
[key: string]: unknown;
system?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { type: "priority" | "user" | string & object | "project" | "issuetype"; } | - |
parameters.type | "priority" | "user" | string & object | "project" | "issuetype" | The avatar type. |
Returns
Promise<{ [key: string]: unknown; system?: object[]; }>
avatars.getAvatarImageByID
ts
getAvatarImageByID: (parameters) => Promise<{
[key: string]: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { format?: "svg" | string & object | "png"; id: number; size?: "small" | "medium" | string & object | "xsmall" | "large" | "xlarge"; type: "priority" | string & object | "project" | "issuetype"; } | - |
parameters.format? | "svg" | string & object | "png" | The format to return the avatar image in. If not provided the original content format is returned. |
parameters.id | number | The ID of the avatar. |
parameters.size? | "small" | "medium" | string & object | "xsmall" | "large" | "xlarge" | The size of the avatar image. If not provided the default size is returned. |
parameters.type | "priority" | string & object | "project" | "issuetype" | The icon type of the avatar. |
Returns
Promise<{ [key: string]: unknown; }>
avatars.getAvatarImageByOwner
ts
getAvatarImageByOwner: (parameters) => Promise<{
[key: string]: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { entityId: string; format?: "svg" | string & object | "png"; size?: "small" | "medium" | string & object | "xsmall" | "large" | "xlarge"; type: "priority" | string & object | "project" | "issuetype"; } | - |
parameters.entityId | string | The ID of the project or issue type the avatar belongs to. |
parameters.format? | "svg" | string & object | "png" | The format to return the avatar image in. If not provided the original content format is returned. |
parameters.size? | "small" | "medium" | string & object | "xsmall" | "large" | "xlarge" | The size of the avatar image. If not provided the default size is returned. |
parameters.type | "priority" | string & object | "project" | "issuetype" | The icon type of the avatar. |
Returns
Promise<{ [key: string]: unknown; }>
avatars.getAvatarImageByType
ts
getAvatarImageByType: (parameters) => Promise<{
[key: string]: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { format?: "svg" | string & object | "png"; size?: "small" | "medium" | string & object | "xsmall" | "large" | "xlarge"; type: "priority" | string & object | "project" | "issuetype"; } | - |
parameters.format? | "svg" | string & object | "png" | The format to return the avatar image in. If not provided the original content format is returned. |
parameters.size? | "small" | "medium" | string & object | "xsmall" | "large" | "xlarge" | The size of the avatar image. If not provided the default size is returned. |
parameters.type | "priority" | string & object | "project" | "issuetype" | The icon type of the avatar. |
Returns
Promise<{ [key: string]: unknown; }>
avatars.getAvatars
ts
getAvatars: (parameters) => Promise<{
[key: string]: unknown;
custom?: object[];
system?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { entityId: string; type: "priority" | string & object | "project" | "issuetype"; } | - |
parameters.entityId | string | The ID of the item the avatar is associated with. |
parameters.type | "priority" | string & object | "project" | "issuetype" | The avatar type. |
Returns
Promise<{ [key: string]: unknown; custom?: object[]; system?: object[]; }>
avatars.storeAvatar
ts
storeAvatar: (parameters) => Promise<{
[key: string]: unknown;
fileName?: string;
id: string;
isDeletable?: boolean;
isSelected?: boolean;
isSystemAvatar?: boolean;
owner?: string;
urls?: Record<string, any>;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; entityId: string; size: number; type: "priority" | string & object | "project" | "issuetype"; x?: number; y?: number; } | - |
parameters.body | Record<string, any> | - |
parameters.entityId | string | The ID of the item the avatar is associated with. |
parameters.size | number | The length of each side of the crop region. |
parameters.type | "priority" | string & object | "project" | "issuetype" | The avatar type. |
parameters.x? | number | The X coordinate of the top-left corner of the crop region. |
parameters.y? | number | The Y coordinate of the top-left corner of the crop region. |
Returns
Promise<{ [key: string]: unknown; fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; urls?: Record<string, any>; }>
dashboards
ts
dashboards: object;dashboards.deleteDashboardItemProperty
ts
deleteDashboardItemProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { dashboardId: string; itemId: string; propertyKey: string; } | - |
parameters.dashboardId | string | The ID of the dashboard. |
parameters.itemId | string | The ID of the dashboard item. |
parameters.propertyKey | string | The key of the dashboard item property. |
Returns
Promise<void>
dashboards.getAllDashboards
ts
getAllDashboards: (parameters?) => Promise<{
[key: string]: unknown;
dashboards?: object[];
maxResults?: number;
next?: string;
prev?: string;
startAt?: number;
total?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { filter?: string & object | "favourite" | "my"; maxResults?: number; startAt?: number; } | - |
parameters.filter? | string & object | "favourite" | "my" | The filter applied to the list of dashboards. Valid values are: - favourite Returns dashboards the user has marked as favorite. - my Returns dashboards owned by the user. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; dashboards?: object[]; maxResults?: number; next?: string; prev?: string; startAt?: number; total?: number; }>
dashboards.getDashboard
ts
getDashboard: (parameters) => Promise<{
[key: string]: unknown;
automaticRefreshMs?: number;
description?: string;
editPermissions?: object[];
id?: string;
isFavourite?: boolean;
isWritable?: boolean;
name?: string;
owner?: {
[key: string]: unknown;
accountId?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
self?: string;
};
popularity?: number;
rank?: number;
self?: string;
sharePermissions?: object[];
systemDashboard?: boolean;
view?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the dashboard. |
Returns
Promise<{ [key: string]: unknown; automaticRefreshMs?: number; description?: string; editPermissions?: object[]; id?: string; isFavourite?: boolean; isWritable?: boolean; name?: string; owner?: { [key: string]: unknown; accountId?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; self?: string; }; popularity?: number; rank?: number; self?: string; sharePermissions?: object[]; systemDashboard?: boolean; view?: string; }>
dashboards.getDashboardItemProperty
ts
getDashboardItemProperty: (parameters) => Promise<{
[key: string]: unknown;
key?: string;
value?: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { dashboardId: string; itemId: string; propertyKey: string; } | - |
parameters.dashboardId | string | The ID of the dashboard. |
parameters.itemId | string | The ID of the dashboard item. |
parameters.propertyKey | string | The key of the dashboard item property. |
Returns
Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>
dashboards.getDashboardItemPropertyKeys
ts
getDashboardItemPropertyKeys: (parameters) => Promise<{
[key: string]: unknown;
keys?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { dashboardId: string; itemId: string; } | - |
parameters.dashboardId | string | The ID of the dashboard. |
parameters.itemId | string | The ID of the dashboard item. |
Returns
Promise<{ [key: string]: unknown; keys?: object[]; }>
dashboards.getDashboardsPaginated
ts
getDashboardsPaginated: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { accountId?: string; dashboardName?: string; expand?: | string | string[] | string & object | ( | "description" | string & object | "viewUrl" | "owner" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "favouritedCount")[]; groupId?: string; groupname?: string; maxResults?: number; orderBy?: | "name" | "id" | "description" | string & object | "owner" | "-description" | "+description" | "-name" | "+name" | "favorite_count" | "-favorite_count" | "+favorite_count" | "-id" | "+id" | "is_favorite" | "-is_favorite" | "+is_favorite" | "-owner" | "+owner"; projectId?: number; startAt?: number; status?: "deleted" | "active" | string & object | "archived"; } | - |
parameters.accountId? | string | User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter. |
parameters.dashboardName? | string | String used to perform a case-insensitive partial match with name. |
parameters.expand? | | string | string[] | string & object | ( | "description" | string & object | "viewUrl" | "owner" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "favouritedCount")[] | Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: - description Returns the description of the dashboard. - owner Returns the owner of the dashboard. - viewUrl Returns the URL that is used to view the dashboard. - favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite. - favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite. - sharePermissions Returns details of the share permissions defined for the dashboard. - editPermissions Returns details of the edit permissions defined for the dashboard. - isWritable Returns whether the current user has permission to edit the dashboard. |
parameters.groupId? | string | Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter. |
parameters.groupname? | string | As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | | "name" | "id" | "description" | string & object | "owner" | "-description" | "+description" | "-name" | "+name" | "favorite_count" | "-favorite_count" | "+favorite_count" | "-id" | "+id" | "is_favorite" | "-is_favorite" | "+is_favorite" | "-owner" | "+owner" | Order the results by a field: - description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. - favourite_count Sorts by dashboard popularity. - id Sorts by dashboard ID. - is_favourite Sorts by whether the dashboard is marked as a favorite. - name Sorts by dashboard name. - owner Sorts by dashboard owner name. |
parameters.projectId? | number | Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
parameters.status? | "deleted" | "active" | string & object | "archived" | The status to filter by. It may be active, archived or deleted. |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
dashboards.setDashboardItemProperty
ts
setDashboardItemProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; dashboardId: string; itemId: string; propertyKey: string; } | - |
parameters.body | Record<string, any> | - |
parameters.dashboardId | string | The ID of the dashboard. |
parameters.itemId | string | The ID of the dashboard item. |
parameters.propertyKey | string | The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI and no complete module key, if the provided propertyKey is equal to "config", the request body's JSON must be an object with all keys and values as strings. |
Returns
Promise<void>
dynamicModules
ts
dynamicModules: object;dynamicModules.getModules
ts
getModules: () => Promise<{
[key: string]: unknown;
modules: object[];
}>;Returns
Promise<{ [key: string]: unknown; modules: object[]; }>
dynamicModules.registerModules
ts
registerModules: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { modules: object[]; } | - |
parameters.modules | object[] | A list of app modules in the same format as the modules property in the app descriptor. |
Returns
Promise<void>
dynamicModules.removeModules
ts
removeModules: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { moduleKey?: string[]; } | - |
parameters.moduleKey? | string[] | The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field. Nonexistent keys are ignored. |
Returns
Promise<void>
filters
ts
filters: object;filters.createFilter
ts
createFilter: (parameters) => Promise<{
[key: string]: unknown;
approximateLastUsed?: Date;
description?: string;
editPermissions?: object[];
favourite?: boolean;
favouritedCount?: number;
id?: string;
isWritable?: boolean;
jql?: string;
name: string;
owner?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
searchUrl?: string;
self?: string;
sharedUsers?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
sharePermissions?: object[];
subscriptions?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
viewUrl?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { approximateLastUsed?: unknown; description?: string; editPermissions?: object[]; expand?: | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; overrideSharePermissions?: boolean; owner?: { [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; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; viewUrl?: string; } | - |
parameters.approximateLastUsed? | unknown | [Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns null if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate. |
parameters.description? | string | A description of the filter. |
parameters.editPermissions? | object[] | The groups and projects that can edit the filter. |
parameters.expand? | | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[] | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. - subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. |
parameters.favourite? | boolean | Whether the filter is selected as a favorite. |
parameters.favouritedCount? | number | The count of how many users have selected this filter as a favorite, including the filter owner. |
parameters.id? | string | The unique identifier for the filter. |
parameters.isWritable? | boolean | - |
parameters.jql? | string | The JQL query for the filter. For example, project = SSP AND issuetype = Bug. |
parameters.name | string | The name of the filter. Must be unique. |
parameters.overrideSharePermissions? | boolean | EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with Administer Jira global permission. |
parameters.owner? | { [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; } | - |
parameters.owner.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.owner.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.owner.active? | boolean | Whether the user is active. |
parameters.owner.applicationRoles? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.owner.applicationRoles.callback? | { [key: string]: unknown; } | - |
parameters.owner.applicationRoles.items? | object[] | - |
parameters.owner.applicationRoles.max-results? | number | - |
parameters.owner.applicationRoles.pagingCallback? | { [key: string]: unknown; } | - |
parameters.owner.applicationRoles.size? | number | - |
parameters.owner.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.owner.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.owner.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.owner.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.owner.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.owner.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.owner.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.owner.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.owner.expand? | string | Expand options that include additional user details in the response. |
parameters.owner.groups? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.owner.groups.callback? | { [key: string]: unknown; } | - |
parameters.owner.groups.items? | object[] | - |
parameters.owner.groups.max-results? | number | - |
parameters.owner.groups.pagingCallback? | { [key: string]: unknown; } | - |
parameters.owner.groups.size? | number | - |
parameters.owner.guest? | boolean | Whether the user is a guest. |
parameters.owner.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.owner.self? | string | The URL of the user. |
parameters.owner.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.searchUrl? | string | A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, _https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug_. |
parameters.self? | string | The URL of the filter. |
parameters.sharedUsers? | { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; } | - |
parameters.sharedUsers.end-index? | number | The index of the last item returned on the page. |
parameters.sharedUsers.items? | object[] | The list of items. |
parameters.sharedUsers.max-results? | number | The maximum number of results that could be on the page. |
parameters.sharedUsers.size? | number | The number of items on the page. |
parameters.sharedUsers.start-index? | number | The index of the first item returned on the page. |
parameters.sharePermissions? | object[] | The groups and projects that the filter is shared with. |
parameters.subscriptions? | { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; } | - |
parameters.subscriptions.end-index? | number | The index of the last item returned on the page. |
parameters.subscriptions.items? | object[] | The list of items. |
parameters.subscriptions.max-results? | number | The maximum number of results that could be on the page. |
parameters.subscriptions.size? | number | The number of items on the page. |
parameters.subscriptions.start-index? | number | The index of the first item returned on the page. |
parameters.viewUrl? | string | A URL to view the filter results in Jira, using the ID of the filter. For example, _https://your-domain.atlassian.net/issues/?filter=10100_. |
Returns
Promise<{ [key: string]: unknown; approximateLastUsed?: Date; description?: string; editPermissions?: object[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; owner?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; viewUrl?: string; }>
filters.deleteFavouriteForFilter
ts
deleteFavouriteForFilter: (parameters) => Promise<{
[key: string]: unknown;
approximateLastUsed?: Date;
description?: string;
editPermissions?: object[];
favourite?: boolean;
favouritedCount?: number;
id?: string;
isWritable?: boolean;
jql?: string;
name: string;
owner?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
searchUrl?: string;
self?: string;
sharedUsers?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
sharePermissions?: object[];
subscriptions?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
viewUrl?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[]; id: number; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[] | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. - subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. |
parameters.id | number | The ID of the filter. |
Returns
Promise<{ [key: string]: unknown; approximateLastUsed?: Date; description?: string; editPermissions?: object[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; owner?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; viewUrl?: string; }>
filters.deleteFilter
ts
deleteFilter: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the filter to delete. |
Returns
Promise<void>
filters.getColumns
ts
getColumns: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the filter. |
Returns
Promise<object[]>
filters.getFavouriteFilters
ts
getFavouriteFilters: (parameters?) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[]; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[] | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. - subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. |
Returns
Promise<object[]>
filters.getFilter
ts
getFilter: (parameters) => Promise<{
[key: string]: unknown;
approximateLastUsed?: Date;
description?: string;
editPermissions?: object[];
favourite?: boolean;
favouritedCount?: number;
id?: string;
isWritable?: boolean;
jql?: string;
name: string;
owner?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
searchUrl?: string;
self?: string;
sharedUsers?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
sharePermissions?: object[];
subscriptions?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
viewUrl?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[]; id: number; overrideSharePermissions?: boolean; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[] | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. - subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. |
parameters.id | number | The ID of the filter to return. |
parameters.overrideSharePermissions? | boolean | EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission. |
Returns
Promise<{ [key: string]: unknown; approximateLastUsed?: Date; description?: string; editPermissions?: object[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; owner?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; viewUrl?: string; }>
filters.getFiltersPaginated
ts
getFiltersPaginated: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { accountId?: string; expand?: | string | string[] | string & object | ( | "description" | string & object | "jql" | "viewUrl" | "owner" | "searchUrl" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "approximateLastUsed" | "favouritedCount" | "subscriptions")[]; filterName?: string; groupId?: string; groupname?: string; id?: number[]; isSubstringMatch?: boolean; maxResults?: number; orderBy?: | "name" | "id" | "description" | string & object | "owner" | "-description" | "+description" | "-name" | "+name" | "-id" | "+id" | "-owner" | "+owner" | "favourite_count" | "-favourite_count" | "+favourite_count" | "is_favourite" | "-is_favourite" | "+is_favourite" | "is_shared" | "-is_shared" | "+is_shared"; overrideSharePermissions?: boolean; projectId?: number; startAt?: number; } | - |
parameters.accountId? | string | User account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner. |
parameters.expand? | | string | string[] | string & object | ( | "description" | string & object | "jql" | "viewUrl" | "owner" | "searchUrl" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "approximateLastUsed" | "favouritedCount" | "subscriptions")[] | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - description Returns the description of the filter. - favourite Returns an indicator of whether the user has set the filter as a favorite. - favouritedCount Returns a count of how many users have set this filter as a favorite. - jql Returns the JQL query that the filter uses. - owner Returns the owner of the filter. - searchUrl Returns a URL to perform the filter's JQL query. - sharePermissions Returns the share permissions defined for the filter. - editPermissions Returns the edit permissions defined for the filter. - isWritable Returns whether the current user has permission to edit the filter. - approximateLastUsed [Experimental] Returns the approximate date and time when the filter was last evaluated. - subscriptions Returns the users that are subscribed to the filter. - viewUrl Returns a URL to view the filter. |
parameters.filterName? | string | String used to perform a case-insensitive partial match with name. |
parameters.groupId? | string | Group ID used to returns filters that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter. |
parameters.groupname? | string | As a group's name can change, use of groupId is recommended to identify a group. Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname. This parameter cannot be used with the groupId parameter. |
parameters.id? | number[] | The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Do not exceed 200 filter IDs. |
parameters.isSubstringMatch? | boolean | When true this will perform a case-insensitive substring match for the provided filterName. When false the filter name will be searched using full text search syntax. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | | "name" | "id" | "description" | string & object | "owner" | "-description" | "+description" | "-name" | "+name" | "-id" | "+id" | "-owner" | "+owner" | "favourite_count" | "-favourite_count" | "+favourite_count" | "is_favourite" | "-is_favourite" | "+is_favourite" | "is_shared" | "-is_shared" | "+is_shared" | Order the results by a field: - description Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use. - favourite_count Sorts by the count of how many users have this filter as a favorite. - is_favourite Sorts by whether the filter is marked as a favorite. - id Sorts by filter ID. - name Sorts by filter name. - owner Sorts by the ID of the filter owner. - is_shared Sorts by whether the filter is shared. |
parameters.overrideSharePermissions? | boolean | EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission. |
parameters.projectId? | number | Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
filters.getMyFilters
ts
getMyFilters: (parameters?) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[]; includeFavourites?: boolean; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[] | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. - subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. |
parameters.includeFavourites? | boolean | Include the user's favorite filters in the response. |
Returns
Promise<object[]>
filters.resetColumns
ts
resetColumns: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the filter. |
Returns
Promise<void>
filters.setColumns
ts
setColumns: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { columns?: string[]; id: number; } | - |
parameters.columns? | string[] | - |
parameters.id | number | The ID of the filter. |
Returns
Promise<void>
filters.setFavouriteForFilter
ts
setFavouriteForFilter: (parameters) => Promise<{
[key: string]: unknown;
approximateLastUsed?: Date;
description?: string;
editPermissions?: object[];
favourite?: boolean;
favouritedCount?: number;
id?: string;
isWritable?: boolean;
jql?: string;
name: string;
owner?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
searchUrl?: string;
self?: string;
sharedUsers?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
sharePermissions?: object[];
subscriptions?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
viewUrl?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[]; id: number; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[] | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. - subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. |
parameters.id | number | The ID of the filter. |
Returns
Promise<{ [key: string]: unknown; approximateLastUsed?: Date; description?: string; editPermissions?: object[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; owner?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; viewUrl?: string; }>
filters.updateFilter
ts
updateFilter: (parameters) => Promise<{
[key: string]: unknown;
approximateLastUsed?: Date;
description?: string;
editPermissions?: object[];
favourite?: boolean;
favouritedCount?: number;
id?: string;
isWritable?: boolean;
jql?: string;
name: string;
owner?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
searchUrl?: string;
self?: string;
sharedUsers?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
sharePermissions?: object[];
subscriptions?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
viewUrl?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; approximateLastUsed?: unknown; description?: string; editPermissions?: object[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; owner?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; viewUrl?: string; }; expand?: | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[]; id: number; overrideSharePermissions?: boolean; } | - |
parameters.body | { [key: string]: unknown; approximateLastUsed?: unknown; description?: string; editPermissions?: object[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; owner?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; viewUrl?: string; } | - |
parameters.body.approximateLastUsed? | unknown | [Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns null if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate. |
parameters.body.description? | string | A description of the filter. |
parameters.body.editPermissions? | object[] | The groups and projects that can edit the filter. |
parameters.body.favourite? | boolean | Whether the filter is selected as a favorite. |
parameters.body.favouritedCount? | number | The count of how many users have selected this filter as a favorite, including the filter owner. |
parameters.body.id? | string | The unique identifier for the filter. |
parameters.body.isWritable? | boolean | - |
parameters.body.jql? | string | The JQL query for the filter. For example, project = SSP AND issuetype = Bug. |
parameters.body.name | string | The name of the filter. Must be unique. |
parameters.body.owner? | { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; } | - |
parameters.body.owner.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.body.owner.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.body.owner.active? | boolean | Whether the user is active. |
parameters.body.owner.applicationRoles? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.owner.applicationRoles.callback? | { [key: ...]: ...; } | - |
parameters.body.owner.applicationRoles.items? | ...[] | - |
parameters.body.owner.applicationRoles.max-results? | number | - |
parameters.body.owner.applicationRoles.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.owner.applicationRoles.size? | number | - |
parameters.body.owner.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.body.owner.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.owner.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.owner.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.owner.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.owner.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.owner.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.body.owner.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.owner.expand? | string | Expand options that include additional user details in the response. |
parameters.body.owner.groups? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.owner.groups.callback? | { [key: ...]: ...; } | - |
parameters.body.owner.groups.items? | ...[] | - |
parameters.body.owner.groups.max-results? | number | - |
parameters.body.owner.groups.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.owner.groups.size? | number | - |
parameters.body.owner.guest? | boolean | Whether the user is a guest. |
parameters.body.owner.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.owner.self? | string | The URL of the user. |
parameters.body.owner.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.body.searchUrl? | string | A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, _https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug_. |
parameters.body.self? | string | The URL of the filter. |
parameters.body.sharedUsers? | { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; } | - |
parameters.body.sharedUsers.end-index? | number | The index of the last item returned on the page. |
parameters.body.sharedUsers.items? | object[] | The list of items. |
parameters.body.sharedUsers.max-results? | number | The maximum number of results that could be on the page. |
parameters.body.sharedUsers.size? | number | The number of items on the page. |
parameters.body.sharedUsers.start-index? | number | The index of the first item returned on the page. |
parameters.body.sharePermissions? | object[] | The groups and projects that the filter is shared with. |
parameters.body.subscriptions? | { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; } | - |
parameters.body.subscriptions.end-index? | number | The index of the last item returned on the page. |
parameters.body.subscriptions.items? | object[] | The list of items. |
parameters.body.subscriptions.max-results? | number | The maximum number of results that could be on the page. |
parameters.body.subscriptions.size? | number | The number of items on the page. |
parameters.body.subscriptions.start-index? | number | The index of the first item returned on the page. |
parameters.body.viewUrl? | string | A URL to view the filter results in Jira, using the ID of the filter. For example, _https://your-domain.atlassian.net/issues/?filter=10100_. |
parameters.expand? | | string | string[] | string & object | (string & object | "sharedUsers" | "subscriptions")[] | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. - subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. |
parameters.id | number | The ID of the filter to update. |
parameters.overrideSharePermissions? | boolean | EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with Administer Jira global permission. |
Returns
Promise<{ [key: string]: unknown; approximateLastUsed?: Date; description?: string; editPermissions?: object[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; owner?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; viewUrl?: string; }>
filterSharing
ts
filterSharing: object;filterSharing.addSharePermission
ts
addSharePermission: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; groupId?: string; groupname?: string; id: number; projectId?: string; projectRoleId?: string; rights?: number; type: | "global" | "user" | "group" | string & object | "project" | "projectRole" | "authenticated"; } | - |
parameters.accountId? | string | The user account ID that the filter is shared with. For a request, specify the accountId property for the user. |
parameters.groupId? | string | The ID of the group, which uniquely identifies the group across all Atlassian products.For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2. Cannot be provided with groupname. |
parameters.groupname? | string | The name of the group to share the filter with. Set type to group. Please note that the name of a group is mutable, to reliably identify a group use groupId. |
parameters.id | number | The ID of the filter. |
parameters.projectId? | string | The ID of the project to share the filter with. Set type to project. |
parameters.projectRoleId? | string | The ID of the project role to share the filter with. Set type to projectRole and the projectId for the project that the role is in. |
parameters.rights? | number | The rights for the share permission. |
parameters.type | | "global" | "user" | "group" | string & object | "project" | "projectRole" | "authenticated" | The type of the share permission.Specify the type as follows: - user Share with a user. - group Share with a group. Specify groupname as well. - project Share with a project. Specify projectId as well. - projectRole Share with a project role in a project. Specify projectId and projectRoleId as well. - global Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set. - authenticated Share with all logged-in users. This shows as loggedin in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set. |
Returns
Promise<object[]>
filterSharing.deleteSharePermission
ts
deleteSharePermission: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; permissionId: number; } | - |
parameters.id | number | The ID of the filter. |
parameters.permissionId | number | The ID of the share permission. |
Returns
Promise<void>
filterSharing.getDefaultShareScope
ts
getDefaultShareScope: () => Promise<{
[key: string]: unknown;
scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE";
}>;Returns
Promise<{ [key: string]: unknown; scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE"; }>
filterSharing.getSharePermission
ts
getSharePermission: (parameters) => Promise<{
[key: string]: unknown;
group?: {
[key: string]: unknown;
groupId?: string | null;
name?: string;
self?: string;
};
id?: number;
project?: {
[key: string]: unknown;
archived?: boolean;
archivedBy?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | ... & ... | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: ...]: ...;
callback?: ...;
items?: ...;
max-results?: ...;
pagingCallback?: ...;
size?: ...;
};
appType?: string;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
displayName?: string;
emailAddress?: string;
expand?: string;
groups?: {
[key: ...]: ...;
callback?: ...;
items?: ...;
max-results?: ...;
pagingCallback?: ...;
size?: ...;
};
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" | ... & ... | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: ...]: ...;
callback?: ...;
items?: ...;
max-results?: ...;
pagingCallback?: ...;
size?: ...;
};
appType?: string;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
displayName?: string;
emailAddress?: string;
expand?: string;
groups?: {
[key: ...]: ...;
callback?: ...;
items?: ...;
max-results?: ...;
pagingCallback?: ...;
size?: ...;
};
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?: ...[];
};
issueTypes?: object[];
key?: string;
landingPageInfo?: {
[key: string]: unknown;
attributes?: Record<..., ...>;
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" | ... & ... | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: ...]: ...;
callback?: ...;
items?: ...;
max-results?: ...;
pagingCallback?: ...;
size?: ...;
};
appType?: string;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
displayName?: string;
emailAddress?: string;
expand?: string;
groups?: {
[key: ...]: ...;
callback?: ...;
items?: ...;
max-results?: ...;
pagingCallback?: ...;
size?: ...;
};
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, any>;
self?: string;
simplified?: boolean;
style?: "classic" | string & object | "next-gen";
url?: string;
uuid?: string;
versions?: object[];
};
role?: {
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: ...]: ...;
avatarUrls?: ...;
id?: ...;
key?: ...;
name?: ...;
projectCategory?: ...;
projectTypeKey?: ...;
self?: ...;
simplified?: ...;
};
type?: ... & ... | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
};
type: | "global"
| "user"
| "group"
| string & object
| "project"
| "projectRole"
| "loggedin"
| "authenticated"
| "project-unknown";
user?: {
[key: string]: unknown;
accountId?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
self?: string;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; permissionId: number; } | - |
parameters.id | number | The ID of the filter. |
parameters.permissionId | number | The ID of the share permission. |
Returns
Promise<{ [key: string]: unknown; group?: { [key: string]: unknown; groupId?: string | null; name?: string; self?: string; }; id?: number; project?: { [key: string]: unknown; archived?: boolean; archivedBy?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | ... & ... | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: ...]: ...; callback?: ...; items?: ...; max-results?: ...; pagingCallback?: ...; size?: ...; }; appType?: string; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: ...]: ...; callback?: ...; items?: ...; max-results?: ...; pagingCallback?: ...; size?: ...; }; 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" | ... & ... | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: ...]: ...; callback?: ...; items?: ...; max-results?: ...; pagingCallback?: ...; size?: ...; }; appType?: string; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: ...]: ...; callback?: ...; items?: ...; max-results?: ...; pagingCallback?: ...; size?: ...; }; 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?: ...[]; }; issueTypes?: object[]; key?: string; landingPageInfo?: { [key: string]: unknown; attributes?: Record<..., ...>; 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" | ... & ... | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: ...]: ...; callback?: ...; items?: ...; max-results?: ...; pagingCallback?: ...; size?: ...; }; appType?: string; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: ...]: ...; callback?: ...; items?: ...; max-results?: ...; pagingCallback?: ...; size?: ...; }; 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, any>; self?: string; simplified?: boolean; style?: "classic" | string & object | "next-gen"; url?: string; uuid?: string; versions?: object[]; }; role?: { [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: ...]: ...; avatarUrls?: ...; id?: ...; key?: ...; name?: ...; projectCategory?: ...; projectTypeKey?: ...; self?: ...; simplified?: ...; }; type?: ... & ... | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }; type: | "global" | "user" | "group" | string & object | "project" | "projectRole" | "loggedin" | "authenticated" | "project-unknown"; user?: { [key: string]: unknown; accountId?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; self?: string; }; }>
filterSharing.getSharePermissions
ts
getSharePermissions: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the filter. |
Returns
Promise<object[]>
filterSharing.setDefaultShareScope
ts
setDefaultShareScope: (parameters) => Promise<{
[key: string]: unknown;
scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE";
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE"; } | - |
parameters.scope | string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE" | The scope of the default sharing for new filters and dashboards: - AUTHENTICATED Shared with all logged-in users. - GLOBAL Shared with all logged-in users. This shows as AUTHENTICATED in the response. - PRIVATE Not shared with any users. |
Returns
Promise<{ [key: string]: unknown; scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE"; }>
groupAndUserPicker
ts
groupAndUserPicker: object;groupAndUserPicker.findUsersAndGroups
ts
findUsersAndGroups: (parameters) => Promise<{
[key: string]: unknown;
groups?: {
[key: string]: unknown;
groups?: object[];
header?: string;
total?: number;
};
users?: {
[key: string]: unknown;
header?: string;
total?: number;
users?: object[];
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { avatarSize?: | "small" | "medium" | string & object | "xsmall" | "large" | "xlarge" | "xsmall@2x" | "xsmall@3x" | "small@2x" | "small@3x" | "medium@2x" | "medium@3x" | "large@2x" | "large@3x" | "xlarge@2x" | "xlarge@3x" | "xxlarge" | "xxlarge@2x" | "xxlarge@3x" | "xxxlarge" | "xxxlarge@2x" | "xxxlarge@3x"; caseInsensitive?: boolean; excludeConnectAddons?: boolean; fieldId?: string; includeAiAgents?: boolean; issueTypeId?: string[]; maxResults?: number; projectId?: string[]; query: string; showAvatar?: boolean; } | - |
parameters.avatarSize? | | "small" | "medium" | string & object | "xsmall" | "large" | "xlarge" | "xsmall@2x" | "xsmall@3x" | "small@2x" | "small@3x" | "medium@2x" | "medium@3x" | "large@2x" | "large@3x" | "xlarge@2x" | "xlarge@3x" | "xxlarge" | "xxlarge@2x" | "xxlarge@3x" | "xxxlarge" | "xxxlarge@2x" | "xxxlarge@3x" | The size of the avatar to return. If an invalid value is provided, the default value is used. |
parameters.caseInsensitive? | boolean | Whether the search for groups should be case insensitive. |
parameters.excludeConnectAddons? | boolean | Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used. |
parameters.fieldId? | string | The custom field ID of the field this request is for. |
parameters.includeAiAgents? | boolean | Whether AI Agents should be included in the search results. If an invalid value is provided, the default value is used. |
parameters.issueTypeId? | string[] | The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, issueTypeId=10000&issueTypeId=10001. Special values, such as -1 (all standard issue types) and -2 (all subtask issue types), are supported. This parameter is only used when fieldId is present. |
parameters.maxResults? | number | The maximum number of items to return in each list. |
parameters.projectId? | string[] | The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&projectId=10001. This parameter is only used when fieldId is present. |
parameters.query | string | The search string. |
parameters.showAvatar? | boolean | Whether the user avatar should be returned. If an invalid value is provided, the default value is used. |
Returns
Promise<{ [key: string]: unknown; groups?: { [key: string]: unknown; groups?: object[]; header?: string; total?: number; }; users?: { [key: string]: unknown; header?: string; total?: number; users?: object[]; }; }>
groups
ts
groups: object;groups.addUserToGroup
ts
addUserToGroup: (parameters) => Promise<{
[key: string]: unknown;
expand?: string;
groupId?: string | null;
name?: string;
self?: string;
users?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; groupId?: string; groupname?: string; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.groupId? | string | The ID of the group. This parameter cannot be used with the groupName parameter. |
parameters.groupname? | string | As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter. |
Returns
Promise<{ [key: string]: unknown; expand?: string; groupId?: string | null; name?: string; self?: string; users?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; }>
groups.createGroup
ts
createGroup: (parameters) => Promise<{
[key: string]: unknown;
expand?: string;
groupId?: string | null;
name?: string;
self?: string;
users?: {
[key: string]: unknown;
end-index?: number;
items?: object[];
max-results?: number;
size?: number;
start-index?: number;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { name: string; } | - |
parameters.name | string | The name of the group. |
Returns
Promise<{ [key: string]: unknown; expand?: string; groupId?: string | null; name?: string; self?: string; users?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; }>
groups.findGroups
ts
findGroups: (parameters?) => Promise<{
[key: string]: unknown;
groups?: object[];
header?: string;
total?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { caseInsensitive?: boolean; exclude?: string[]; excludeId?: string[]; maxResults?: number; query?: string; } | - |
parameters.caseInsensitive? | boolean | Whether the search for groups should be case insensitive. |
parameters.exclude? | string[] | As a group's name can change, use of excludeGroupIds is recommended to identify a group. A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, exclude=group1&exclude=group2. This parameter cannot be used with the excludeGroupIds parameter. |
parameters.excludeId? | string[] | A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, excludeId=group1-id&excludeId=group2-id. This parameter cannot be used with the excludeGroups parameter. |
parameters.maxResults? | number | The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property jira.ajax.autocomplete.limit. |
parameters.query? | string | The string to find in group names. |
Returns
Promise<{ [key: string]: unknown; groups?: object[]; header?: string; total?: number; }>
groups.getUsersFromGroup
ts
getUsersFromGroup: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { groupId?: string; groupname?: string; includeInactiveUsers?: boolean; maxResults?: number; startAt?: number; } | - |
parameters.groupId? | string | The ID of the group. This parameter cannot be used with the groupName parameter. |
parameters.groupname? | string | As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter. |
parameters.includeInactiveUsers? | boolean | Include inactive users. |
parameters.maxResults? | number | The maximum number of items to return per page (number should be between 1 and 50). |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
groups.removeGroup
ts
removeGroup: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { groupId?: string; groupname?: string; swapGroup?: string; swapGroupId?: string; } | - |
parameters.groupId? | string | The ID of the group. This parameter cannot be used with the groupname parameter. |
parameters.groupname? | string | - |
parameters.swapGroup? | string | As a group's name can change, use of swapGroupId is recommended to identify a group. The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroupId parameter. |
parameters.swapGroupId? | string | The ID of the group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroup parameter. |
Returns
Promise<void>
groups.removeUserFromGroup
ts
removeUserFromGroup: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId: string; groupId?: string; groupname?: string; } | - |
parameters.accountId | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.groupId? | string | The ID of the group. This parameter cannot be used with the groupName parameter. |
parameters.groupname? | string | As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter. |
Returns
Promise<void>
issueAttachments
ts
issueAttachments: object;issueAttachments.addAttachment
ts
addAttachment: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { attachments: | AttachmentInput | AttachmentInput[]; issueIdOrKey: string; } | - |
parameters.attachments | | AttachmentInput | AttachmentInput[] | - |
parameters.issueIdOrKey | string | The ID or key of the issue that attachments are added to. |
Returns
Promise<object[]>
issueAttachments.getAttachment
ts
getAttachment: (parameters) => Promise<{
[key: string]: unknown;
author?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
content?: string;
created?: Date;
filename?: string;
id?: number;
mimeType?: string;
properties?: Record<string, any>;
self?: string;
size?: number;
thumbnail?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the attachment. |
Returns
Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; content?: string; created?: Date; filename?: string; id?: number; mimeType?: string; properties?: Record<string, any>; self?: string; size?: number; thumbnail?: string; }>
issueAttachments.getAttachmentContent
ts
getAttachmentContent: (parameters) => Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; redirect?: boolean; } | - |
parameters.id | string | The ID of the attachment. |
parameters.redirect? | boolean | Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to false to avoid making multiple requests to download the attachment. |
Returns
Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>
issueAttachments.getAttachmentMeta
ts
getAttachmentMeta: () => Promise<{
[key: string]: unknown;
enabled?: boolean;
uploadLimit?: number;
}>;Returns
Promise<{ [key: string]: unknown; enabled?: boolean; uploadLimit?: number; }>
issueAttachments.getAttachmentThumbnail
ts
getAttachmentThumbnail: (parameters) => Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fallbackToDefault?: boolean; height?: number; id: string; redirect?: boolean; width?: number; } | - |
parameters.fallbackToDefault? | boolean | Whether a default thumbnail is returned when the requested thumbnail is not found. |
parameters.height? | number | The maximum height to scale the thumbnail to. |
parameters.id | string | The ID of the attachment. |
parameters.redirect? | boolean | Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to false to avoid making multiple requests to download the attachment. |
parameters.width? | number | The maximum width to scale the thumbnail to. |
Returns
Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>
issueAttachments.removeAttachment
ts
removeAttachment: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the attachment. |
Returns
Promise<void>
issueBulkOperations
ts
issueBulkOperations: object;issueBulkOperations.getAvailableTransitions
ts
getAvailableTransitions: (parameters) => Promise<{
[key: string]: unknown;
availableTransitions?: object[];
endingBefore?: string;
startingAfter?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { endingBefore?: string; issueIdsOrKeys: string; startingAfter?: string; } | - |
parameters.endingBefore? | string | (Optional)The end cursor for use in pagination. |
parameters.issueIdsOrKeys | string | Comma (,) separated Ids or keys of the issues to get transitions available for them. |
parameters.startingAfter? | string | (Optional)The start cursor for use in pagination. |
Returns
Promise<{ [key: string]: unknown; availableTransitions?: object[]; endingBefore?: string; startingAfter?: string; }>
issueBulkOperations.getBulkEditableFields
ts
getBulkEditableFields: (parameters) => Promise<{
[key: string]: unknown;
endingBefore?: string;
fields?: object[];
startingAfter?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { endingBefore?: string; issueIdsOrKeys: string; searchText?: string; startingAfter?: string; } | - |
parameters.endingBefore? | string | (Optional)The end cursor for use in pagination. |
parameters.issueIdsOrKeys | string | The IDs or keys of the issues to get editable fields from. |
parameters.searchText? | string | (Optional)The text to search for in the editable fields. |
parameters.startingAfter? | string | (Optional)The start cursor for use in pagination. |
Returns
Promise<{ [key: string]: unknown; endingBefore?: string; fields?: object[]; startingAfter?: string; }>
issueBulkOperations.getBulkOperationProgress
ts
getBulkOperationProgress: (parameters) => Promise<{
[key: string]: unknown;
created?: Date;
failedAccessibleIssues?: Record<string, any>;
invalidOrInaccessibleIssueCount?: number;
processedAccessibleIssues?: number[];
progressPercent?: number;
started?: Date;
status?: | string & object
| "ENQUEUED"
| "RUNNING"
| "COMPLETE"
| "FAILED"
| "CANCEL_REQUESTED"
| "CANCELLED"
| "DEAD";
submittedBy?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
taskId?: string;
totalIssueCount?: number;
updated?: Date;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { taskId: string; } | - |
parameters.taskId | string | The ID of the task. |
Returns
Promise<{ [key: string]: unknown; created?: Date; failedAccessibleIssues?: Record<string, any>; invalidOrInaccessibleIssueCount?: number; processedAccessibleIssues?: number[]; progressPercent?: number; started?: Date; status?: | string & object | "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD"; submittedBy?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; taskId?: string; totalIssueCount?: number; updated?: Date; }>
issueBulkOperations.submitBulkDelete
ts
submitBulkDelete: (parameters) => Promise<{
[key: string]: unknown;
taskId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { selectedIssueIdsOrKeys: string[]; sendBulkNotification?: boolean | null; } | - |
parameters.selectedIssueIdsOrKeys | string[] | List of issue IDs or keys which are to be bulk deleted. These IDs or keys can be from different projects and issue types. |
parameters.sendBulkNotification? | boolean | null | A boolean value that indicates whether to send a bulk change notification when the issues are being deleted. If true, dispatches a bulk notification email to users about the updates. |
Returns
Promise<{ [key: string]: unknown; taskId?: string; }>
issueBulkOperations.submitBulkEdit
ts
submitBulkEdit: (parameters) => Promise<{
[key: string]: unknown;
taskId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { editedFieldsInput?: { [key: string]: unknown; cascadingSelectFields?: object[]; clearableNumberFields?: object[]; colorFields?: object[]; datePickerFields?: object[]; dateTimePickerFields?: object[]; issueType?: { [key: string]: unknown; issueTypeId: string; }; labelsFields?: object[]; multipleGroupPickerFields?: object[]; multipleSelectClearableUserPickerFields?: object[]; multipleSelectFields?: object[]; multipleVersionPickerFields?: object[]; multiselectComponents?: { [key: string]: unknown; bulkEditMultiSelectFieldOption: string & object | "ADD" | "REMOVE" | "REPLACE" | "REMOVE_ALL"; components: object[]; fieldId: string; }; originalEstimateField?: { [key: string]: unknown; originalEstimateField: string; }; priority?: { [key: string]: unknown; priorityId: string; }; richTextFields?: object[]; singleGroupPickerFields?: object[]; singleLineTextFields?: object[]; singleSelectClearableUserPickerFields?: object[]; singleSelectFields?: object[]; singleVersionPickerFields?: object[]; status?: { [key: string]: unknown; statusId: string; }; timeTrackingField?: { [key: string]: unknown; timeRemaining: string; }; urlFields?: object[]; }; selectedActions: string[]; selectedIssueIdsOrKeys: string[]; sendBulkNotification?: boolean | null; } | - |
parameters.editedFieldsInput? | { [key: string]: unknown; cascadingSelectFields?: object[]; clearableNumberFields?: object[]; colorFields?: object[]; datePickerFields?: object[]; dateTimePickerFields?: object[]; issueType?: { [key: string]: unknown; issueTypeId: string; }; labelsFields?: object[]; multipleGroupPickerFields?: object[]; multipleSelectClearableUserPickerFields?: object[]; multipleSelectFields?: object[]; multipleVersionPickerFields?: object[]; multiselectComponents?: { [key: string]: unknown; bulkEditMultiSelectFieldOption: string & object | "ADD" | "REMOVE" | "REPLACE" | "REMOVE_ALL"; components: object[]; fieldId: string; }; originalEstimateField?: { [key: string]: unknown; originalEstimateField: string; }; priority?: { [key: string]: unknown; priorityId: string; }; richTextFields?: object[]; singleGroupPickerFields?: object[]; singleLineTextFields?: object[]; singleSelectClearableUserPickerFields?: object[]; singleSelectFields?: object[]; singleVersionPickerFields?: object[]; status?: { [key: string]: unknown; statusId: string; }; timeTrackingField?: { [key: string]: unknown; timeRemaining: string; }; urlFields?: object[]; } | - |
parameters.editedFieldsInput.cascadingSelectFields? | object[] | Add or clear a cascading select field: - To add, specify optionId for both parent and child. - To clear the child, set its optionId to null. - To clear both, set the parent's optionId to null. |
parameters.editedFieldsInput.clearableNumberFields? | object[] | Add or clear a number field: - To add, specify a numeric value. - To clear, set value to null. |
parameters.editedFieldsInput.colorFields? | object[] | Add or clear a color field: - To add, specify the color name. Available colors are: purple, blue, green, teal, yellow, orange, grey, dark purple, dark blue, dark green, dark teal, dark yellow, dark orange, dark grey. - To clear, set the color name to an empty string. |
parameters.editedFieldsInput.datePickerFields? | object[] | Add or clear a date picker field: - To add, specify the date in d/mmm/yy format or ISO format dd-mm-yyyy. - To clear, set formattedDate to an empty string. |
parameters.editedFieldsInput.dateTimePickerFields? | object[] | Add or clear the planned start date and time: - To add, specify the date and time in ISO format for formattedDateTime. - To clear, provide an empty string for formattedDateTime. |
parameters.editedFieldsInput.issueType? | { [key: string]: unknown; issueTypeId: string; } | - |
parameters.editedFieldsInput.issueType.issueTypeId | string | - |
parameters.editedFieldsInput.labelsFields? | object[] | Edit a labels field: - Options include ADD, REPLACE, REMOVE, or REMOVE_ALL for bulk edits. - To clear labels, use the REMOVE_ALL option with an empty labels array. |
parameters.editedFieldsInput.multipleGroupPickerFields? | object[] | Add or clear a multi-group picker field: - To add groups, provide an array of groups with groupNames. - To clear all groups, use an empty groups array. |
parameters.editedFieldsInput.multipleSelectClearableUserPickerFields? | object[] | Assign or unassign multiple users to/from a field: - To assign, provide an array of user accountIds. - To clear, set users to null. |
parameters.editedFieldsInput.multipleSelectFields? | object[] | Add or clear a multi-select field: - To add, provide an array of options with optionIds. - To clear, use an empty options array. |
parameters.editedFieldsInput.multipleVersionPickerFields? | object[] | Edit a multi-version picker field like Fix Versions/Affects Versions: - Options include ADD, REPLACE, REMOVE, or REMOVE_ALL for bulk edits. - To clear the field, use the REMOVE_ALL option with an empty versions array. |
parameters.editedFieldsInput.multiselectComponents? | { [key: string]: unknown; bulkEditMultiSelectFieldOption: string & object | "ADD" | "REMOVE" | "REPLACE" | "REMOVE_ALL"; components: object[]; fieldId: string; } | - |
parameters.editedFieldsInput.multiselectComponents.bulkEditMultiSelectFieldOption | string & object | "ADD" | "REMOVE" | "REPLACE" | "REMOVE_ALL" | - |
parameters.editedFieldsInput.multiselectComponents.components | object[] | - |
parameters.editedFieldsInput.multiselectComponents.fieldId | string | - |
parameters.editedFieldsInput.originalEstimateField? | { [key: string]: unknown; originalEstimateField: string; } | - |
parameters.editedFieldsInput.originalEstimateField.originalEstimateField | string | - |
parameters.editedFieldsInput.priority? | { [key: string]: unknown; priorityId: string; } | - |
parameters.editedFieldsInput.priority.priorityId | string | - |
parameters.editedFieldsInput.richTextFields? | object[] | Add or clear a rich text field: - To add, provide adfValue. Note that rich text fields only support ADF values. - To clear, use an empty richText object. For ADF format details, refer to: Atlassian Document Format. |
parameters.editedFieldsInput.singleGroupPickerFields? | object[] | Add or clear a single group picker field: - To add, specify the group with groupName. - To clear, set groupName to an empty string. |
parameters.editedFieldsInput.singleLineTextFields? | object[] | Add or clear a single line text field: - To add, provide the text value. - To clear, set text to an empty string. |
parameters.editedFieldsInput.singleSelectClearableUserPickerFields? | object[] | Edit assignment for single select user picker fields like Assignee/Reporter: - To assign an issue, specify the user's accountId. - To unassign an issue, set user to null. - For automatic assignment, set accountId to -1. |
parameters.editedFieldsInput.singleSelectFields? | object[] | Add or clear a single select field: - To add, specify the option with an optionId. - To clear, pass an option with optionId as -1. |
parameters.editedFieldsInput.singleVersionPickerFields? | object[] | Add or clear a single version picker field: - To add, specify the version with a versionId. - To clear, set versionId to -1. |
parameters.editedFieldsInput.status? | { [key: string]: unknown; statusId: string; } | - |
parameters.editedFieldsInput.status.statusId | string | - |
parameters.editedFieldsInput.timeTrackingField? | { [key: string]: unknown; timeRemaining: string; } | - |
parameters.editedFieldsInput.timeTrackingField.timeRemaining | string | - |
parameters.editedFieldsInput.urlFields? | object[] | Add or clear a URL field: - To add, provide the url with the desired URL value. - To clear, set url to an empty string. |
parameters.selectedActions | string[] | List of all the field IDs that are to be bulk edited. Each field ID in this list corresponds to a specific attribute of an issue that is set to be modified in the bulk edit operation. The relevant field ID can be obtained by calling the Bulk Edit Get Fields REST API (documentation available on this page itself). |
parameters.selectedIssueIdsOrKeys | string[] | List of issue IDs or keys which are to be bulk edited. These IDs or keys can be from different projects and issue types. |
parameters.sendBulkNotification? | boolean | null | A boolean value that indicates whether to send a bulk change notification when the issues are being edited. If true, dispatches a bulk notification email to users about the updates. |
Returns
Promise<{ [key: string]: unknown; taskId?: string; }>
issueBulkOperations.submitBulkMove
ts
submitBulkMove: (parameters) => Promise<{
[key: string]: unknown;
taskId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { sendBulkNotification?: boolean | null; targetToSourcesMapping?: Record<string, any>; } | - |
parameters.sendBulkNotification? | boolean | null | A boolean value that indicates whether to send a bulk change notification when the issues are being moved. If true, dispatches a bulk notification email to users about the updates. |
parameters.targetToSourcesMapping? | Record<string, any> | An object representing the mapping of issues and data related to destination entities, like fields and statuses, that are required during a bulk move. The key is a string that is created by concatenating the following three entities in order, separated by commas. The format is <project ID or key>,<issueType ID>,<parent ID or key>. It should be unique across mappings provided in the payload. If you provide multiple mappings for the same key, only one will be processed. However, the operation won't fail, so the error may be hard to track down. - Destination project (Required): ID or key of the project to which the issues are being moved. - Destination issueType (Required): ID of the issueType to which the issues are being moved. - Destination parent ID or key (Optional): ID or key of the issue which will become the parent of the issues being moved. Only required when the destination issueType is a subtask. |
Returns
Promise<{ [key: string]: unknown; taskId?: string; }>
issueBulkOperations.submitBulkTransition
ts
submitBulkTransition: (parameters) => Promise<{
[key: string]: unknown;
taskId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { bulkTransitionInputs: object[]; sendBulkNotification?: boolean | null; } | - |
parameters.bulkTransitionInputs | object[] | List of objects and each object has two properties: - Issues that will be bulk transitioned. - TransitionId that corresponds to a specific transition of issues that share the same workflow. |
parameters.sendBulkNotification? | boolean | null | A boolean value that indicates whether to send a bulk change notification when the issues are being transitioned. If true, dispatches a bulk notification email to users about the updates. |
Returns
Promise<{ [key: string]: unknown; taskId?: string; }>
issueBulkOperations.submitBulkUnwatch
ts
submitBulkUnwatch: (parameters) => Promise<{
[key: string]: unknown;
taskId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { selectedIssueIdsOrKeys: string[]; } | - |
parameters.selectedIssueIdsOrKeys | string[] | List of issue IDs or keys which are to be bulk watched or unwatched. These IDs or keys can be from different projects and issue types. |
Returns
Promise<{ [key: string]: unknown; taskId?: string; }>
issueBulkOperations.submitBulkWatch
ts
submitBulkWatch: (parameters) => Promise<{
[key: string]: unknown;
taskId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { selectedIssueIdsOrKeys: string[]; } | - |
parameters.selectedIssueIdsOrKeys | string[] | List of issue IDs or keys which are to be bulk watched or unwatched. These IDs or keys can be from different projects and issue types. |
Returns
Promise<{ [key: string]: unknown; taskId?: string; }>
issueCommentProperties
ts
issueCommentProperties: object;issueCommentProperties.deleteCommentProperty
ts
deleteCommentProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { commentId: string; propertyKey: string; } | - |
parameters.commentId | string | The ID of the comment. |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<void>
issueCommentProperties.getCommentProperty
ts
getCommentProperty: (parameters) => Promise<{
[key: string]: unknown;
key?: string;
value?: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { commentId: string; propertyKey: string; } | - |
parameters.commentId | string | The ID of the comment. |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>
issueCommentProperties.getCommentPropertyKeys
ts
getCommentPropertyKeys: (parameters) => Promise<{
[key: string]: unknown;
keys?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { commentId: string; } | - |
parameters.commentId | string | The ID of the comment. |
Returns
Promise<{ [key: string]: unknown; keys?: object[]; }>
issueCommentProperties.setCommentProperty
ts
setCommentProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; commentId: string; propertyKey: string; } | - |
parameters.body | Record<string, any> | - |
parameters.commentId | string | The ID of the comment. |
parameters.propertyKey | string | The key of the property. The maximum length is 255 characters. |
Returns
Promise<void>
issueComments
ts
issueComments: object;issueComments.addComment
ts
addComment: (parameters) => Promise<{
[key: string]: unknown;
author?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
body?: {
[key: string]: unknown;
content: Record<string, any>[];
type: string & object | "doc";
version: number;
};
created?: Date;
id?: string;
jsdAuthorCanSeeRequest?: boolean;
jsdPublic?: boolean;
properties?: object[];
renderedBody?: string;
self?: string;
updateAuthor?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
updated?: Date;
visibility?: {
[key: string]: unknown;
identifier?: string | null;
type?: "role" | "group" | string & object;
value?: string;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; expand?: | string | string[] | string & object | (string & object | "renderedBody")[]; id?: string; issueIdOrKey: string; jsdAuthorCanSeeRequest?: boolean; jsdPublic?: boolean; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; } | - |
parameters.author? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.author.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.author.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.author.active? | boolean | Whether the user is active. |
parameters.author.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.author.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.author.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.author.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.author.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.author.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.author.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.author.self? | string | The URL of the user. |
parameters.author.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.body? | | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; } | A document in Atlassian Document Format, or a string of wiki markup — a string is sent to the v2 endpoint that parses it, and the result is read back as a document. |
parameters.created? | unknown | The date and time at which the comment was created. |
parameters.expand? | | string | string[] | string & object | (string & object | "renderedBody")[] | Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML. |
parameters.id? | string | The ID of the comment. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.jsdAuthorCanSeeRequest? | boolean | Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature. |
parameters.jsdPublic? | boolean | Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation. |
parameters.properties? | object[] | A list of comment properties. Optional on create and update. |
parameters.renderedBody? | string | The rendered version of the comment. |
parameters.self? | string | The URL of the comment. |
parameters.updateAuthor? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.updateAuthor.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.updateAuthor.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.updateAuthor.active? | boolean | Whether the user is active. |
parameters.updateAuthor.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.updateAuthor.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.updateAuthor.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.updateAuthor.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.updateAuthor.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.updateAuthor.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.updateAuthor.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.updateAuthor.self? | string | The URL of the user. |
parameters.updateAuthor.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.updated? | unknown | The date and time at which the comment was updated last. |
parameters.visibility? | { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; } | - |
parameters.visibility.identifier? | string | null | The ID of the group or the name of the role that visibility of this item is restricted to. |
parameters.visibility.type? | "role" | "group" | string & object | Whether visibility of this item is restricted to a group or role. |
parameters.visibility.value? | string | The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier. |
Returns
Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: Date; id?: string; jsdAuthorCanSeeRequest?: boolean; jsdPublic?: boolean; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: Date; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }>
issueComments.deleteComment
ts
deleteComment: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; issueIdOrKey: string; } | - |
parameters.id | string | The ID of the comment. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<void>
issueComments.getComment
ts
getComment: (parameters) => Promise<{
[key: string]: unknown;
author?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
body?: {
[key: string]: unknown;
content: Record<string, any>[];
type: string & object | "doc";
version: number;
};
created?: Date;
id?: string;
jsdAuthorCanSeeRequest?: boolean;
jsdPublic?: boolean;
properties?: object[];
renderedBody?: string;
self?: string;
updateAuthor?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
updated?: Date;
visibility?: {
[key: string]: unknown;
identifier?: string | null;
type?: "role" | "group" | string & object;
value?: string;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | (string & object | "renderedBody")[]; id: string; issueIdOrKey: string; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "renderedBody")[] | Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML. |
parameters.id | string | The ID of the comment. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: Date; id?: string; jsdAuthorCanSeeRequest?: boolean; jsdPublic?: boolean; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: Date; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }>
issueComments.getComments
ts
getComments: (parameters) => Promise<{
[key: string]: unknown;
comments?: object[];
maxResults?: number;
startAt?: number;
total?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | (string & object | "renderedBody")[]; issueIdOrKey: string; maxResults?: number; orderBy?: string & object | "created" | "-created" | "+created"; startAt?: number; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "renderedBody")[] | Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | string & object | "created" | "-created" | "+created" | Order the results by a field. Accepts created to sort comments by their created date. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; comments?: object[]; maxResults?: number; startAt?: number; total?: number; }>
issueComments.getCommentsByIds
ts
getCommentsByIds: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ("properties" | string & object | "renderedBody")[]; ids: number[]; } | - |
parameters.expand? | | string | string[] | string & object | ("properties" | string & object | "renderedBody")[] | Use expand to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include: - renderedBody Returns the comment body rendered in HTML. - properties Returns the comment's properties. |
parameters.ids | number[] | The list of comment IDs. A maximum of 1000 IDs can be specified. |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueComments.updateComment
ts
updateComment: (parameters) => Promise<{
[key: string]: unknown;
author?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
body?: {
[key: string]: unknown;
content: Record<string, any>[];
type: string & object | "doc";
version: number;
};
created?: Date;
id?: string;
jsdAuthorCanSeeRequest?: boolean;
jsdPublic?: boolean;
properties?: object[];
renderedBody?: string;
self?: string;
updateAuthor?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
updated?: Date;
visibility?: {
[key: string]: unknown;
identifier?: string | null;
type?: "role" | "group" | string & object;
value?: string;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; id?: string; jsdAuthorCanSeeRequest?: boolean; jsdPublic?: boolean; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }; expand?: | string | string[] | string & object | (string & object | "renderedBody")[]; id: string; issueIdOrKey: string; notifyUsers?: boolean; overrideEditableFlag?: boolean; } | - |
parameters.body | { [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; id?: string; jsdAuthorCanSeeRequest?: boolean; jsdPublic?: boolean; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; } | - |
parameters.body.author? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.body.author.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.body.author.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.body.author.active? | boolean | Whether the user is active. |
parameters.body.author.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.author.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.author.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.author.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.author.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.author.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.body.author.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.body.author.self? | string | The URL of the user. |
parameters.body.author.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.body.body? | | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; } | A document in Atlassian Document Format, or a string of wiki markup — a string is sent to the v2 endpoint that parses it, and the result is read back as a document. |
parameters.body.created? | unknown | The date and time at which the comment was created. |
parameters.body.id? | string | The ID of the comment. |
parameters.body.jsdAuthorCanSeeRequest? | boolean | Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature. |
parameters.body.jsdPublic? | boolean | Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation. |
parameters.body.properties? | object[] | A list of comment properties. Optional on create and update. |
parameters.body.renderedBody? | string | The rendered version of the comment. |
parameters.body.self? | string | The URL of the comment. |
parameters.body.updateAuthor? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.body.updateAuthor.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.body.updateAuthor.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.body.updateAuthor.active? | boolean | Whether the user is active. |
parameters.body.updateAuthor.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.updateAuthor.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.updateAuthor.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.updateAuthor.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.updateAuthor.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.updateAuthor.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.body.updateAuthor.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.body.updateAuthor.self? | string | The URL of the user. |
parameters.body.updateAuthor.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.body.updated? | unknown | The date and time at which the comment was updated last. |
parameters.body.visibility? | { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; } | - |
parameters.body.visibility.identifier? | string | null | The ID of the group or the name of the role that visibility of this item is restricted to. |
parameters.body.visibility.type? | "role" | "group" | string & object | Whether visibility of this item is restricted to a group or role. |
parameters.body.visibility.value? | string | The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier. |
parameters.expand? | | string | string[] | string & object | (string & object | "renderedBody")[] | Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML. |
parameters.id | string | The ID of the comment. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.notifyUsers? | boolean | Whether users are notified when a comment is updated. |
parameters.overrideEditableFlag? | boolean | Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission. |
Returns
Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: Date; id?: string; jsdAuthorCanSeeRequest?: boolean; jsdPublic?: boolean; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: Date; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }>
issueCustomFieldAssociations
ts
issueCustomFieldAssociations: object;issueCustomFieldAssociations.createAssociations
ts
createAssociations: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { associationContexts: object[]; fields: object[]; } | - |
parameters.associationContexts | object[] | Contexts to associate/unassociate the fields with. |
parameters.fields | object[] | Fields to associate/unassociate with projects. |
Returns
Promise<void>
issueCustomFieldAssociations.removeAssociations
ts
removeAssociations: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { associationContexts: object[]; fields: object[]; } | - |
parameters.associationContexts | object[] | Contexts to associate/unassociate the fields with. |
parameters.fields | object[] | Fields to associate/unassociate with projects. |
Returns
Promise<void>
issueCustomFieldConfigurationApps
ts
issueCustomFieldConfigurationApps: object;issueCustomFieldConfigurationApps.getCustomFieldConfiguration
ts
getCustomFieldConfiguration: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldContextId?: number[]; fieldIdOrKey: string; id?: number[]; issueId?: number; issueTypeId?: string; maxResults?: number; projectKeyOrId?: string; startAt?: number; } | - |
parameters.fieldContextId? | number[] | The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId. |
parameters.fieldIdOrKey | string | The ID or key of the custom field, for example customfield_10000. |
parameters.id? | number[] | The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId. |
parameters.issueId? | number | The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId. |
parameters.issueTypeId? | string | The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectKeyOrId? | string | The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldConfigurationApps.updateCustomFieldConfiguration
ts
updateCustomFieldConfiguration: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { configurations: object[]; fieldIdOrKey: string; } | - |
parameters.configurations | object[] | The list of custom field configuration details. |
parameters.fieldIdOrKey | string | The ID or key of the custom field, for example customfield_10000. |
Returns
Promise<void>
issueCustomFieldContexts
ts
issueCustomFieldContexts: object;issueCustomFieldContexts.addIssueTypesToContext
ts
addIssueTypesToContext: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; issueTypeIds: string[]; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId | string | The ID of the custom field. |
parameters.issueTypeIds | string[] | The list of issue type IDs. |
Returns
Promise<void>
issueCustomFieldContexts.assignProjectsToCustomFieldContext
ts
assignProjectsToCustomFieldContext: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; projectIds: string[]; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId | string | The ID of the custom field. |
parameters.projectIds | string[] | The IDs of projects. |
Returns
Promise<void>
issueCustomFieldContexts.createCustomFieldContext
ts
createCustomFieldContext: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
id?: string;
issueTypeIds?: string[];
name: string;
projectIds?: string[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; fieldId: string; id?: string; issueTypeIds?: string[]; name: string; projectIds?: string[]; } | - |
parameters.description? | string | The description of the context. |
parameters.fieldId | string | The ID of the custom field. |
parameters.id? | string | The ID of the context. |
parameters.issueTypeIds? | string[] | The list of issue types IDs for the context. If the list is empty, the context refers to all issue types. |
parameters.name | string | The name of the context. |
parameters.projectIds? | string[] | The list of project IDs associated with the context. If the list is empty, the context is global. |
Returns
Promise<{ [key: string]: unknown; description?: string; id?: string; issueTypeIds?: string[]; name: string; projectIds?: string[]; }>
issueCustomFieldContexts.deleteCustomFieldContext
ts
deleteCustomFieldContext: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId | string | The ID of the custom field. |
Returns
Promise<void>
issueCustomFieldContexts.getContextDefaultValues
ts
getContextDefaultValues: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId?: number[]; fieldId: string; issueTypeId?: string[]; maxResults?: number; startAt?: number; } | - |
parameters.contextId? | number[] | The IDs of the contexts to return default values for. If omitted, default values for every context the custom field has are returned. |
parameters.fieldId | string | The ID of the custom field, for example customfield\_10000. |
parameters.issueTypeId? | string[] | The IDs of the issue types to restrict the returned per-issue-type default values to. If omitted, default values for every issue type are returned. This filter never removes the catch-all isAnyIssueType entry of a context. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldContexts.getContextsForField
ts
getContextsForField: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId?: number[]; fieldId: string; isAnyIssueType?: boolean; isGlobalContext?: boolean; maxResults?: number; startAt?: number; } | - |
parameters.contextId? | number[] | The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&contextId=10001. |
parameters.fieldId | string | The ID of the custom field. |
parameters.isAnyIssueType? | boolean | Whether to return contexts that apply to all issue types. |
parameters.isGlobalContext? | boolean | Whether to return contexts that apply to all projects. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldContexts.getCustomFieldContextsForProjectsAndIssueTypes
ts
getCustomFieldContextsForProjectsAndIssueTypes: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldId: string; mappings: object[]; maxResults?: number; startAt?: number; } | - |
parameters.fieldId | string | The ID of the custom field. |
parameters.mappings | object[] | The project and issue type mappings. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldContexts.getIssueTypeMappingsForContexts
ts
getIssueTypeMappingsForContexts: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId?: number[]; fieldId: string; maxResults?: number; startAt?: number; } | - |
parameters.contextId? | number[] | The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, contextId=10001&contextId=10002. |
parameters.fieldId | string | The ID of the custom field. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldContexts.getProjectContextMapping
ts
getProjectContextMapping: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId?: number[]; fieldId: string; maxResults?: number; startAt?: number; } | - |
parameters.contextId? | number[] | The list of context IDs. To include multiple context, separate IDs with ampersand: contextId=10000&contextId=10001. |
parameters.fieldId | string | The ID of the custom field, for example customfield\_10000. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldContexts.removeCustomFieldContextFromProjects
ts
removeCustomFieldContextFromProjects: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; projectIds: string[]; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId | string | The ID of the custom field. |
parameters.projectIds | string[] | The IDs of projects. |
Returns
Promise<void>
issueCustomFieldContexts.removeIssueTypesFromContext
ts
removeIssueTypesFromContext: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; issueTypeIds: string[]; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId | string | The ID of the custom field. |
parameters.issueTypeIds | string[] | The list of issue type IDs. |
Returns
Promise<void>
issueCustomFieldContexts.updateCustomFieldContext
ts
updateCustomFieldContext: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; description?: string; fieldId: string; name?: string; } | - |
parameters.contextId | number | The ID of the context. |
parameters.description? | string | The description of the custom field context. The maximum length is 255 characters. |
parameters.fieldId | string | The ID of the custom field. |
parameters.name? | string | The name of the custom field context. The name must be unique. The maximum length is 255 characters. |
Returns
Promise<void>
issueCustomFieldOptions
ts
issueCustomFieldOptions: object;issueCustomFieldOptions.createCustomFieldOption
ts
createCustomFieldOption: (parameters) => Promise<{
[key: string]: unknown;
options?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; options?: object[]; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId | string | The ID of the custom field. |
parameters.options? | object[] | Details of options to create. |
Returns
Promise<{ [key: string]: unknown; options?: object[]; }>
issueCustomFieldOptions.deleteCustomFieldOption
ts
deleteCustomFieldOption: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; optionId: number; } | - |
parameters.contextId | number | The ID of the context from which an option should be deleted. |
parameters.fieldId | string | The ID of the custom field. |
parameters.optionId | number | The ID of the option to delete. |
Returns
Promise<void>
issueCustomFieldOptions.getCustomFieldOption
ts
getCustomFieldOption: (parameters) => Promise<{
[key: string]: unknown;
self?: string;
value?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the custom field option. |
Returns
Promise<{ [key: string]: unknown; self?: string; value?: string; }>
issueCustomFieldOptions.getOptionsForContext
ts
getOptionsForContext: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; maxResults?: number; onlyOptions?: boolean; optionId?: number; startAt?: number; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId | string | The ID of the custom field. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.onlyOptions? | boolean | Whether only options are returned. |
parameters.optionId? | number | The ID of the option. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldOptions.reorderCustomFieldOptions
ts
reorderCustomFieldOptions: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { after?: string; contextId: number; customFieldOptionIds: string[]; fieldId: string; position?: string & object | "First" | "Last"; } | - |
parameters.after? | string | The ID of the custom field option or cascading option to place the moved options after. Required if position isn't provided. |
parameters.contextId | number | The ID of the context. |
parameters.customFieldOptionIds | string[] | A list of IDs of custom field options to move. The order of the custom field option IDs in the list is the order they are given after the move. The list must contain custom field options or cascading options, but not both. |
parameters.fieldId | string | The ID of the custom field. |
parameters.position? | string & object | "First" | "Last" | The position the custom field options should be moved to. Required if after isn't provided. |
Returns
Promise<void>
issueCustomFieldOptions.replaceCustomFieldOption
ts
replaceCustomFieldOption: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
elapsedRuntime: number;
finished?: number;
id: string;
lastUpdate: number;
message?: string;
progress: number;
result?: {
[key: string]: unknown;
errors?: {
[key: string]: unknown;
errorMessages?: ...[];
errors?: Record<..., ...>;
httpStatusCode?: number;
};
modifiedIssues?: number[];
unmodifiedIssues?: number[];
};
self: string;
started?: number;
status: | string & object
| "ENQUEUED"
| "RUNNING"
| "COMPLETE"
| "FAILED"
| "CANCEL_REQUESTED"
| "CANCELLED"
| "DEAD";
submitted: number;
submittedBy: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; jql?: string; optionId: number; replaceWith?: number; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId | string | The ID of the custom field. |
parameters.jql? | string | A JQL query that specifies the issues to be updated. For example, project=10000. |
parameters.optionId | number | The ID of the option to be deselected. |
parameters.replaceWith? | number | The ID of the option that will replace the currently selected option. |
Returns
Promise<{ [key: string]: unknown; description?: string; elapsedRuntime: number; finished?: number; id: string; lastUpdate: number; message?: string; progress: number; result?: { [key: string]: unknown; errors?: { [key: string]: unknown; errorMessages?: ...[]; errors?: Record<..., ...>; httpStatusCode?: number; }; modifiedIssues?: number[]; unmodifiedIssues?: number[]; }; self: string; started?: number; status: | string & object | "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD"; submitted: number; submittedBy: number; }>
issueCustomFieldOptions.updateCustomFieldOption
ts
updateCustomFieldOption: (parameters) => Promise<{
[key: string]: unknown;
options?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contextId: number; fieldId: string; options?: object[]; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId | string | The ID of the custom field. |
parameters.options? | object[] | Details of the options to update. |
Returns
Promise<{ [key: string]: unknown; options?: object[]; }>
issueCustomFieldOptionsApps
ts
issueCustomFieldOptionsApps: object;issueCustomFieldOptionsApps.createIssueFieldOption
ts
createIssueFieldOption: (parameters) => Promise<{
[key: string]: unknown;
config?: {
[key: string]: unknown;
attributes?: (... & ... | "defaultValue" | "notSelectable")[];
scope?: {
[key: string]: unknown;
global?: {
[key: ...]: ...;
attributes?: ...;
};
projects?: ...[];
projects2?: ...[];
};
};
id: number;
properties?: Record<string, any>;
value: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { config?: { [key: string]: unknown; attributes?: (string & object | "defaultValue" | "notSelectable")[]; scope?: { [key: string]: unknown; global?: { [key: string]: unknown; attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }; }; fieldKey: string; properties?: Record<string, any>; value: string; } | - |
parameters.config? | { [key: string]: unknown; attributes?: (string & object | "defaultValue" | "notSelectable")[]; scope?: { [key: string]: unknown; global?: { [key: string]: unknown; attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }; } | - |
parameters.config.attributes? | (string & object | "defaultValue" | "notSelectable")[] | DEPRECATED |
parameters.config.scope? | { [key: string]: unknown; global?: { [key: string]: unknown; attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; } | - |
parameters.config.scope.global? | { [key: string]: unknown; attributes?: ... | ...; } | - |
parameters.config.scope.global.attributes? | ... | ... | Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default. |
parameters.config.scope.projects? | number[] | DEPRECATED |
parameters.config.scope.projects2? | object[] | Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context. |
parameters.fieldKey | string | The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following: - Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. - Run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" |
parameters.properties? | Record<string, any> | The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module. |
parameters.value | string | The option's name, which is displayed in Jira. |
Returns
Promise<{ [key: string]: unknown; config?: { [key: string]: unknown; attributes?: (... & ... | "defaultValue" | "notSelectable")[]; scope?: { [key: string]: unknown; global?: { [key: ...]: ...; attributes?: ...; }; projects?: ...[]; projects2?: ...[]; }; }; id: number; properties?: Record<string, any>; value: string; }>
issueCustomFieldOptionsApps.deleteIssueFieldOption
ts
deleteIssueFieldOption: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldKey: string; optionId: number; } | - |
parameters.fieldKey | string | The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following: - Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. - Run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" |
parameters.optionId | number | The ID of the option to be deleted. |
Returns
Promise<void>
issueCustomFieldOptionsApps.getAllIssueFieldOptions
ts
getAllIssueFieldOptions: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldKey: string; maxResults?: number; startAt?: number; } | - |
parameters.fieldKey | string | The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following: - Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. - Run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldOptionsApps.getIssueFieldOption
ts
getIssueFieldOption: (parameters) => Promise<{
[key: string]: unknown;
config?: {
[key: string]: unknown;
attributes?: (... & ... | "defaultValue" | "notSelectable")[];
scope?: {
[key: string]: unknown;
global?: {
[key: ...]: ...;
attributes?: ...;
};
projects?: ...[];
projects2?: ...[];
};
};
id: number;
properties?: Record<string, any>;
value: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldKey: string; optionId: number; } | - |
parameters.fieldKey | string | The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following: - Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. - Run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" |
parameters.optionId | number | The ID of the option to be returned. |
Returns
Promise<{ [key: string]: unknown; config?: { [key: string]: unknown; attributes?: (... & ... | "defaultValue" | "notSelectable")[]; scope?: { [key: string]: unknown; global?: { [key: ...]: ...; attributes?: ...; }; projects?: ...[]; projects2?: ...[]; }; }; id: number; properties?: Record<string, any>; value: string; }>
issueCustomFieldOptionsApps.getSelectableIssueFieldOptions
ts
getSelectableIssueFieldOptions: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldKey: string; maxResults?: number; projectId?: number; startAt?: number; } | - |
parameters.fieldKey | string | The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following: - Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. - Run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectId? | number | Filters the results to options that are only available in the specified project. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldOptionsApps.getVisibleIssueFieldOptions
ts
getVisibleIssueFieldOptions: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldKey: string; maxResults?: number; projectId?: number; startAt?: number; } | - |
parameters.fieldKey | string | The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following: - Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. - Run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectId? | number | Filters the results to options that are only available in the specified project. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueCustomFieldOptionsApps.replaceIssueFieldOption
ts
replaceIssueFieldOption: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
elapsedRuntime: number;
finished?: number;
id: string;
lastUpdate: number;
message?: string;
progress: number;
result?: {
[key: string]: unknown;
errors?: {
[key: string]: unknown;
errorMessages?: ...[];
errors?: Record<..., ...>;
httpStatusCode?: number;
};
modifiedIssues?: number[];
unmodifiedIssues?: number[];
};
self: string;
started?: number;
status: | string & object
| "ENQUEUED"
| "RUNNING"
| "COMPLETE"
| "FAILED"
| "CANCEL_REQUESTED"
| "CANCELLED"
| "DEAD";
submitted: number;
submittedBy: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldKey: string; jql?: string; optionId: number; overrideEditableFlag?: boolean; overrideScreenSecurity?: boolean; replaceWith?: number; } | - |
parameters.fieldKey | string | The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following: - Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. - Run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" |
parameters.jql? | string | A JQL query that specifies the issues to be updated. For example, project=10000. |
parameters.optionId | number | The ID of the option to be deselected. |
parameters.overrideEditableFlag? | boolean | Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with Administer Jira global permission. |
parameters.overrideScreenSecurity? | boolean | Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission. |
parameters.replaceWith? | number | The ID of the option that will replace the currently selected option. |
Returns
Promise<{ [key: string]: unknown; description?: string; elapsedRuntime: number; finished?: number; id: string; lastUpdate: number; message?: string; progress: number; result?: { [key: string]: unknown; errors?: { [key: string]: unknown; errorMessages?: ...[]; errors?: Record<..., ...>; httpStatusCode?: number; }; modifiedIssues?: number[]; unmodifiedIssues?: number[]; }; self: string; started?: number; status: | string & object | "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD"; submitted: number; submittedBy: number; }>
issueCustomFieldOptionsApps.updateIssueFieldOption
ts
updateIssueFieldOption: (parameters) => Promise<{
[key: string]: unknown;
config?: {
[key: string]: unknown;
attributes?: (... & ... | "defaultValue" | "notSelectable")[];
scope?: {
[key: string]: unknown;
global?: {
[key: ...]: ...;
attributes?: ...;
};
projects?: ...[];
projects2?: ...[];
};
};
id: number;
properties?: Record<string, any>;
value: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { config?: { [key: string]: unknown; attributes?: (string & object | "defaultValue" | "notSelectable")[]; scope?: { [key: string]: unknown; global?: { [key: string]: unknown; attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }; }; fieldKey: string; id: number; optionId: number; properties?: Record<string, any>; value: string; } | - |
parameters.config? | { [key: string]: unknown; attributes?: (string & object | "defaultValue" | "notSelectable")[]; scope?: { [key: string]: unknown; global?: { [key: string]: unknown; attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }; } | - |
parameters.config.attributes? | (string & object | "defaultValue" | "notSelectable")[] | DEPRECATED |
parameters.config.scope? | { [key: string]: unknown; global?: { [key: string]: unknown; attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; } | - |
parameters.config.scope.global? | { [key: string]: unknown; attributes?: ... | ...; } | - |
parameters.config.scope.global.attributes? | ... | ... | Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default. |
parameters.config.scope.projects? | number[] | DEPRECATED |
parameters.config.scope.projects2? | object[] | Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context. |
parameters.fieldKey | string | The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following: - Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. - Run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" |
parameters.id | number | The unique identifier for the option. This is only unique within the select field's set of options. |
parameters.optionId | number | The ID of the option to be updated. |
parameters.properties? | Record<string, any> | The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see Issue Field Option Property Index) are defined in the descriptor for the issue field module. |
parameters.value | string | The option's name, which is displayed in Jira. |
Returns
Promise<{ [key: string]: unknown; config?: { [key: string]: unknown; attributes?: (... & ... | "defaultValue" | "notSelectable")[]; scope?: { [key: string]: unknown; global?: { [key: ...]: ...; attributes?: ...; }; projects?: ...[]; projects2?: ...[]; }; }; id: number; properties?: Record<string, any>; value: string; }>
issueCustomFieldValuesApps
ts
issueCustomFieldValuesApps: object;issueCustomFieldValuesApps.updateCustomFieldValue
ts
updateCustomFieldValue: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldIdOrKey: string; generateAppEvents?: boolean; generateChangelog?: boolean; updates?: object[]; } | - |
parameters.fieldIdOrKey | string | The ID or key of the custom field. For example, customfield_10010. |
parameters.generateAppEvents? | boolean | Whether to generate app events for this update. Suppresses Forge, Connect, OAuth 2.0, and admin-configured webhooks (registered via the Jira admin UI). Note: Suppressing events means that "issue updated" events will not be emitted for your app or any other apps installed in Jira. This may cause other apps to retain stale data for the updated field, resulting in potentially confusing behaviour. We do not recommend using this flag in a Marketplace app as it may result in incompatibilities with other apps that depend on up-to-date issue data. |
parameters.generateChangelog? | boolean | Whether to generate a changelog for this update. |
parameters.updates? | object[] | The list of custom field update details. |
Returns
Promise<void>
issueCustomFieldValuesApps.updateMultipleCustomFieldValues
ts
updateMultipleCustomFieldValues: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { generateAppEvents?: boolean; generateChangelog?: boolean; updates?: object[]; } | - |
parameters.generateAppEvents? | boolean | Whether to generate app events for this update. Suppresses Forge, Connect, OAuth 2.0, and admin-configured webhooks (registered via the Jira admin UI). Note: Suppressing events means that "issue updated" events will not be emitted for your app or any other apps installed in Jira. This may cause other apps to retain stale data for the updated field, resulting in potentially confusing behaviour. We do not recommend using this flag in a Marketplace app as it may result in incompatibilities with other apps that depend on up-to-date issue data. |
parameters.generateChangelog? | boolean | Whether to generate a changelog for this update. |
parameters.updates? | object[] | - |
Returns
Promise<void>
issueFields
ts
issueFields: object;issueFields.createCustomField
ts
createCustomField: (parameters) => Promise<{
[key: string]: unknown;
clauseNames?: string[];
custom?: boolean;
id?: string;
key?: string;
name?: string;
navigable?: boolean;
orderable?: boolean;
schema?: {
[key: string]: unknown;
configuration?: Record<string, any>;
custom?: string;
customId?: number;
items?: string;
system?: string;
type: string;
};
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
searchable?: boolean;
untranslatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; name: string; searcherKey?: | string & object | "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:daterange" | "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange" | "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber" | "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:numberrange" | "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"; type: string; } | - |
parameters.description? | string | The description of the custom field, which is displayed in Jira. |
parameters.name | string | The name of the custom field, which is displayed in Jira. This is not the unique identifier. |
parameters.searcherKey? | | string & object | "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:daterange" | "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange" | "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber" | "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:numberrange" | "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher" | The searcher defines the way the field is searched in Jira. For example, com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher. The search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown): - cascadingselect: cascadingselectsearcher - datepicker: daterange - datetime: datetimerange - float: exactnumber or numberrange - grouppicker: grouppickersearcher - importid: exactnumber or numberrange - labels: labelsearcher - multicheckboxes: multiselectsearcher - multigrouppicker: multiselectsearcher - multiselect: multiselectsearcher - multiuserpicker: userpickergroupsearcher - multiversion: versionsearcher - project: projectsearcher - radiobuttons: multiselectsearcher - readonlyfield: textsearcher - select: multiselectsearcher - textarea: textsearcher - textfield: textsearcher - url: exacttextsearcher - userpicker: userpickergroupsearcher - version: versionsearcher If no searcher is provided, the field isn't searchable. However, Forge custom fields have a searcher set automatically, so are always searchable. |
parameters.type | string | The type of the custom field. These built-in custom field types are available: - cascadingselect: Enables values to be selected from two levels of select lists (value: com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect) - datepicker: Stores a date using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:datepicker) - datetime: Stores a date with a time component (value: com.atlassian.jira.plugin.system.customfieldtypes:datetime) - float: Stores and validates a numeric (floating point) input (value: com.atlassian.jira.plugin.system.customfieldtypes:float) - grouppicker: Stores a user group using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:grouppicker) - importid: A read-only field that stores the ID the issue had in the system it was imported from (value: com.atlassian.jira.plugin.system.customfieldtypes:importid) - labels: Stores labels (value: com.atlassian.jira.plugin.system.customfieldtypes:labels) - multicheckboxes: Stores multiple values using checkboxes (value: ) - `multigrouppicker`: Stores multiple user groups using a picker control (value: ) - multiselect: Stores multiple values using a select list (value: com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes) - multiuserpicker: Stores multiple users using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker) - multiversion: Stores multiple versions from the versions available in a project using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:multiversion) - project: Stores a project from a list of projects that the user is permitted to view (value: com.atlassian.jira.plugin.system.customfieldtypes:project) - radiobuttons: Stores a value using radio buttons (value: com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons) - readonlyfield: Stores a read-only text value, which can only be populated via the API (value: com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield) - select: Stores a value from a configurable list of options (value: com.atlassian.jira.plugin.system.customfieldtypes:select) - textarea: Stores a long text string using a multiline text area (value: com.atlassian.jira.plugin.system.customfieldtypes:textarea) - textfield: Stores a text string using a single-line text box (value: com.atlassian.jira.plugin.system.customfieldtypes:textfield) - url: Stores a URL (value: com.atlassian.jira.plugin.system.customfieldtypes:url) - userpicker: Stores a user using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:userpicker) - version: Stores a version using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:version) To create a field based on a Forge custom field type, use the ID of the Forge custom field type as the value. For example, ari:cloud:ecosystem::extension/e62f20a2-4b61-4dbe-bfb9-9a88b5e3ac84/548c5df1-24aa-4f7c-bbbb-3038d947cb05/static/my-cf-type-key. |
Returns
Promise<{ [key: string]: unknown; clauseNames?: string[]; custom?: boolean; id?: string; key?: string; name?: string; navigable?: boolean; orderable?: boolean; schema?: { [key: string]: unknown; configuration?: Record<string, any>; custom?: string; customId?: number; items?: string; system?: string; type: string; }; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; searchable?: boolean; untranslatedName?: string; }>
issueFields.deleteCustomField
ts
deleteCustomField: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
elapsedRuntime: number;
finished?: number;
id: string;
lastUpdate: number;
message?: string;
progress: number;
result?: unknown;
self: string;
started?: number;
status: | string & object
| "ENQUEUED"
| "RUNNING"
| "COMPLETE"
| "FAILED"
| "CANCEL_REQUESTED"
| "CANCELLED"
| "DEAD";
submitted: number;
submittedBy: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of a custom field. |
Returns
Promise<{ [key: string]: unknown; description?: string; elapsedRuntime: number; finished?: number; id: string; lastUpdate: number; message?: string; progress: number; result?: unknown; self: string; started?: number; status: | string & object | "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD"; submitted: number; submittedBy: number; }>
issueFields.getFields
ts
getFields: () => Promise<object[]>;Returns
Promise<object[]>
issueFields.getFieldsPaginated
ts
getFieldsPaginated: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | ( | "key" | string & object | "searcherKey" | "contextsCount" | "isLocked" | "lastUsed" | "screensCount" | "stableId")[]; id?: string[]; maxResults?: number; orderBy?: | "name" | string & object | "contextsCount" | "lastUsed" | "projectsCount" | "screensCount" | "-name" | "+name" | "-contextsCount" | "+contextsCount" | "-lastUsed" | "+lastUsed" | "-screensCount" | "+screensCount" | "-projectsCount" | "+projectsCount"; projectIds?: number[]; query?: string; startAt?: number; type?: ("custom" | string & object | "system")[]; } | - |
parameters.expand? | | string | string[] | string & object | ( | "key" | string & object | "searcherKey" | "contextsCount" | "isLocked" | "lastUsed" | "screensCount" | "stableId")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - key returns the key for each field - stableId returns the stableId for each field - lastUsed returns the date when the value of the field last changed - screensCount returns the number of screens related to a field - contextsCount returns the number of contexts related to a field - isLocked returns information about whether the field is locked - searcherKey returns the searcher key for each custom field |
parameters.id? | string[] | The IDs of the custom fields to return or, where query is specified, filter. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | | "name" | string & object | "contextsCount" | "lastUsed" | "projectsCount" | "screensCount" | "-name" | "+name" | "-contextsCount" | "+contextsCount" | "-lastUsed" | "+lastUsed" | "-screensCount" | "+screensCount" | "-projectsCount" | "+projectsCount" | Order the results by: - contextsCount sorts by the number of contexts related to a field - lastUsed sorts by the date when the value of the field last changed - name sorts by the field name - screensCount sorts by the number of screens related to a field |
parameters.projectIds? | number[] | The IDs of the projects to filter the fields by. Fields belonging to project Ids that the user does not have access to will not be returned |
parameters.query? | string | String used to perform a case-insensitive partial match with field names or descriptions. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
parameters.type? | ("custom" | string & object | "system")[] | The type of fields to search. |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueFields.getTrashedFieldsPaginated
ts
getTrashedFieldsPaginated: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | "name" | string & object | "projectsCount" | "-name" | "+name" | "-projectsCount" | "+projectsCount" | "trashDate" | "-trashDate" | "+trashDate" | "plannedDeletionDate" | "-plannedDeletionDate" | "+plannedDeletionDate"; id?: string[]; maxResults?: number; orderBy?: string; query?: string; startAt?: number; } | - |
parameters.expand? | | "name" | string & object | "projectsCount" | "-name" | "+name" | "-projectsCount" | "+projectsCount" | "trashDate" | "-trashDate" | "+trashDate" | "plannedDeletionDate" | "-plannedDeletionDate" | "+plannedDeletionDate" | - |
parameters.id? | string[] | - |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | string | Order the results by a field: - name sorts by the field name - trashDate sorts by the date the field was moved to the trash - plannedDeletionDate sorts by the planned deletion date |
parameters.query? | string | String used to perform a case-insensitive partial match with field names or descriptions. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueFields.restoreCustomField
ts
restoreCustomField: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of a custom field. |
Returns
Promise<void>
issueFields.trashCustomField
ts
trashCustomField: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of a custom field. |
Returns
Promise<void>
issueFields.updateCustomField
ts
updateCustomField: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; fieldId: string; name?: string; searcherKey?: | string & object | "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:daterange" | "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange" | "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber" | "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:numberrange" | "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"; } | - |
parameters.description? | string | The description of the custom field. The maximum length is 40000 characters. |
parameters.fieldId | string | The ID of the custom field. |
parameters.name? | string | The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters. |
parameters.searcherKey? | | string & object | "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:daterange" | "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange" | "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber" | "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:numberrange" | "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher" | The searcher that defines the way the field is searched in Jira. It can be set to null, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown): - cascadingselect: cascadingselectsearcher - datepicker: daterange - datetime: datetimerange - float: exactnumber or numberrange - grouppicker: grouppickersearcher - importid: exactnumber or numberrange - labels: labelsearcher - multicheckboxes: multiselectsearcher - multigrouppicker: multiselectsearcher - multiselect: multiselectsearcher - multiuserpicker: userpickergroupsearcher - multiversion: versionsearcher - project: projectsearcher - radiobuttons: multiselectsearcher - readonlyfield: textsearcher - select: multiselectsearcher - textarea: textsearcher - textfield: textsearcher - url: exacttextsearcher - userpicker: userpickergroupsearcher - version: versionsearcher |
Returns
Promise<void>
issueLinks
ts
issueLinks: object;issueLinks.deleteIssueLink
ts
deleteIssueLink: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { linkId: string; } | - |
parameters.linkId | string | The ID of the issue link. |
Returns
Promise<void>
issueLinks.getIssueLink
ts
getIssueLink: (parameters) => Promise<{
[key: string]: unknown;
id?: string;
inwardIssue?: {
[key: string]: unknown;
fields?: {
[key: string]: unknown;
assignee?: {
[key: ...]: ...;
accountId?: ...;
accountType?: ...;
active?: ...;
avatarUrls?: ...;
displayName?: ...;
emailAddress?: ...;
self?: ...;
timeZone?: ...;
};
issuetype?: {
[key: ...]: ...;
avatarId?: ...;
description?: ...;
entityId?: ...;
hierarchyLevel?: ...;
iconUrl?: ...;
id?: ...;
name?: ...;
scope?: ...;
self?: ...;
subtask?: ...;
untranslatedName?: ...;
};
issueType?: {
[key: ...]: ...;
avatarId?: ...;
description?: ...;
entityId?: ...;
hierarchyLevel?: ...;
iconUrl?: ...;
id?: ...;
name?: ...;
scope?: ...;
self?: ...;
subtask?: ...;
untranslatedName?: ...;
};
priority?: {
[key: ...]: ...;
avatarId?: ...;
description?: ...;
iconUrl?: ...;
id?: ...;
isDefault?: ...;
name?: ...;
schemes?: ...;
self?: ...;
statusColor?: ...;
};
status?: {
[key: ...]: ...;
description?: ...;
iconUrl?: ...;
id?: ...;
name?: ...;
scope?: ...;
self?: ...;
statusCategory?: ...;
untranslatedName?: ...;
};
summary?: string;
timetracking?: {
[key: ...]: ...;
originalEstimate?: ...;
originalEstimateSeconds?: ...;
remainingEstimate?: ...;
remainingEstimateSeconds?: ...;
timeSpent?: ...;
timeSpentSeconds?: ...;
};
};
id?: string;
key?: string;
self?: string;
};
outwardIssue?: {
[key: string]: unknown;
fields?: {
[key: string]: unknown;
assignee?: {
[key: ...]: ...;
accountId?: ...;
accountType?: ...;
active?: ...;
avatarUrls?: ...;
displayName?: ...;
emailAddress?: ...;
self?: ...;
timeZone?: ...;
};
issuetype?: {
[key: ...]: ...;
avatarId?: ...;
description?: ...;
entityId?: ...;
hierarchyLevel?: ...;
iconUrl?: ...;
id?: ...;
name?: ...;
scope?: ...;
self?: ...;
subtask?: ...;
untranslatedName?: ...;
};
issueType?: {
[key: ...]: ...;
avatarId?: ...;
description?: ...;
entityId?: ...;
hierarchyLevel?: ...;
iconUrl?: ...;
id?: ...;
name?: ...;
scope?: ...;
self?: ...;
subtask?: ...;
untranslatedName?: ...;
};
priority?: {
[key: ...]: ...;
avatarId?: ...;
description?: ...;
iconUrl?: ...;
id?: ...;
isDefault?: ...;
name?: ...;
schemes?: ...;
self?: ...;
statusColor?: ...;
};
status?: {
[key: ...]: ...;
description?: ...;
iconUrl?: ...;
id?: ...;
name?: ...;
scope?: ...;
self?: ...;
statusCategory?: ...;
untranslatedName?: ...;
};
summary?: string;
timetracking?: {
[key: ...]: ...;
originalEstimate?: ...;
originalEstimateSeconds?: ...;
remainingEstimate?: ...;
remainingEstimateSeconds?: ...;
timeSpent?: ...;
timeSpentSeconds?: ...;
};
};
id?: string;
key?: string;
self?: string;
};
self?: string;
type?: {
[key: string]: unknown;
id?: string;
inward?: string;
name?: string;
outward?: string;
self?: string;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { linkId: string; } | - |
parameters.linkId | string | The ID of the issue link. |
Returns
Promise<{ [key: string]: unknown; id?: string; inwardIssue?: { [key: string]: unknown; fields?: { [key: string]: unknown; assignee?: { [key: ...]: ...; accountId?: ...; accountType?: ...; active?: ...; avatarUrls?: ...; displayName?: ...; emailAddress?: ...; self?: ...; timeZone?: ...; }; issuetype?: { [key: ...]: ...; avatarId?: ...; description?: ...; entityId?: ...; hierarchyLevel?: ...; iconUrl?: ...; id?: ...; name?: ...; scope?: ...; self?: ...; subtask?: ...; untranslatedName?: ...; }; issueType?: { [key: ...]: ...; avatarId?: ...; description?: ...; entityId?: ...; hierarchyLevel?: ...; iconUrl?: ...; id?: ...; name?: ...; scope?: ...; self?: ...; subtask?: ...; untranslatedName?: ...; }; priority?: { [key: ...]: ...; avatarId?: ...; description?: ...; iconUrl?: ...; id?: ...; isDefault?: ...; name?: ...; schemes?: ...; self?: ...; statusColor?: ...; }; status?: { [key: ...]: ...; description?: ...; iconUrl?: ...; id?: ...; name?: ...; scope?: ...; self?: ...; statusCategory?: ...; untranslatedName?: ...; }; summary?: string; timetracking?: { [key: ...]: ...; originalEstimate?: ...; originalEstimateSeconds?: ...; remainingEstimate?: ...; remainingEstimateSeconds?: ...; timeSpent?: ...; timeSpentSeconds?: ...; }; }; id?: string; key?: string; self?: string; }; outwardIssue?: { [key: string]: unknown; fields?: { [key: string]: unknown; assignee?: { [key: ...]: ...; accountId?: ...; accountType?: ...; active?: ...; avatarUrls?: ...; displayName?: ...; emailAddress?: ...; self?: ...; timeZone?: ...; }; issuetype?: { [key: ...]: ...; avatarId?: ...; description?: ...; entityId?: ...; hierarchyLevel?: ...; iconUrl?: ...; id?: ...; name?: ...; scope?: ...; self?: ...; subtask?: ...; untranslatedName?: ...; }; issueType?: { [key: ...]: ...; avatarId?: ...; description?: ...; entityId?: ...; hierarchyLevel?: ...; iconUrl?: ...; id?: ...; name?: ...; scope?: ...; self?: ...; subtask?: ...; untranslatedName?: ...; }; priority?: { [key: ...]: ...; avatarId?: ...; description?: ...; iconUrl?: ...; id?: ...; isDefault?: ...; name?: ...; schemes?: ...; self?: ...; statusColor?: ...; }; status?: { [key: ...]: ...; description?: ...; iconUrl?: ...; id?: ...; name?: ...; scope?: ...; self?: ...; statusCategory?: ...; untranslatedName?: ...; }; summary?: string; timetracking?: { [key: ...]: ...; originalEstimate?: ...; originalEstimateSeconds?: ...; remainingEstimate?: ...; remainingEstimateSeconds?: ...; timeSpent?: ...; timeSpentSeconds?: ...; }; }; id?: string; key?: string; self?: string; }; self?: string; type?: { [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }; }>
issueLinks.linkIssues
ts
linkIssues: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { comment?: { [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; id?: string; jsdAuthorCanSeeRequest?: boolean; jsdPublic?: boolean; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }; inwardIssue: { [key: string]: unknown; fields?: { [key: string]: unknown; assignee?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; statusCategory?: { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { [key: string]: unknown; originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }; id?: string; key?: string; self?: string; }; outwardIssue: { [key: string]: unknown; fields?: { [key: string]: unknown; assignee?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; statusCategory?: { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { [key: string]: unknown; originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }; id?: string; key?: string; self?: string; }; type: { [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }; } | - |
parameters.comment? | { [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; id?: string; jsdAuthorCanSeeRequest?: boolean; jsdPublic?: boolean; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; } | - |
parameters.comment.author? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.comment.author.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.comment.author.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.comment.author.active? | boolean | Whether the user is active. |
parameters.comment.author.avatarUrls? | { [key: string]: unknown; 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; } | - |
parameters.comment.author.avatarUrls.16x16? | ... | ... | The URL of the item's 16x16 pixel avatar. |
parameters.comment.author.avatarUrls.24x24? | ... | ... | The URL of the item's 24x24 pixel avatar. |
parameters.comment.author.avatarUrls.32x32? | ... | ... | The URL of the item's 32x32 pixel avatar. |
parameters.comment.author.avatarUrls.48x48? | ... | ... | The URL of the item's 48x48 pixel avatar. |
parameters.comment.author.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.comment.author.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.comment.author.self? | string | The URL of the user. |
parameters.comment.author.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.comment.body? | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; } | The comment text in Atlassian Document Format. |
parameters.comment.body.content | Record<string, any>[] | - |
parameters.comment.body.type | string & object | "doc" | - |
parameters.comment.body.version | number | - |
parameters.comment.created? | unknown | The date and time at which the comment was created. |
parameters.comment.id? | string | The ID of the comment. |
parameters.comment.jsdAuthorCanSeeRequest? | boolean | Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature. |
parameters.comment.jsdPublic? | boolean | Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation. |
parameters.comment.properties? | object[] | A list of comment properties. Optional on create and update. |
parameters.comment.renderedBody? | string | The rendered version of the comment. |
parameters.comment.self? | string | The URL of the comment. |
parameters.comment.updateAuthor? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.comment.updateAuthor.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.comment.updateAuthor.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.comment.updateAuthor.active? | boolean | Whether the user is active. |
parameters.comment.updateAuthor.avatarUrls? | { [key: string]: unknown; 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; } | - |
parameters.comment.updateAuthor.avatarUrls.16x16? | ... | ... | The URL of the item's 16x16 pixel avatar. |
parameters.comment.updateAuthor.avatarUrls.24x24? | ... | ... | The URL of the item's 24x24 pixel avatar. |
parameters.comment.updateAuthor.avatarUrls.32x32? | ... | ... | The URL of the item's 32x32 pixel avatar. |
parameters.comment.updateAuthor.avatarUrls.48x48? | ... | ... | The URL of the item's 48x48 pixel avatar. |
parameters.comment.updateAuthor.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.comment.updateAuthor.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.comment.updateAuthor.self? | string | The URL of the user. |
parameters.comment.updateAuthor.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.comment.updated? | unknown | The date and time at which the comment was updated last. |
parameters.comment.visibility? | { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; } | - |
parameters.comment.visibility.identifier? | string | null | The ID of the group or the name of the role that visibility of this item is restricted to. |
parameters.comment.visibility.type? | "role" | "group" | string & object | Whether visibility of this item is restricted to a group or role. |
parameters.comment.visibility.value? | string | The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier. |
parameters.inwardIssue | { [key: string]: unknown; fields?: { [key: string]: unknown; assignee?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; statusCategory?: { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { [key: string]: unknown; originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }; id?: string; key?: string; self?: string; } | - |
parameters.inwardIssue.fields? | { [key: string]: unknown; assignee?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; statusCategory?: { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { [key: string]: unknown; originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; } | - |
parameters.inwardIssue.fields.assignee? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.inwardIssue.fields.assignee.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.inwardIssue.fields.assignee.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.inwardIssue.fields.assignee.active? | boolean | Whether the user is active. |
parameters.inwardIssue.fields.assignee.avatarUrls? | { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; } | - |
parameters.inwardIssue.fields.assignee.avatarUrls.16x16? | ... | The URL of the item's 16x16 pixel avatar. |
parameters.inwardIssue.fields.assignee.avatarUrls.24x24? | ... | The URL of the item's 24x24 pixel avatar. |
parameters.inwardIssue.fields.assignee.avatarUrls.32x32? | ... | The URL of the item's 32x32 pixel avatar. |
parameters.inwardIssue.fields.assignee.avatarUrls.48x48? | ... | The URL of the item's 48x48 pixel avatar. |
parameters.inwardIssue.fields.assignee.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.inwardIssue.fields.assignee.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.inwardIssue.fields.assignee.self? | string | The URL of the user. |
parameters.inwardIssue.fields.assignee.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.inwardIssue.fields.issuetype? | { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; } | The type of the linked issue. |
parameters.inwardIssue.fields.issuetype.avatarId? | number | The ID of the issue type's avatar. |
parameters.inwardIssue.fields.issuetype.description? | string | The description of the issue type. |
parameters.inwardIssue.fields.issuetype.entityId? | string | Unique ID for next-gen projects. |
parameters.inwardIssue.fields.issuetype.hierarchyLevel? | number | Hierarchy level of the issue type. |
parameters.inwardIssue.fields.issuetype.iconUrl? | string | The URL of the issue type's avatar. |
parameters.inwardIssue.fields.issuetype.id? | string | The ID of the issue type. |
parameters.inwardIssue.fields.issuetype.name? | string | The name of the issue type. |
parameters.inwardIssue.fields.issuetype.scope? | { [key: ...]: ...; project?: ...; type?: ...; } | - |
parameters.inwardIssue.fields.issuetype.scope.project? | ... | - |
parameters.inwardIssue.fields.issuetype.scope.type? | ... | The type of scope. |
parameters.inwardIssue.fields.issuetype.self? | string | The URL of these issue type details. |
parameters.inwardIssue.fields.issuetype.subtask? | boolean | Whether this issue type is used to create subtasks. |
parameters.inwardIssue.fields.issuetype.untranslatedName? | string | - |
parameters.inwardIssue.fields.issueType? | { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; } | - |
parameters.inwardIssue.fields.issueType.avatarId? | number | The ID of the issue type's avatar. |
parameters.inwardIssue.fields.issueType.description? | string | The description of the issue type. |
parameters.inwardIssue.fields.issueType.entityId? | string | Unique ID for next-gen projects. |
parameters.inwardIssue.fields.issueType.hierarchyLevel? | number | Hierarchy level of the issue type. |
parameters.inwardIssue.fields.issueType.iconUrl? | string | The URL of the issue type's avatar. |
parameters.inwardIssue.fields.issueType.id? | string | The ID of the issue type. |
parameters.inwardIssue.fields.issueType.name? | string | The name of the issue type. |
parameters.inwardIssue.fields.issueType.scope? | { [key: ...]: ...; project?: ...; type?: ...; } | - |
parameters.inwardIssue.fields.issueType.scope.project? | ... | - |
parameters.inwardIssue.fields.issueType.scope.type? | ... | The type of scope. |
parameters.inwardIssue.fields.issueType.self? | string | The URL of these issue type details. |
parameters.inwardIssue.fields.issueType.subtask? | boolean | Whether this issue type is used to create subtasks. |
parameters.inwardIssue.fields.issueType.untranslatedName? | string | - |
parameters.inwardIssue.fields.priority? | { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; } | - |
parameters.inwardIssue.fields.priority.avatarId? | number | The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs. |
parameters.inwardIssue.fields.priority.description? | string | The description of the issue priority. |
parameters.inwardIssue.fields.priority.iconUrl? | string | The URL of the icon for the issue priority. |
parameters.inwardIssue.fields.priority.id? | string | The ID of the issue priority. |
parameters.inwardIssue.fields.priority.isDefault? | boolean | Whether this priority is the default. |
parameters.inwardIssue.fields.priority.name? | string | The name of the issue priority. |
parameters.inwardIssue.fields.priority.schemes? | { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; } | - |
parameters.inwardIssue.fields.priority.schemes.maxResults? | ... | - |
parameters.inwardIssue.fields.priority.schemes.startAt? | ... | - |
parameters.inwardIssue.fields.priority.schemes.total? | ... | - |
parameters.inwardIssue.fields.priority.self? | string | The URL of the issue priority. |
parameters.inwardIssue.fields.priority.statusColor? | string | The color used to indicate the issue priority. |
parameters.inwardIssue.fields.status? | { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; statusCategory?: { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; } | - |
parameters.inwardIssue.fields.status.description? | string | The description of the status. |
parameters.inwardIssue.fields.status.iconUrl? | string | The URL of the icon used to represent the status. |
parameters.inwardIssue.fields.status.id? | string | The ID of the status. |
parameters.inwardIssue.fields.status.name? | string | The name of the status. |
parameters.inwardIssue.fields.status.scope? | { [key: ...]: ...; project?: ...; type?: ...; } | - |
parameters.inwardIssue.fields.status.scope.project? | ... | - |
parameters.inwardIssue.fields.status.scope.type? | ... | The type of scope. |
parameters.inwardIssue.fields.status.self? | string | The URL of the status. |
parameters.inwardIssue.fields.status.statusCategory? | { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; } | - |
parameters.inwardIssue.fields.status.statusCategory.colorName? | ... | The name of the color used to represent the status category. |
parameters.inwardIssue.fields.status.statusCategory.id? | ... | The ID of the status category. |
parameters.inwardIssue.fields.status.statusCategory.key? | ... | The key of the status category. |
parameters.inwardIssue.fields.status.statusCategory.name? | ... | The name of the status category. |
parameters.inwardIssue.fields.status.statusCategory.self? | ... | The URL of the status category. |
parameters.inwardIssue.fields.status.untranslatedName? | string | - |
parameters.inwardIssue.fields.summary? | string | The summary description of the linked issue. |
parameters.inwardIssue.fields.timetracking? | { [key: string]: unknown; originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; } | - |
parameters.inwardIssue.fields.timetracking.originalEstimate? | string | The original estimate of time needed for this issue in readable format. |
parameters.inwardIssue.fields.timetracking.originalEstimateSeconds? | number | The original estimate of time needed for this issue in seconds. |
parameters.inwardIssue.fields.timetracking.remainingEstimate? | string | The remaining estimate of time needed for this issue in readable format. |
parameters.inwardIssue.fields.timetracking.remainingEstimateSeconds? | number | The remaining estimate of time needed for this issue in seconds. |
parameters.inwardIssue.fields.timetracking.timeSpent? | string | Time worked on this issue in readable format. |
parameters.inwardIssue.fields.timetracking.timeSpentSeconds? | number | Time worked on this issue in seconds. |
parameters.inwardIssue.id? | string | The ID of an issue. Required if key isn't provided. |
parameters.inwardIssue.key? | string | The key of an issue. Required if id isn't provided. |
parameters.inwardIssue.self? | string | The URL of the issue. |
parameters.outwardIssue | { [key: string]: unknown; fields?: { [key: string]: unknown; assignee?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; statusCategory?: { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { [key: string]: unknown; originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }; id?: string; key?: string; self?: string; } | - |
parameters.outwardIssue.fields? | { [key: string]: unknown; assignee?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; statusCategory?: { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { [key: string]: unknown; originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; } | - |
parameters.outwardIssue.fields.assignee? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.outwardIssue.fields.assignee.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.outwardIssue.fields.assignee.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.outwardIssue.fields.assignee.active? | boolean | Whether the user is active. |
parameters.outwardIssue.fields.assignee.avatarUrls? | { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; } | - |
parameters.outwardIssue.fields.assignee.avatarUrls.16x16? | ... | The URL of the item's 16x16 pixel avatar. |
parameters.outwardIssue.fields.assignee.avatarUrls.24x24? | ... | The URL of the item's 24x24 pixel avatar. |
parameters.outwardIssue.fields.assignee.avatarUrls.32x32? | ... | The URL of the item's 32x32 pixel avatar. |
parameters.outwardIssue.fields.assignee.avatarUrls.48x48? | ... | The URL of the item's 48x48 pixel avatar. |
parameters.outwardIssue.fields.assignee.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.outwardIssue.fields.assignee.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.outwardIssue.fields.assignee.self? | string | The URL of the user. |
parameters.outwardIssue.fields.assignee.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.outwardIssue.fields.issuetype? | { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; } | The type of the linked issue. |
parameters.outwardIssue.fields.issuetype.avatarId? | number | The ID of the issue type's avatar. |
parameters.outwardIssue.fields.issuetype.description? | string | The description of the issue type. |
parameters.outwardIssue.fields.issuetype.entityId? | string | Unique ID for next-gen projects. |
parameters.outwardIssue.fields.issuetype.hierarchyLevel? | number | Hierarchy level of the issue type. |
parameters.outwardIssue.fields.issuetype.iconUrl? | string | The URL of the issue type's avatar. |
parameters.outwardIssue.fields.issuetype.id? | string | The ID of the issue type. |
parameters.outwardIssue.fields.issuetype.name? | string | The name of the issue type. |
parameters.outwardIssue.fields.issuetype.scope? | { [key: ...]: ...; project?: ...; type?: ...; } | - |
parameters.outwardIssue.fields.issuetype.scope.project? | ... | - |
parameters.outwardIssue.fields.issuetype.scope.type? | ... | The type of scope. |
parameters.outwardIssue.fields.issuetype.self? | string | The URL of these issue type details. |
parameters.outwardIssue.fields.issuetype.subtask? | boolean | Whether this issue type is used to create subtasks. |
parameters.outwardIssue.fields.issuetype.untranslatedName? | string | - |
parameters.outwardIssue.fields.issueType? | { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; } | - |
parameters.outwardIssue.fields.issueType.avatarId? | number | The ID of the issue type's avatar. |
parameters.outwardIssue.fields.issueType.description? | string | The description of the issue type. |
parameters.outwardIssue.fields.issueType.entityId? | string | Unique ID for next-gen projects. |
parameters.outwardIssue.fields.issueType.hierarchyLevel? | number | Hierarchy level of the issue type. |
parameters.outwardIssue.fields.issueType.iconUrl? | string | The URL of the issue type's avatar. |
parameters.outwardIssue.fields.issueType.id? | string | The ID of the issue type. |
parameters.outwardIssue.fields.issueType.name? | string | The name of the issue type. |
parameters.outwardIssue.fields.issueType.scope? | { [key: ...]: ...; project?: ...; type?: ...; } | - |
parameters.outwardIssue.fields.issueType.scope.project? | ... | - |
parameters.outwardIssue.fields.issueType.scope.type? | ... | The type of scope. |
parameters.outwardIssue.fields.issueType.self? | string | The URL of these issue type details. |
parameters.outwardIssue.fields.issueType.subtask? | boolean | Whether this issue type is used to create subtasks. |
parameters.outwardIssue.fields.issueType.untranslatedName? | string | - |
parameters.outwardIssue.fields.priority? | { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; } | - |
parameters.outwardIssue.fields.priority.avatarId? | number | The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs. |
parameters.outwardIssue.fields.priority.description? | string | The description of the issue priority. |
parameters.outwardIssue.fields.priority.iconUrl? | string | The URL of the icon for the issue priority. |
parameters.outwardIssue.fields.priority.id? | string | The ID of the issue priority. |
parameters.outwardIssue.fields.priority.isDefault? | boolean | Whether this priority is the default. |
parameters.outwardIssue.fields.priority.name? | string | The name of the issue priority. |
parameters.outwardIssue.fields.priority.schemes? | { [key: ...]: ...; maxResults?: ...; startAt?: ...; total?: ...; } | - |
parameters.outwardIssue.fields.priority.schemes.maxResults? | ... | - |
parameters.outwardIssue.fields.priority.schemes.startAt? | ... | - |
parameters.outwardIssue.fields.priority.schemes.total? | ... | - |
parameters.outwardIssue.fields.priority.self? | string | The URL of the issue priority. |
parameters.outwardIssue.fields.priority.statusColor? | string | The color used to indicate the issue priority. |
parameters.outwardIssue.fields.status? | { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: ...]: ...; project?: ...; type?: ...; }; self?: string; statusCategory?: { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; } | - |
parameters.outwardIssue.fields.status.description? | string | The description of the status. |
parameters.outwardIssue.fields.status.iconUrl? | string | The URL of the icon used to represent the status. |
parameters.outwardIssue.fields.status.id? | string | The ID of the status. |
parameters.outwardIssue.fields.status.name? | string | The name of the status. |
parameters.outwardIssue.fields.status.scope? | { [key: ...]: ...; project?: ...; type?: ...; } | - |
parameters.outwardIssue.fields.status.scope.project? | ... | - |
parameters.outwardIssue.fields.status.scope.type? | ... | The type of scope. |
parameters.outwardIssue.fields.status.self? | string | The URL of the status. |
parameters.outwardIssue.fields.status.statusCategory? | { [key: ...]: ...; colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; } | - |
parameters.outwardIssue.fields.status.statusCategory.colorName? | ... | The name of the color used to represent the status category. |
parameters.outwardIssue.fields.status.statusCategory.id? | ... | The ID of the status category. |
parameters.outwardIssue.fields.status.statusCategory.key? | ... | The key of the status category. |
parameters.outwardIssue.fields.status.statusCategory.name? | ... | The name of the status category. |
parameters.outwardIssue.fields.status.statusCategory.self? | ... | The URL of the status category. |
parameters.outwardIssue.fields.status.untranslatedName? | string | - |
parameters.outwardIssue.fields.summary? | string | The summary description of the linked issue. |
parameters.outwardIssue.fields.timetracking? | { [key: string]: unknown; originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; } | - |
parameters.outwardIssue.fields.timetracking.originalEstimate? | string | The original estimate of time needed for this issue in readable format. |
parameters.outwardIssue.fields.timetracking.originalEstimateSeconds? | number | The original estimate of time needed for this issue in seconds. |
parameters.outwardIssue.fields.timetracking.remainingEstimate? | string | The remaining estimate of time needed for this issue in readable format. |
parameters.outwardIssue.fields.timetracking.remainingEstimateSeconds? | number | The remaining estimate of time needed for this issue in seconds. |
parameters.outwardIssue.fields.timetracking.timeSpent? | string | Time worked on this issue in readable format. |
parameters.outwardIssue.fields.timetracking.timeSpentSeconds? | number | Time worked on this issue in seconds. |
parameters.outwardIssue.id? | string | The ID of an issue. Required if key isn't provided. |
parameters.outwardIssue.key? | string | The key of an issue. Required if id isn't provided. |
parameters.outwardIssue.self? | string | The URL of the issue. |
parameters.type | { [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; } | - |
parameters.type.id? | string | The ID of the issue link type and is used as follows: - In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only. - In the issueLinkType resource it is read only. |
parameters.type.inward? | string | The description of the issue link type inward link and is used as follows: - In the issueLink resource it is read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only. |
parameters.type.name? | string | The name of the issue link type and is used as follows: - In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only. |
parameters.type.outward? | string | The description of the issue link type outward link and is used as follows: - In the issueLink resource it is read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only. |
parameters.type.self? | string | The URL of the issue link type. Read only. |
Returns
Promise<void>
issueLinkTypes
ts
issueLinkTypes: object;issueLinkTypes.createIssueLinkType
ts
createIssueLinkType: (parameters) => Promise<{
[key: string]: unknown;
id?: string;
inward?: string;
name?: string;
outward?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id?: string; inward?: string; name?: string; outward?: string; self?: string; } | - |
parameters.id? | string | The ID of the issue link type and is used as follows: - In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only. - In the issueLinkType resource it is read only. |
parameters.inward? | string | The description of the issue link type inward link and is used as follows: - In the issueLink resource it is read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only. |
parameters.name? | string | The name of the issue link type and is used as follows: - In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only. |
parameters.outward? | string | The description of the issue link type outward link and is used as follows: - In the issueLink resource it is read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only. |
parameters.self? | string | The URL of the issue link type. Read only. |
Returns
Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>
issueLinkTypes.deleteIssueLinkType
ts
deleteIssueLinkType: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueLinkTypeId: string; } | - |
parameters.issueLinkTypeId | string | The ID of the issue link type. |
Returns
Promise<void>
issueLinkTypes.getIssueLinkType
ts
getIssueLinkType: (parameters) => Promise<{
[key: string]: unknown;
id?: string;
inward?: string;
name?: string;
outward?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueLinkTypeId: string; } | - |
parameters.issueLinkTypeId | string | The ID of the issue link type. |
Returns
Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>
issueLinkTypes.getIssueLinkTypes
ts
getIssueLinkTypes: () => Promise<{
[key: string]: unknown;
issueLinkTypes?: object[];
}>;Returns
Promise<{ [key: string]: unknown; issueLinkTypes?: object[]; }>
issueLinkTypes.updateIssueLinkType
ts
updateIssueLinkType: (parameters) => Promise<{
[key: string]: unknown;
id?: string;
inward?: string;
name?: string;
outward?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id?: string; inward?: string; issueLinkTypeId: string; name?: string; outward?: string; self?: string; } | - |
parameters.id? | string | The ID of the issue link type and is used as follows: - In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only. - In the issueLinkType resource it is read only. |
parameters.inward? | string | The description of the issue link type inward link and is used as follows: - In the issueLink resource it is read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only. |
parameters.issueLinkTypeId | string | The ID of the issue link type. |
parameters.name? | string | The name of the issue link type and is used as follows: - In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only. |
parameters.outward? | string | The description of the issue link type outward link and is used as follows: - In the issueLink resource it is read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only. |
parameters.self? | string | The URL of the issue link type. Read only. |
Returns
Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>
issueNavigatorSettings
ts
issueNavigatorSettings: object;issueNavigatorSettings.getIssueNavigatorDefaultColumns
ts
getIssueNavigatorDefaultColumns: () => Promise<object[]>;Returns
Promise<object[]>
issueNavigatorSettings.setIssueNavigatorDefaultColumns
ts
setIssueNavigatorDefaultColumns: (parameters) => Promise<void>;Parameters
| Parameter | Type |
|---|---|
parameters | { body: Record<string, any>; } |
parameters.body | Record<string, any> |
Returns
Promise<void>
issueNotificationSchemes
ts
issueNotificationSchemes: object;issueNotificationSchemes.addNotifications
ts
addNotifications: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; notificationSchemeEvents: object[]; } | - |
parameters.id | string | The ID of the notification scheme. |
parameters.notificationSchemeEvents | object[] | The list of notifications which should be added to the notification scheme. |
Returns
Promise<void>
issueNotificationSchemes.getNotificationScheme
ts
getNotificationScheme: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
expand?: string;
id?: number;
name?: string;
notificationSchemeEvents?: object[];
projects?: number[];
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[]; id: number; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - all Returns all expandable information - field Returns information about any custom fields assigned to receive an event - group Returns information about any groups assigned to receive an event - notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information - projectRole Returns information about any project roles assigned to receive an event - user Returns information about any users assigned to receive an event |
parameters.id | number | The ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs. |
Returns
Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; notificationSchemeEvents?: object[]; projects?: number[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }>
issueNotificationSchemes.getNotificationSchemes
ts
getNotificationSchemes: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[]; id?: string[]; maxResults?: string; onlyDefault?: boolean; projectId?: string[]; startAt?: string; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - all Returns all expandable information - field Returns information about any custom fields assigned to receive an event - group Returns information about any groups assigned to receive an event - notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information - projectRole Returns information about any project roles assigned to receive an event - user Returns information about any users assigned to receive an event |
parameters.id? | string[] | The list of notification schemes IDs to be filtered by |
parameters.maxResults? | string | The maximum number of items to return per page. |
parameters.onlyDefault? | boolean | When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false. |
parameters.projectId? | string[] | The list of projects IDs to be filtered by |
parameters.startAt? | string | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueNotificationSchemes.getNotificationSchemeToProjectMappings
ts
getNotificationSchemeToProjectMappings: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { maxResults?: string; notificationSchemeId?: string[]; projectId?: string[]; startAt?: string; } | - |
parameters.maxResults? | string | The maximum number of items to return per page. |
parameters.notificationSchemeId? | string[] | The list of notifications scheme IDs to be filtered out |
parameters.projectId? | string[] | The list of project IDs to be filtered out |
parameters.startAt? | string | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueNotificationSchemes.removeNotificationFromNotificationScheme
ts
removeNotificationFromNotificationScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { notificationId: string; notificationSchemeId: string; } | - |
parameters.notificationId | string | The ID of the notification. |
parameters.notificationSchemeId | string | The ID of the notification scheme. |
Returns
Promise<void>
issuePanels
ts
issuePanels: object;issuePanels.bulkPinUnpinProjectsAsync
ts
bulkPinUnpinProjectsAsync: (parameters) => Promise<{
[key: string]: unknown;
taskId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { moduleId: string; projectList: object[]; } | - |
parameters.moduleId | string | The moduleId of the Forge panel in the format ari:cloud:ecosystem::extension/{app-id}/{environment-id}/static/{module-key} |
parameters.projectList | object[] | The list of projects to pin or unpin the issue panel to or from. |
Returns
Promise<{ [key: string]: unknown; taskId?: string; }>
issuePriorities
ts
issuePriorities: object;issuePriorities.createPriority
ts
createPriority: (parameters) => Promise<{
[key: string]: unknown;
id: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { avatarId?: number; description?: string | null; iconUrl?: | string & object | "/images/icons/priorities/blocker.png" | "/images/icons/priorities/critical.png" | "/images/icons/priorities/high.png" | "/images/icons/priorities/highest.png" | "/images/icons/priorities/low.png" | "/images/icons/priorities/lowest.png" | "/images/icons/priorities/major.png" | "/images/icons/priorities/medium.png" | "/images/icons/priorities/minor.png" | "/images/icons/priorities/trivial.png" | "/images/icons/priorities/blocker_new.png" | "/images/icons/priorities/critical_new.png" | "/images/icons/priorities/high_new.png" | "/images/icons/priorities/highest_new.png" | "/images/icons/priorities/low_new.png" | "/images/icons/priorities/lowest_new.png" | "/images/icons/priorities/major_new.png" | "/images/icons/priorities/medium_new.png" | "/images/icons/priorities/minor_new.png" | "/images/icons/priorities/trivial_new.png" | null; name: string; statusColor: string; } | - |
parameters.avatarId? | number | The ID for the avatar for the priority. Either the iconUrl or avatarId must be defined, but not both. This parameter is nullable and will become mandatory once the iconUrl parameter is deprecated. |
parameters.description? | string | null | The description of the priority. |
parameters.iconUrl? | | string & object | "/images/icons/priorities/blocker.png" | "/images/icons/priorities/critical.png" | "/images/icons/priorities/high.png" | "/images/icons/priorities/highest.png" | "/images/icons/priorities/low.png" | "/images/icons/priorities/lowest.png" | "/images/icons/priorities/major.png" | "/images/icons/priorities/medium.png" | "/images/icons/priorities/minor.png" | "/images/icons/priorities/trivial.png" | "/images/icons/priorities/blocker_new.png" | "/images/icons/priorities/critical_new.png" | "/images/icons/priorities/high_new.png" | "/images/icons/priorities/highest_new.png" | "/images/icons/priorities/low_new.png" | "/images/icons/priorities/lowest_new.png" | "/images/icons/priorities/major_new.png" | "/images/icons/priorities/medium_new.png" | "/images/icons/priorities/minor_new.png" | "/images/icons/priorities/trivial_new.png" | null | The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Either the iconUrl or avatarId must be defined, but not both. |
parameters.name | string | The name of the priority. Must be unique. |
parameters.statusColor | string | The status color of the priority in 3-digit or 6-digit hexadecimal format. |
Returns
Promise<{ [key: string]: unknown; id: string; }>
issuePriorities.deletePriority
ts
deletePriority: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
elapsedRuntime: number;
finished?: number;
id: string;
lastUpdate: number;
message?: string;
progress: number;
result?: unknown;
self: string;
started?: number;
status: | string & object
| "ENQUEUED"
| "RUNNING"
| "COMPLETE"
| "FAILED"
| "CANCEL_REQUESTED"
| "CANCELLED"
| "DEAD";
submitted: number;
submittedBy: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the issue priority. |
Returns
Promise<{ [key: string]: unknown; description?: string; elapsedRuntime: number; finished?: number; id: string; lastUpdate: number; message?: string; progress: number; result?: unknown; self: string; started?: number; status: | string & object | "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD"; submitted: number; submittedBy: number; }>
issuePriorities.getPriority
ts
getPriority: (parameters) => Promise<{
[key: string]: unknown;
avatarId?: number;
description?: string;
iconUrl?: string;
id?: string;
isDefault?: boolean;
name?: string;
schemes?: {
[key: string]: unknown;
maxResults?: number;
startAt?: number;
total?: number;
};
self?: string;
statusColor?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the issue priority. |
Returns
Promise<{ [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { [key: string]: unknown; maxResults?: number; startAt?: number; total?: number; }; self?: string; statusColor?: string; }>
issuePriorities.movePriorities
ts
movePriorities: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { after?: string; ids: string[]; position?: string; } | - |
parameters.after? | string | The ID of the priority. Required if position isn't provided. |
parameters.ids | string[] | The list of issue IDs to be reordered. Cannot contain duplicates nor after ID. |
parameters.position? | string | The position for issue priorities to be moved to. Required if after isn't provided. |
Returns
Promise<void>
issuePriorities.searchPriorities
ts
searchPriorities: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: string; id?: string[]; maxResults?: string; onlyDefault?: boolean; priorityName?: string; projectId?: string[]; startAt?: string; } | - |
parameters.expand? | string | Use schemes to return the associated priority schemes for each priority. Limited to returning first 15 priority schemes per priority. |
parameters.id? | string[] | The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=2&id=3. |
parameters.maxResults? | string | The maximum number of items to return per page. |
parameters.onlyDefault? | boolean | Whether only the default priority is returned. |
parameters.priorityName? | string | The name of priority to search for. |
parameters.projectId? | string[] | The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, projectId=10010&projectId=10111. |
parameters.startAt? | string | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issuePriorities.setDefaultPriority
ts
setDefaultPriority: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the new default issue priority. Must be an existing ID or null. Setting this to null erases the default priority setting. |
Returns
Promise<void>
issuePriorities.updatePriority
ts
updatePriority: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { avatarId?: number; description?: string | null; iconUrl?: | string & object | "/images/icons/priorities/blocker.png" | "/images/icons/priorities/critical.png" | "/images/icons/priorities/high.png" | "/images/icons/priorities/highest.png" | "/images/icons/priorities/low.png" | "/images/icons/priorities/lowest.png" | "/images/icons/priorities/major.png" | "/images/icons/priorities/medium.png" | "/images/icons/priorities/minor.png" | "/images/icons/priorities/trivial.png" | "/images/icons/priorities/blocker_new.png" | "/images/icons/priorities/critical_new.png" | "/images/icons/priorities/high_new.png" | "/images/icons/priorities/highest_new.png" | "/images/icons/priorities/low_new.png" | "/images/icons/priorities/lowest_new.png" | "/images/icons/priorities/major_new.png" | "/images/icons/priorities/medium_new.png" | "/images/icons/priorities/minor_new.png" | "/images/icons/priorities/trivial_new.png" | null; id: string; name?: string | null; statusColor?: string | null; } | - |
parameters.avatarId? | number | The ID for the avatar for the priority. This parameter is nullable and both iconUrl and avatarId cannot be defined. |
parameters.description? | string | null | The description of the priority. |
parameters.iconUrl? | | string & object | "/images/icons/priorities/blocker.png" | "/images/icons/priorities/critical.png" | "/images/icons/priorities/high.png" | "/images/icons/priorities/highest.png" | "/images/icons/priorities/low.png" | "/images/icons/priorities/lowest.png" | "/images/icons/priorities/major.png" | "/images/icons/priorities/medium.png" | "/images/icons/priorities/minor.png" | "/images/icons/priorities/trivial.png" | "/images/icons/priorities/blocker_new.png" | "/images/icons/priorities/critical_new.png" | "/images/icons/priorities/high_new.png" | "/images/icons/priorities/highest_new.png" | "/images/icons/priorities/low_new.png" | "/images/icons/priorities/lowest_new.png" | "/images/icons/priorities/major_new.png" | "/images/icons/priorities/medium_new.png" | "/images/icons/priorities/minor_new.png" | "/images/icons/priorities/trivial_new.png" | null | The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Both iconUrl and avatarId cannot be defined. |
parameters.id | string | The ID of the issue priority. |
parameters.name? | string | null | The name of the priority. Must be unique. |
parameters.statusColor? | string | null | The status color of the priority in 3-digit or 6-digit hexadecimal format. |
Returns
Promise<void>
issueProperties
ts
issueProperties: object;issueProperties.bulkDeleteIssueProperty
ts
bulkDeleteIssueProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { currentValue?: unknown; entityIds?: number[]; propertyKey: string; } | - |
parameters.currentValue? | unknown | The value of properties to perform the bulk operation on. |
parameters.entityIds? | number[] | List of issues to perform the bulk delete operation on. |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<void>
issueProperties.bulkSetIssuePropertiesByIssue
ts
bulkSetIssuePropertiesByIssue: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issues?: object[]; } | - |
parameters.issues? | object[] | A list of issue IDs and their respective properties. |
Returns
Promise<void>
issueProperties.bulkSetIssueProperty
ts
bulkSetIssueProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expression?: string; filter?: { [key: string]: unknown; currentValue?: unknown; entityIds?: number[]; hasProperty?: boolean; }; propertyKey: string; value?: unknown; } | - |
parameters.expression? | string | EXPERIMENTAL. The Jira expression to calculate the value of the property. The value of the expression must be an object that can be converted to JSON, such as a number, boolean, string, list, or map. The context variables available to the expression are issue and user. Issues for which the expression returns a value whose JSON representation is longer than 32768 characters are ignored. |
parameters.filter? | { [key: string]: unknown; currentValue?: unknown; entityIds?: number[]; hasProperty?: boolean; } | - |
parameters.filter.currentValue? | unknown | The value of properties to perform the bulk operation on. |
parameters.filter.entityIds? | number[] | List of issues to perform the bulk operation on. |
parameters.filter.hasProperty? | boolean | Whether the bulk operation occurs only when the property is present on or absent from an issue. |
parameters.propertyKey | string | The key of the property. The maximum length is 255 characters. |
parameters.value? | unknown | The value of the property. The value must be a valid, non-empty JSON blob. The maximum length is 32768 characters. |
Returns
Promise<void>
issueProperties.bulkSetIssuesPropertiesList
ts
bulkSetIssuesPropertiesList: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { entitiesIds?: number[]; properties?: Record<string, any>; } | - |
parameters.entitiesIds? | number[] | A list of entity property IDs. |
parameters.properties? | Record<string, any> | A list of entity property keys and values. |
Returns
Promise<void>
issueProperties.deleteIssueProperty
ts
deleteIssueProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; propertyKey: string; } | - |
parameters.issueIdOrKey | string | The key or ID of the issue. |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<void>
issueProperties.getIssueProperty
ts
getIssueProperty: (parameters) => Promise<{
[key: string]: unknown;
key?: string;
value?: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; propertyKey: string; } | - |
parameters.issueIdOrKey | string | The key or ID of the issue. |
parameters.propertyKey | string | The key of the property. |
Returns
Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>
issueProperties.getIssuePropertyKeys
ts
getIssuePropertyKeys: (parameters) => Promise<{
[key: string]: unknown;
keys?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; } | - |
parameters.issueIdOrKey | string | The key or ID of the issue. |
Returns
Promise<{ [key: string]: unknown; keys?: object[]; }>
issueProperties.setIssueProperty
ts
setIssueProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; issueIdOrKey: string; propertyKey: string; } | - |
parameters.body | Record<string, any> | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.propertyKey | string | The key of the issue property. The maximum length is 255 characters. |
Returns
Promise<void>
issueRedaction
ts
issueRedaction: object;issueRedaction.getRedactionStatus
ts
getRedactionStatus: (parameters) => Promise<{
[key: string]: unknown;
bulkRedactionResponse?: {
[key: string]: unknown;
results: object[];
};
jobStatus?: string & object | "IN_PROGRESS" | "PENDING" | "COMPLETED";
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { jobId: string; } | - |
parameters.jobId | string | Redaction job id |
Returns
Promise<{ [key: string]: unknown; bulkRedactionResponse?: { [key: string]: unknown; results: object[]; }; jobStatus?: string & object | "IN_PROGRESS" | "PENDING" | "COMPLETED"; }>
issueRedaction.redact
ts
redact: (parameters) => Promise<string>;Parameters
| Parameter | Type |
|---|---|
parameters | { redactions?: object[]; } |
parameters.redactions? | object[] |
Returns
Promise<string>
issueRemoteLinks
ts
issueRemoteLinks: object;issueRemoteLinks.createOrUpdateRemoteIssueLink
ts
createOrUpdateRemoteIssueLink: (parameters) => Promise<{
[key: string]: unknown;
id?: number;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { application?: { [key: string]: unknown; name?: string; type?: string; }; globalId?: string; issueIdOrKey: string; object?: { [key: string]: unknown; icon?: { [key: string]: unknown; link?: string; title?: string; url16x16?: string; }; status?: { [key: string]: unknown; icon?: { [key: string]: unknown; link?: ... | ...; title?: ... | ...; url16x16?: ... | ...; }; resolved?: boolean; }; summary?: string; title: string; url: string; }; relationship?: string; } | - |
parameters.application? | { [key: string]: unknown; name?: string; type?: string; } | - |
parameters.application.name? | string | The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last. |
parameters.application.type? | string | The name-spaced type of the application, used by registered rendering apps. |
parameters.globalId? | string | An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123. Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID. The maximum length is 255 characters. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.object? | { [key: string]: unknown; icon?: { [key: string]: unknown; link?: string; title?: string; url16x16?: string; }; status?: { [key: string]: unknown; icon?: { [key: string]: unknown; link?: ... | ...; title?: ... | ...; url16x16?: ... | ...; }; resolved?: boolean; }; summary?: string; title: string; url: string; } | - |
parameters.object.icon? | { [key: string]: unknown; link?: string; title?: string; url16x16?: string; } | - |
parameters.object.icon.link? | string | The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable. |
parameters.object.icon.title? | string | The title of the icon. This is used as follows: - For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. - For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". |
parameters.object.icon.url16x16? | string | The URL of an icon that displays at 16x16 pixel in Jira. |
parameters.object.status? | { [key: string]: unknown; icon?: { [key: string]: unknown; link?: ... | ...; title?: ... | ...; url16x16?: ... | ...; }; resolved?: boolean; } | - |
parameters.object.status.icon? | { [key: string]: unknown; link?: ... | ...; title?: ... | ...; url16x16?: ... | ...; } | - |
parameters.object.status.icon.link? | ... | ... | The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable. |
parameters.object.status.icon.title? | ... | ... | The title of the icon. This is used as follows: - For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. - For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". |
parameters.object.status.icon.url16x16? | ... | ... | The URL of an icon that displays at 16x16 pixel in Jira. |
parameters.object.status.resolved? | boolean | Whether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font. |
parameters.object.summary? | string | The summary details of the item. |
parameters.object.title | string | The title of the item. |
parameters.object.url | string | The URL of the item. |
parameters.relationship? | string | Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira. |
Returns
Promise<{ [key: string]: unknown; id?: number; self?: string; }>
issueRemoteLinks.deleteRemoteIssueLinkByGlobalId
ts
deleteRemoteIssueLinkByGlobalId: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { globalId: string; issueIdOrKey: string; } | - |
parameters.globalId | string | The global ID of a remote issue link. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<void>
issueRemoteLinks.deleteRemoteIssueLinkById
ts
deleteRemoteIssueLinkById: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; linkId: string; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.linkId | string | The ID of a remote issue link. |
Returns
Promise<void>
issueRemoteLinks.getRemoteIssueLinkById
ts
getRemoteIssueLinkById: (parameters) => Promise<{
[key: string]: unknown;
application?: {
[key: string]: unknown;
name?: string;
type?: string;
};
globalId?: string;
id?: number;
object?: {
[key: string]: unknown;
icon?: {
[key: string]: unknown;
link?: string;
title?: string;
url16x16?: string;
};
status?: {
[key: string]: unknown;
icon?: {
[key: ...]: ...;
link?: ...;
title?: ...;
url16x16?: ...;
};
resolved?: boolean;
};
summary?: string;
title: string;
url: string;
};
relationship?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; linkId: string; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.linkId | string | The ID of the remote issue link. |
Returns
Promise<{ [key: string]: unknown; application?: { [key: string]: unknown; name?: string; type?: string; }; globalId?: string; id?: number; object?: { [key: string]: unknown; icon?: { [key: string]: unknown; link?: string; title?: string; url16x16?: string; }; status?: { [key: string]: unknown; icon?: { [key: ...]: ...; link?: ...; title?: ...; url16x16?: ...; }; resolved?: boolean; }; summary?: string; title: string; url: string; }; relationship?: string; self?: string; }>
issueRemoteLinks.getRemoteIssueLinks
ts
getRemoteIssueLinks: (parameters) => Promise<
| {
[key: string]: unknown;
application?: {
[key: string]: unknown;
name?: string;
type?: string;
};
globalId?: string;
id?: number;
object?: {
[key: string]: unknown;
icon?: {
[key: string]: unknown;
link?: ... | ...;
title?: ... | ...;
url16x16?: ... | ...;
};
status?: {
[key: string]: unknown;
icon?: ... | ...;
resolved?: ... | ... | ...;
};
summary?: string;
title: string;
url: string;
};
relationship?: string;
self?: string;
}
| object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { globalId?: string; issueIdOrKey: string; } | - |
parameters.globalId? | string | The global ID of the remote issue link. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise< | { [key: string]: unknown; application?: { [key: string]: unknown; name?: string; type?: string; }; globalId?: string; id?: number; object?: { [key: string]: unknown; icon?: { [key: string]: unknown; link?: ... | ...; title?: ... | ...; url16x16?: ... | ...; }; status?: { [key: string]: unknown; icon?: ... | ...; resolved?: ... | ... | ...; }; summary?: string; title: string; url: string; }; relationship?: string; self?: string; } | object[]>
issueRemoteLinks.updateRemoteIssueLink
ts
updateRemoteIssueLink: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { application?: { [key: string]: unknown; name?: string; type?: string; }; globalId?: string; issueIdOrKey: string; linkId: string; object?: { [key: string]: unknown; icon?: { [key: string]: unknown; link?: string; title?: string; url16x16?: string; }; status?: { [key: string]: unknown; icon?: { [key: string]: unknown; link?: ... | ...; title?: ... | ...; url16x16?: ... | ...; }; resolved?: boolean; }; summary?: string; title: string; url: string; }; relationship?: string; } | - |
parameters.application? | { [key: string]: unknown; name?: string; type?: string; } | - |
parameters.application.name? | string | The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last. |
parameters.application.type? | string | The name-spaced type of the application, used by registered rendering apps. |
parameters.globalId? | string | An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123. Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID. The maximum length is 255 characters. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.linkId | string | The ID of the remote issue link. |
parameters.object? | { [key: string]: unknown; icon?: { [key: string]: unknown; link?: string; title?: string; url16x16?: string; }; status?: { [key: string]: unknown; icon?: { [key: string]: unknown; link?: ... | ...; title?: ... | ...; url16x16?: ... | ...; }; resolved?: boolean; }; summary?: string; title: string; url: string; } | - |
parameters.object.icon? | { [key: string]: unknown; link?: string; title?: string; url16x16?: string; } | - |
parameters.object.icon.link? | string | The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable. |
parameters.object.icon.title? | string | The title of the icon. This is used as follows: - For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. - For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". |
parameters.object.icon.url16x16? | string | The URL of an icon that displays at 16x16 pixel in Jira. |
parameters.object.status? | { [key: string]: unknown; icon?: { [key: string]: unknown; link?: ... | ...; title?: ... | ...; url16x16?: ... | ...; }; resolved?: boolean; } | - |
parameters.object.status.icon? | { [key: string]: unknown; link?: ... | ...; title?: ... | ...; url16x16?: ... | ...; } | - |
parameters.object.status.icon.link? | ... | ... | The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable. |
parameters.object.status.icon.title? | ... | ... | The title of the icon. This is used as follows: - For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. - For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". |
parameters.object.status.icon.url16x16? | ... | ... | The URL of an icon that displays at 16x16 pixel in Jira. |
parameters.object.status.resolved? | boolean | Whether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font. |
parameters.object.summary? | string | The summary details of the item. |
parameters.object.title | string | The title of the item. |
parameters.object.url | string | The URL of the item. |
parameters.relationship? | string | Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira. |
Returns
Promise<void>
issueResolutions
ts
issueResolutions: object;issueResolutions.getResolution
ts
getResolution: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
id?: string;
name?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the issue resolution value. |
Returns
Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>
issues
ts
issues: object;issues.assignIssue
ts
assignIssue: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { 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; issueIdOrKey: string; locale?: string; self?: string; timeZone?: string; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.active? | boolean | Whether the user is active. |
parameters.applicationRoles? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.applicationRoles.callback? | { [key: string]: unknown; } | - |
parameters.applicationRoles.items? | object[] | - |
parameters.applicationRoles.max-results? | number | - |
parameters.applicationRoles.pagingCallback? | { [key: string]: unknown; } | - |
parameters.applicationRoles.size? | number | - |
parameters.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.expand? | string | Expand options that include additional user details in the response. |
parameters.groups? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.groups.callback? | { [key: string]: unknown; } | - |
parameters.groups.items? | object[] | - |
parameters.groups.max-results? | number | - |
parameters.groups.pagingCallback? | { [key: string]: unknown; } | - |
parameters.groups.size? | number | - |
parameters.guest? | boolean | Whether the user is a guest. |
parameters.issueIdOrKey | string | The ID or key of the issue to be assigned. |
parameters.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.self? | string | The URL of the user. |
parameters.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
Returns
Promise<void>
issues.bulkFetchIssues
ts
bulkFetchIssues: (parameters) => Promise<{
[key: string]: unknown;
issueErrors?: object[];
issues?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: string[]; fields?: string[]; fieldsByKeys?: boolean; issueIdsOrKeys: string[]; properties?: string[]; } | - |
parameters.expand? | string[] | Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a list of values. The expand options are: - renderedFields Returns field values rendered in HTML format. - names Returns the display name of each field. - schema Returns the schema describing a field type. - transitions Returns all possible transitions for the issue. - operations Returns all possible operations for the issue. - editmeta Returns information about how each field can be edited. - changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. This returns a maximum of 40 changelogs. If you require more, please refer to Bulk fetch changelogs. - versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version. |
parameters.fields? | string[] | A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: - *all Returns all fields. - *navigable Returns navigable fields. - Any issue field, prefixed with a minus to exclude. The default is *navigable. Examples: - summary,comment Returns the summary and comments fields only. - -description Returns all navigable (default) fields except description. - *all,-comment Returns all fields except comments. Multiple fields parameters can be included in a request. Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields. |
parameters.fieldsByKeys? | boolean | Reference fields by their key (rather than ID). The default is false. |
parameters.issueIdsOrKeys | string[] | An array of issue IDs or issue keys to fetch. You can mix issue IDs and keys in the same query. |
parameters.properties? | string[] | A list of issue property keys of issue properties to be included in the results. A maximum of 5 issue property keys can be specified. |
Returns
Promise<{ [key: string]: unknown; issueErrors?: object[]; issues?: object[]; }>
issues.createIssue
ts
createIssue: (parameters) => Promise<{
[key: string]: unknown;
id: string;
key: string;
self: string;
transition?: {
[key: string]: unknown;
errorCollection?: {
[key: string]: unknown;
errorMessages?: ...[];
errors?: Record<..., ...>;
status?: number;
};
status?: number;
warningCollection?: {
[key: string]: unknown;
warnings?: ...[];
};
};
watchers?: {
[key: string]: unknown;
errorCollection?: {
[key: string]: unknown;
errorMessages?: ...[];
errors?: Record<..., ...>;
status?: number;
};
status?: number;
warningCollection?: {
[key: string]: unknown;
warnings?: ...[];
};
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fields?: Record<string, any>; historyMetadata?: { [key: string]: unknown; activityDescription?: string; activityDescriptionKey?: string; actor?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, any>; generator?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }; properties?: object[]; transition?: { [key: string]: unknown; expand?: string; fields?: Record<string, any>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; }; update?: Record<string, any>; updateHistory?: boolean; } | - |
parameters.fields? | Record<string, any> | List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update. |
parameters.historyMetadata? | { [key: string]: unknown; activityDescription?: string; activityDescriptionKey?: string; actor?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, any>; generator?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; } | - |
parameters.historyMetadata.activityDescription? | string | The activity described in the history record. |
parameters.historyMetadata.activityDescriptionKey? | string | The key of the activity described in the history record. |
parameters.historyMetadata.actor? | { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; } | - |
parameters.historyMetadata.actor.avatarUrl? | string | The URL to an avatar for the user or system associated with a history record. |
parameters.historyMetadata.actor.displayName? | string | The display name of the user or system associated with a history record. |
parameters.historyMetadata.actor.displayNameKey? | string | The key of the display name of the user or system associated with a history record. |
parameters.historyMetadata.actor.id? | string | The ID of the user or system associated with a history record. |
parameters.historyMetadata.actor.type? | string | The type of the user or system associated with a history record. |
parameters.historyMetadata.actor.url? | string | The URL of the user or system associated with a history record. |
parameters.historyMetadata.cause? | { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; } | - |
parameters.historyMetadata.cause.avatarUrl? | string | The URL to an avatar for the user or system associated with a history record. |
parameters.historyMetadata.cause.displayName? | string | The display name of the user or system associated with a history record. |
parameters.historyMetadata.cause.displayNameKey? | string | The key of the display name of the user or system associated with a history record. |
parameters.historyMetadata.cause.id? | string | The ID of the user or system associated with a history record. |
parameters.historyMetadata.cause.type? | string | The type of the user or system associated with a history record. |
parameters.historyMetadata.cause.url? | string | The URL of the user or system associated with a history record. |
parameters.historyMetadata.description? | string | The description of the history record. |
parameters.historyMetadata.descriptionKey? | string | The description key of the history record. |
parameters.historyMetadata.emailDescription? | string | The description of the email address associated the history record. |
parameters.historyMetadata.emailDescriptionKey? | string | The description key of the email address associated the history record. |
parameters.historyMetadata.extraData? | Record<string, any> | Additional arbitrary information about the history record. |
parameters.historyMetadata.generator? | { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; } | - |
parameters.historyMetadata.generator.avatarUrl? | string | The URL to an avatar for the user or system associated with a history record. |
parameters.historyMetadata.generator.displayName? | string | The display name of the user or system associated with a history record. |
parameters.historyMetadata.generator.displayNameKey? | string | The key of the display name of the user or system associated with a history record. |
parameters.historyMetadata.generator.id? | string | The ID of the user or system associated with a history record. |
parameters.historyMetadata.generator.type? | string | The type of the user or system associated with a history record. |
parameters.historyMetadata.generator.url? | string | The URL of the user or system associated with a history record. |
parameters.historyMetadata.type? | string | The type of the history record. |
parameters.properties? | object[] | Details of issue properties to be add or update. |
parameters.transition? | { [key: string]: unknown; expand?: string; fields?: Record<string, any>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; } | - |
parameters.transition.expand? | string | Expand options that include additional transition details in the response. |
parameters.transition.fields? | Record<string, any> | Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request. |
parameters.transition.hasScreen? | boolean | Whether there is a screen associated with the issue transition. |
parameters.transition.id? | string | The ID of the issue transition. Required when specifying a transition to undertake. |
parameters.transition.isAvailable? | boolean | Whether the transition is available to be performed. |
parameters.transition.isConditional? | boolean | Whether the issue has to meet criteria before the issue transition is applied. |
parameters.transition.isGlobal? | boolean | Whether the issue transition is global, that is, the transition is applied to issues regardless of their status. |
parameters.transition.isInitial? | boolean | Whether this is the initial issue transition for the workflow. |
parameters.transition.looped? | boolean | - |
parameters.transition.name? | string | The name of the issue transition. |
parameters.transition.to? | { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; } | - |
parameters.transition.to.description? | string | The description of the status. |
parameters.transition.to.iconUrl? | string | The URL of the icon used to represent the status. |
parameters.transition.to.id? | string | The ID of the status. |
parameters.transition.to.name? | string | The name of the status. |
parameters.transition.to.scope? | { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.transition.to.scope.project? | ... | ... | - |
parameters.transition.to.scope.type? | ... | ... | ... | ... | The type of scope. |
parameters.transition.to.self? | string | The URL of the status. |
parameters.transition.to.statusCategory? | { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; } | - |
parameters.transition.to.statusCategory.colorName? | ... | ... | The name of the color used to represent the status category. |
parameters.transition.to.statusCategory.id? | ... | ... | The ID of the status category. |
parameters.transition.to.statusCategory.key? | ... | ... | The key of the status category. |
parameters.transition.to.statusCategory.name? | ... | ... | The name of the status category. |
parameters.transition.to.statusCategory.self? | ... | ... | The URL of the status category. |
parameters.transition.to.untranslatedName? | string | - |
parameters.update? | Record<string, any> | A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields. |
parameters.updateHistory? | boolean | Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen. |
Returns
Promise<{ [key: string]: unknown; id: string; key: string; self: string; transition?: { [key: string]: unknown; errorCollection?: { [key: string]: unknown; errorMessages?: ...[]; errors?: Record<..., ...>; status?: number; }; status?: number; warningCollection?: { [key: string]: unknown; warnings?: ...[]; }; }; watchers?: { [key: string]: unknown; errorCollection?: { [key: string]: unknown; errorMessages?: ...[]; errors?: Record<..., ...>; status?: number; }; status?: number; warningCollection?: { [key: string]: unknown; warnings?: ...[]; }; }; }>
issues.createIssues
ts
createIssues: (parameters) => Promise<{
[key: string]: unknown;
errors?: object[];
issues?: object[];
}>;Parameters
| Parameter | Type |
|---|---|
parameters | { issueUpdates?: object[]; } |
parameters.issueUpdates? | object[] |
Returns
Promise<{ [key: string]: unknown; errors?: object[]; issues?: object[]; }>
issues.deleteIssue
ts
deleteIssue: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { deleteSubtasks?: "false" | "true" | string & object; issueIdOrKey: string; } | - |
parameters.deleteSubtasks? | "false" | "true" | string & object | Whether the issue's subtasks are deleted when the issue is deleted. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<void>
issues.doTransition
ts
doTransition: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fields?: Record<string, any>; historyMetadata?: { [key: string]: unknown; activityDescription?: string; activityDescriptionKey?: string; actor?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, any>; generator?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }; issueIdOrKey: string; properties?: object[]; transition?: { [key: string]: unknown; expand?: string; fields?: Record<string, any>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; }; update?: Record<string, any>; } | - |
parameters.fields? | Record<string, any> | List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update. |
parameters.historyMetadata? | { [key: string]: unknown; activityDescription?: string; activityDescriptionKey?: string; actor?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, any>; generator?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; } | - |
parameters.historyMetadata.activityDescription? | string | The activity described in the history record. |
parameters.historyMetadata.activityDescriptionKey? | string | The key of the activity described in the history record. |
parameters.historyMetadata.actor? | { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; } | - |
parameters.historyMetadata.actor.avatarUrl? | string | The URL to an avatar for the user or system associated with a history record. |
parameters.historyMetadata.actor.displayName? | string | The display name of the user or system associated with a history record. |
parameters.historyMetadata.actor.displayNameKey? | string | The key of the display name of the user or system associated with a history record. |
parameters.historyMetadata.actor.id? | string | The ID of the user or system associated with a history record. |
parameters.historyMetadata.actor.type? | string | The type of the user or system associated with a history record. |
parameters.historyMetadata.actor.url? | string | The URL of the user or system associated with a history record. |
parameters.historyMetadata.cause? | { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; } | - |
parameters.historyMetadata.cause.avatarUrl? | string | The URL to an avatar for the user or system associated with a history record. |
parameters.historyMetadata.cause.displayName? | string | The display name of the user or system associated with a history record. |
parameters.historyMetadata.cause.displayNameKey? | string | The key of the display name of the user or system associated with a history record. |
parameters.historyMetadata.cause.id? | string | The ID of the user or system associated with a history record. |
parameters.historyMetadata.cause.type? | string | The type of the user or system associated with a history record. |
parameters.historyMetadata.cause.url? | string | The URL of the user or system associated with a history record. |
parameters.historyMetadata.description? | string | The description of the history record. |
parameters.historyMetadata.descriptionKey? | string | The description key of the history record. |
parameters.historyMetadata.emailDescription? | string | The description of the email address associated the history record. |
parameters.historyMetadata.emailDescriptionKey? | string | The description key of the email address associated the history record. |
parameters.historyMetadata.extraData? | Record<string, any> | Additional arbitrary information about the history record. |
parameters.historyMetadata.generator? | { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; } | - |
parameters.historyMetadata.generator.avatarUrl? | string | The URL to an avatar for the user or system associated with a history record. |
parameters.historyMetadata.generator.displayName? | string | The display name of the user or system associated with a history record. |
parameters.historyMetadata.generator.displayNameKey? | string | The key of the display name of the user or system associated with a history record. |
parameters.historyMetadata.generator.id? | string | The ID of the user or system associated with a history record. |
parameters.historyMetadata.generator.type? | string | The type of the user or system associated with a history record. |
parameters.historyMetadata.generator.url? | string | The URL of the user or system associated with a history record. |
parameters.historyMetadata.type? | string | The type of the history record. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.properties? | object[] | Details of issue properties to be add or update. |
parameters.transition? | { [key: string]: unknown; expand?: string; fields?: Record<string, any>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; } | - |
parameters.transition.expand? | string | Expand options that include additional transition details in the response. |
parameters.transition.fields? | Record<string, any> | Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request. |
parameters.transition.hasScreen? | boolean | Whether there is a screen associated with the issue transition. |
parameters.transition.id? | string | The ID of the issue transition. Required when specifying a transition to undertake. |
parameters.transition.isAvailable? | boolean | Whether the transition is available to be performed. |
parameters.transition.isConditional? | boolean | Whether the issue has to meet criteria before the issue transition is applied. |
parameters.transition.isGlobal? | boolean | Whether the issue transition is global, that is, the transition is applied to issues regardless of their status. |
parameters.transition.isInitial? | boolean | Whether this is the initial issue transition for the workflow. |
parameters.transition.looped? | boolean | - |
parameters.transition.name? | string | The name of the issue transition. |
parameters.transition.to? | { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; } | - |
parameters.transition.to.description? | string | The description of the status. |
parameters.transition.to.iconUrl? | string | The URL of the icon used to represent the status. |
parameters.transition.to.id? | string | The ID of the status. |
parameters.transition.to.name? | string | The name of the status. |
parameters.transition.to.scope? | { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.transition.to.scope.project? | ... | ... | - |
parameters.transition.to.scope.type? | ... | ... | ... | ... | The type of scope. |
parameters.transition.to.self? | string | The URL of the status. |
parameters.transition.to.statusCategory? | { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; } | - |
parameters.transition.to.statusCategory.colorName? | ... | ... | The name of the color used to represent the status category. |
parameters.transition.to.statusCategory.id? | ... | ... | The ID of the status category. |
parameters.transition.to.statusCategory.key? | ... | ... | The key of the status category. |
parameters.transition.to.statusCategory.name? | ... | ... | The name of the status category. |
parameters.transition.to.statusCategory.self? | ... | ... | The URL of the status category. |
parameters.transition.to.untranslatedName? | string | - |
parameters.update? | Record<string, any> | A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields. |
Returns
Promise<void>
issues.editIssue
ts
editIssue: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: string; fields?: Record<string, any>; historyMetadata?: { [key: string]: unknown; activityDescription?: string; activityDescriptionKey?: string; actor?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, any>; generator?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }; issueIdOrKey: string; notifyUsers?: boolean; overrideEditableFlag?: boolean; overrideScreenSecurity?: boolean; properties?: object[]; returnIssue?: boolean; transition?: { [key: string]: unknown; expand?: string; fields?: Record<string, any>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; }; update?: Record<string, any>; } | - |
parameters.expand? | string | The Get issue API expand parameter to use in the response if the returnIssue parameter is true. |
parameters.fields? | Record<string, any> | List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update. |
parameters.historyMetadata? | { [key: string]: unknown; activityDescription?: string; activityDescriptionKey?: string; actor?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, any>; generator?: { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; } | - |
parameters.historyMetadata.activityDescription? | string | The activity described in the history record. |
parameters.historyMetadata.activityDescriptionKey? | string | The key of the activity described in the history record. |
parameters.historyMetadata.actor? | { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; } | - |
parameters.historyMetadata.actor.avatarUrl? | string | The URL to an avatar for the user or system associated with a history record. |
parameters.historyMetadata.actor.displayName? | string | The display name of the user or system associated with a history record. |
parameters.historyMetadata.actor.displayNameKey? | string | The key of the display name of the user or system associated with a history record. |
parameters.historyMetadata.actor.id? | string | The ID of the user or system associated with a history record. |
parameters.historyMetadata.actor.type? | string | The type of the user or system associated with a history record. |
parameters.historyMetadata.actor.url? | string | The URL of the user or system associated with a history record. |
parameters.historyMetadata.cause? | { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; } | - |
parameters.historyMetadata.cause.avatarUrl? | string | The URL to an avatar for the user or system associated with a history record. |
parameters.historyMetadata.cause.displayName? | string | The display name of the user or system associated with a history record. |
parameters.historyMetadata.cause.displayNameKey? | string | The key of the display name of the user or system associated with a history record. |
parameters.historyMetadata.cause.id? | string | The ID of the user or system associated with a history record. |
parameters.historyMetadata.cause.type? | string | The type of the user or system associated with a history record. |
parameters.historyMetadata.cause.url? | string | The URL of the user or system associated with a history record. |
parameters.historyMetadata.description? | string | The description of the history record. |
parameters.historyMetadata.descriptionKey? | string | The description key of the history record. |
parameters.historyMetadata.emailDescription? | string | The description of the email address associated the history record. |
parameters.historyMetadata.emailDescriptionKey? | string | The description key of the email address associated the history record. |
parameters.historyMetadata.extraData? | Record<string, any> | Additional arbitrary information about the history record. |
parameters.historyMetadata.generator? | { [key: string]: unknown; avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; } | - |
parameters.historyMetadata.generator.avatarUrl? | string | The URL to an avatar for the user or system associated with a history record. |
parameters.historyMetadata.generator.displayName? | string | The display name of the user or system associated with a history record. |
parameters.historyMetadata.generator.displayNameKey? | string | The key of the display name of the user or system associated with a history record. |
parameters.historyMetadata.generator.id? | string | The ID of the user or system associated with a history record. |
parameters.historyMetadata.generator.type? | string | The type of the user or system associated with a history record. |
parameters.historyMetadata.generator.url? | string | The URL of the user or system associated with a history record. |
parameters.historyMetadata.type? | string | The type of the history record. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.notifyUsers? | boolean | Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored. |
parameters.overrideEditableFlag? | boolean | Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission. |
parameters.overrideScreenSecurity? | boolean | Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission. |
parameters.properties? | object[] | Details of issue properties to be add or update. |
parameters.returnIssue? | boolean | Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the Get issue API. |
parameters.transition? | { [key: string]: unknown; expand?: string; fields?: Record<string, any>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; } | - |
parameters.transition.expand? | string | Expand options that include additional transition details in the response. |
parameters.transition.fields? | Record<string, any> | Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request. |
parameters.transition.hasScreen? | boolean | Whether there is a screen associated with the issue transition. |
parameters.transition.id? | string | The ID of the issue transition. Required when specifying a transition to undertake. |
parameters.transition.isAvailable? | boolean | Whether the transition is available to be performed. |
parameters.transition.isConditional? | boolean | Whether the issue has to meet criteria before the issue transition is applied. |
parameters.transition.isGlobal? | boolean | Whether the issue transition is global, that is, the transition is applied to issues regardless of their status. |
parameters.transition.isInitial? | boolean | Whether this is the initial issue transition for the workflow. |
parameters.transition.looped? | boolean | - |
parameters.transition.name? | string | The name of the issue transition. |
parameters.transition.to? | { [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; } | - |
parameters.transition.to.description? | string | The description of the status. |
parameters.transition.to.iconUrl? | string | The URL of the icon used to represent the status. |
parameters.transition.to.id? | string | The ID of the status. |
parameters.transition.to.name? | string | The name of the status. |
parameters.transition.to.scope? | { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.transition.to.scope.project? | ... | ... | - |
parameters.transition.to.scope.type? | ... | ... | ... | ... | The type of scope. |
parameters.transition.to.self? | string | The URL of the status. |
parameters.transition.to.statusCategory? | { [key: string]: unknown; colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; } | - |
parameters.transition.to.statusCategory.colorName? | ... | ... | The name of the color used to represent the status category. |
parameters.transition.to.statusCategory.id? | ... | ... | The ID of the status category. |
parameters.transition.to.statusCategory.key? | ... | ... | The key of the status category. |
parameters.transition.to.statusCategory.name? | ... | ... | The name of the status category. |
parameters.transition.to.statusCategory.self? | ... | ... | The URL of the status category. |
parameters.transition.to.untranslatedName? | string | - |
parameters.update? | Record<string, any> | A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields. |
Returns
Promise<void>
issues.getBulkChangelogs
ts
getBulkChangelogs: (parameters) => Promise<{
[key: string]: unknown;
issueChangeLogs?: object[];
nextPageToken?: string | null;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldIds?: string[]; issueIdsOrKeys: string[]; maxResults?: number; nextPageToken?: string; } | - |
parameters.fieldIds? | string[] | List of field IDs to filter changelogs |
parameters.issueIdsOrKeys | string[] | List of issue IDs/keys to fetch changelogs for |
parameters.maxResults? | number | The maximum number of items to return per page |
parameters.nextPageToken? | string | The cursor for pagination |
Returns
Promise<{ [key: string]: unknown; issueChangeLogs?: object[]; nextPageToken?: string | null; }>
issues.getChangeLogs
ts
getChangeLogs: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; maxResults?: number; startAt?: number; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issues.getChangeLogsByIds
ts
getChangeLogsByIds: (parameters) => Promise<{
[key: string]: unknown;
histories?: object[];
maxResults?: number;
startAt?: number;
total?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { changelogIds: number[]; issueIdOrKey: string; } | - |
parameters.changelogIds | number[] | The list of changelog IDs. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<{ [key: string]: unknown; histories?: object[]; maxResults?: number; startAt?: number; total?: number; }>
issues.getCreateIssueMetaIssueTypeId
ts
getCreateIssueMetaIssueTypeId: (parameters) => Promise<{
[key: string]: unknown;
fields?: object[];
maxResults?: number;
results?: object[];
startAt?: number;
total?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeId: string; maxResults?: number; projectIdOrKey: string; startAt?: number; } | - |
parameters.issueTypeId | string | The issuetype ID. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectIdOrKey | string | The ID or key of the project. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; fields?: object[]; maxResults?: number; results?: object[]; startAt?: number; total?: number; }>
issues.getCreateIssueMetaIssueTypes
ts
getCreateIssueMetaIssueTypes: (parameters) => Promise<{
[key: string]: unknown;
createMetaIssueType?: object[];
issueTypes?: object[];
maxResults?: number;
startAt?: number;
total?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; projectIdOrKey: string; startAt?: number; } | - |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectIdOrKey | string | The ID or key of the project. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; createMetaIssueType?: object[]; issueTypes?: object[]; maxResults?: number; startAt?: number; total?: number; }>
issues.getEditIssueMeta
ts
getEditIssueMeta: (parameters) => Promise<{
[key: string]: unknown;
fields?: Record<string, any>;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; overrideEditableFlag?: boolean; overrideScreenSecurity?: boolean; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.overrideEditableFlag? | boolean | Whether non-editable fields are returned. Available to Connect and Forge app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission. |
parameters.overrideScreenSecurity? | boolean | Whether hidden fields are returned. Available to Connect and Forge app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission. |
Returns
Promise<{ [key: string]: unknown; fields?: Record<string, any>; }>
issues.getIssue
ts
getIssue: (parameters) => Promise<{
[key: string]: unknown;
changelog?: {
[key: string]: unknown;
histories?: object[];
maxResults?: number;
startAt?: number;
total?: number;
};
editmeta?: {
[key: string]: unknown;
fields?: Record<string, any>;
};
expand?: string;
fields?: Record<string, any>;
fieldsToInclude?: {
[key: string]: unknown;
actuallyIncluded?: string[];
excluded?: string[];
included?: string[];
};
id?: string;
key?: string;
names?: Record<string, any>;
operations?: {
[key: string]: unknown;
linkGroups?: LinkGroup[];
};
properties?: Record<string, any>;
renderedFields?: Record<string, any>;
schema?: Record<string, any>;
self?: string;
transitions?: object[];
versionedRepresentations?: Record<string, any>;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | string & object | "schema" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations")[]; failFast?: boolean; fields?: string[]; fieldsByKeys?: boolean; issueIdOrKey: string; properties?: string[]; updateHistory?: boolean; } | - |
parameters.expand? | | string | string[] | string & object | ( | string & object | "schema" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations")[] | Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: - renderedFields Returns field values rendered in HTML format. - names Returns the display name of each field. - schema Returns the schema describing a field type. - transitions Returns all possible transitions for the issue. - editmeta Returns information about how each field can be edited. - changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. - versionedRepresentations Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored. |
parameters.failFast? | boolean | Whether to fail the request quickly in case of an error while loading fields for an issue. For failFast=true, if one field fails, the entire operation fails. For failFast=false, the operation will continue even if a field fails. It will return a valid response, but without values for the failed field(s). |
parameters.fields? | string[] | A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: - *all Returns all fields. - *navigable Returns navigable fields. - Any issue field, prefixed with a minus to exclude. Examples: - summary,comment Returns only the summary and comments fields. - -description Returns all (default) fields except description. - *navigable,-comment Returns all navigable fields except comment. This parameter may be specified multiple times. For example, fields=field1,field2& fields=field3. Note: All fields are returned by default. This differs from Search for issues using JQL (GET) and Search for issues using JQL (POST) where the default is all navigable fields. |
parameters.fieldsByKeys? | boolean | Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.properties? | string[] | A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: - *all Returns all issue properties. - Any issue property key, prefixed with a minus to exclude. Examples: - *all Returns all properties. - *all,-prop1 Returns all properties except prop1. - prop1,prop2 Returns prop1 and prop2 properties. This parameter may be specified multiple times. For example, properties=prop1,prop2& properties=prop3. |
parameters.updateHistory? | boolean | Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. This also populates the JQL issues search lastViewed field. |
Returns
Promise<{ [key: string]: unknown; changelog?: { [key: string]: unknown; histories?: object[]; maxResults?: number; startAt?: number; total?: number; }; editmeta?: { [key: string]: unknown; fields?: Record<string, any>; }; expand?: string; fields?: Record<string, any>; fieldsToInclude?: { [key: string]: unknown; actuallyIncluded?: string[]; excluded?: string[]; included?: string[]; }; id?: string; key?: string; names?: Record<string, any>; operations?: { [key: string]: unknown; linkGroups?: LinkGroup[]; }; properties?: Record<string, any>; renderedFields?: Record<string, any>; schema?: Record<string, any>; self?: string; transitions?: object[]; versionedRepresentations?: Record<string, any>; }>
issues.getTransitions
ts
getTransitions: (parameters) => Promise<{
[key: string]: unknown;
expand?: string;
transitions?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | (string & object | "transitions.fields")[]; includeUnavailableTransitions?: boolean; issueIdOrKey: string; skipRemoteOnlyCondition?: boolean; sortByOpsBarAndStatus?: boolean; transitionId?: string; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "transitions.fields")[] | Use expand to include additional information about transitions in the response. This parameter accepts transitions.fields, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in Transition issue. |
parameters.includeUnavailableTransitions? | boolean | Whether details of transitions that fail a condition are included in the response |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.skipRemoteOnlyCondition? | boolean | Whether transitions with the condition Hide From User Condition are included in the response. Available to Connect and Forge app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission. |
parameters.sortByOpsBarAndStatus? | boolean | Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value. |
parameters.transitionId? | string | The ID of the transition. |
Returns
Promise<{ [key: string]: unknown; expand?: string; transitions?: object[]; }>
issues.notify
ts
notify: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { htmlBody?: string; issueIdOrKey: string; restrict?: { [key: string]: unknown; groupIds?: string[]; groups?: object[]; permissions?: object[]; }; subject?: string; textBody?: string; to?: { [key: string]: unknown; assignee?: boolean; groupIds?: string[]; groups?: object[]; reporter?: boolean; users?: object[]; voters?: boolean; watchers?: boolean; }; } | - |
parameters.htmlBody? | string | The HTML body of the email notification for the issue. |
parameters.issueIdOrKey | string | ID or key of the issue that the notification is sent for. |
parameters.restrict? | { [key: string]: unknown; groupIds?: string[]; groups?: object[]; permissions?: object[]; } | - |
parameters.restrict.groupIds? | string[] | List of groupId memberships required to receive the notification. |
parameters.restrict.groups? | object[] | List of group memberships required to receive the notification. |
parameters.restrict.permissions? | object[] | List of permissions required to receive the notification. |
parameters.subject? | string | The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary. |
parameters.textBody? | string | The plain text body of the email notification for the issue. |
parameters.to? | { [key: string]: unknown; assignee?: boolean; groupIds?: string[]; groups?: object[]; reporter?: boolean; users?: object[]; voters?: boolean; watchers?: boolean; } | - |
parameters.to.assignee? | boolean | Whether the notification should be sent to the issue's assignees. |
parameters.to.groupIds? | string[] | List of groupIds to receive the notification. |
parameters.to.groups? | object[] | List of groups to receive the notification. |
parameters.to.reporter? | boolean | Whether the notification should be sent to the issue's reporter. |
parameters.to.users? | object[] | List of users to receive the notification. |
parameters.to.voters? | boolean | Whether the notification should be sent to the issue's voters. |
parameters.to.watchers? | boolean | Whether the notification should be sent to the issue's watchers. |
Returns
Promise<void>
issueSearch
ts
issueSearch: object;issueSearch.countIssues
ts
countIssues: (parameters) => Promise<{
[key: string]: unknown;
count?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { jql?: string; } | - |
parameters.jql? | string | A JQL expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. |
Returns
Promise<{ [key: string]: unknown; count?: number; }>
issueSearch.getIssuePickerResource
ts
getIssuePickerResource: (parameters?) => Promise<{
[key: string]: unknown;
sections?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { currentIssueKey?: string; currentJQL?: string; currentProjectId?: string; query?: string; showSubTaskParent?: boolean; showSubTasks?: boolean; } | - |
parameters.currentIssueKey? | string | The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query. |
parameters.currentJQL? | string | A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead. |
parameters.currentProjectId? | string | The ID of a project that suggested issues must belong to. |
parameters.query? | string | A string to match against text fields in the issue such as title, description, or comments. |
parameters.showSubTaskParent? | boolean | When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query. |
parameters.showSubTasks? | boolean | Indicate whether to include subtasks in the suggestions list. |
Returns
Promise<{ [key: string]: unknown; sections?: object[]; }>
issueSearch.matchIssues
ts
matchIssues: (parameters) => Promise<{
[key: string]: unknown;
matches: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIds: number[]; jqls: string[]; } | - |
parameters.issueIds | number[] | A list of issue IDs. |
parameters.jqls | string[] | A list of JQL queries. |
Returns
Promise<{ [key: string]: unknown; matches: object[]; }>
issueSearch.searchAndReconsileIssuesUsingJql
ts
searchAndReconsileIssuesUsingJql: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
issues?: object[];
names?: Record<string, any>;
nextPageToken?: string | null;
schema?: Record<string, any>;
warnings?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | ( | string & object | "schema" | "operations" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations")[]; failFast?: boolean; fields?: string[]; fieldsByKeys?: boolean; jql?: string; maxResults?: number; nextPageToken?: string; properties?: string[]; reconcileIssues?: number[]; } | - |
parameters.expand? | | string | string[] | string & object | ( | string & object | "schema" | "operations" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations")[] | Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a comma-delimited string of values. The expand options are: - renderedFields Returns field values rendered in HTML format. - names Returns the display name of each field. - schema Returns the schema describing a field type. - transitions Returns all possible transitions for the issue. - operations Returns all possible operations for the issue. - editmeta Returns information about how each field can be edited. - changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. - versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version. Examples: "names,changelog" Returns the display name of each field as well as a list of recent updates to an issue. |
parameters.failFast? | boolean | Fail this request early if we can't retrieve all field data. |
parameters.fields? | string[] | A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: - *all Returns all fields. - *navigable Returns navigable fields. - id Returns only issue IDs. - Any issue field, prefixed with a minus to exclude. The default is id. Examples: - summary,comment Returns only the summary and comments fields only. - -description Returns all navigable (default) fields except description. - *all,-comment Returns all fields except comments. Multiple fields parameters can be included in a request. Note: By default, this resource returns IDs only. This differs from GET issue where the default is all fields. |
parameters.fieldsByKeys? | boolean | Reference fields by their key (rather than ID). The default is false. |
parameters.jql? | string | A JQL expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. - Example of an unbounded query: order by key desc. - Example of a bounded query: assignee = currentUser() order by key. Additionally, orderBy clause can contain a maximum of 7 fields. |
parameters.maxResults? | number | The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields or properties are requested. The greatest number of items returned per page is achieved when requesting id or key only. It returns max 5000 issues. |
parameters.nextPageToken? | string | The token for a page to fetch that is not the first page. The first page has a nextPageToken of null. Use the nextPageToken to fetch the next page of issues. Note: The nextPageToken field is not included in the response for the last page, indicating there is no next page. |
parameters.properties? | string[] | A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. |
parameters.reconcileIssues? | number[] | Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. This list of ids should be consistent with each paginated request across different pages. |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; issues?: object[]; names?: Record<string, any>; nextPageToken?: string | null; schema?: Record<string, any>; warnings?: object[]; }>
issueSearch.searchAndReconsileIssuesUsingJqlPost
ts
searchAndReconsileIssuesUsingJqlPost: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
issues?: object[];
names?: Record<string, any>;
nextPageToken?: string | null;
schema?: Record<string, any>;
warnings?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: string; fields?: string[]; fieldsByKeys?: boolean; jql?: string; maxResults?: number; nextPageToken?: string; properties?: string[]; reconcileIssues?: number[]; } | - |
parameters.expand? | string | Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a comma-delimited string of values. The expand options are: - renderedFields Returns field values rendered in HTML format. - names Returns the display name of each field. - schema Returns the schema describing a field type. - transitions Returns all possible transitions for the issue. - operations Returns all possible operations for the issue. - editmeta Returns information about how each field can be edited. - changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. - versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version. Examples: "names,changelog" Returns the display name of each field as well as a list of recent updates to an issue. |
parameters.fields? | string[] | A list of fields to return for each issue. Use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: - *all Returns all fields. - *navigable Returns navigable fields. - id Returns only issue IDs. - Any issue field, prefixed with a dash to exclude. The default is id. Examples: - summary,comment Returns the summary and comments fields only. - *all,-comment Returns all fields except comments. Multiple fields parameters can be included in a request. Note: By default, this resource returns IDs only. This differs from GET issue where the default is all fields. |
parameters.fieldsByKeys? | boolean | Reference fields by their key (rather than ID). The default is false. |
parameters.jql? | string | A JQL expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. - Example of an unbounded query: order by key desc. - Example of a bounded query: assignee = currentUser() order by key. Additionally, orderBy clause can contain a maximum of 7 fields. |
parameters.maxResults? | number | The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only. It returns max 5000 issues. |
parameters.nextPageToken? | string | The token for a page to fetch that is not the first page. The first page has a nextPageToken of null. Use the nextPageToken to fetch the next page of issues. |
parameters.properties? | string[] | A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. |
parameters.reconcileIssues? | number[] | Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. This list of ids should be consistent with each paginated request across different pages. |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; issues?: object[]; names?: Record<string, any>; nextPageToken?: string | null; schema?: Record<string, any>; warnings?: object[]; }>
issueSecurityLevel
ts
issueSecurityLevel: object;issueSecurityLevel.getIssueSecurityLevel
ts
getIssueSecurityLevel: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
id?: string;
isDefault?: boolean;
issueSecuritySchemeId?: string;
name?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the issue security level. |
Returns
Promise<{ [key: string]: unknown; description?: string; id?: string; isDefault?: boolean; issueSecuritySchemeId?: string; name?: string; self?: string; }>
issueSecurityLevel.getIssueSecurityLevelMembers
ts
getIssueSecurityLevelMembers: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ("all" | "user" | "group" | "field" | string & object | "projectRole")[]; issueSecurityLevelId?: string[]; issueSecuritySchemeId: number; maxResults?: number; startAt?: number; } | - |
parameters.expand? | | string | string[] | string & object | ("all" | "user" | "group" | "field" | string & object | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - all Returns all expandable information. - field Returns information about the custom field granted the permission. - group Returns information about the group that is granted the permission. - projectRole Returns information about the project role granted the permission. - user Returns information about the user who is granted the permission. |
parameters.issueSecurityLevelId? | string[] | The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: issueSecurityLevelId=10000&issueSecurityLevelId=10001. |
parameters.issueSecuritySchemeId | number | The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueSecuritySchemes
ts
issueSecuritySchemes: object;issueSecuritySchemes.getIssueSecurityScheme
ts
getIssueSecurityScheme: (parameters) => Promise<{
[key: string]: unknown;
defaultSecurityLevelId?: number;
description?: string;
id?: number;
levels?: object[];
name?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs. |
Returns
Promise<{ [key: string]: unknown; defaultSecurityLevelId?: number; description?: string; id?: number; levels?: object[]; name?: string; self?: string; }>
issueSecuritySchemes.getIssueSecuritySchemes
ts
getIssueSecuritySchemes: () => Promise<{
[key: string]: unknown;
issueSecuritySchemes?: object[];
}>;Returns
Promise<{ [key: string]: unknown; issueSecuritySchemes?: object[]; }>
issueTypeProperties
ts
issueTypeProperties: object;issueTypeProperties.deleteIssueTypeProperty
ts
deleteIssueTypeProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeId: string; propertyKey: string; } | - |
parameters.issueTypeId | string | The ID of the issue type. |
parameters.propertyKey | string | The key of the property. Use Get issue type property keys to get a list of all issue type property keys. |
Returns
Promise<void>
issueTypeProperties.getIssueTypeProperty
ts
getIssueTypeProperty: (parameters) => Promise<{
[key: string]: unknown;
key?: string;
value?: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeId: string; propertyKey: string; } | - |
parameters.issueTypeId | string | The ID of the issue type. |
parameters.propertyKey | string | The key of the property. Use Get issue type property keys to get a list of all issue type property keys. |
Returns
Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>
issueTypeProperties.getIssueTypePropertyKeys
ts
getIssueTypePropertyKeys: (parameters) => Promise<{
[key: string]: unknown;
keys?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeId: string; } | - |
parameters.issueTypeId | string | The ID of the issue type. |
Returns
Promise<{ [key: string]: unknown; keys?: object[]; }>
issueTypeProperties.setIssueTypeProperty
ts
setIssueTypeProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; issueTypeId: string; propertyKey: string; } | - |
parameters.body | Record<string, any> | - |
parameters.issueTypeId | string | The ID of the issue type. |
parameters.propertyKey | string | The key of the issue type property. The maximum length is 255 characters. |
Returns
Promise<void>
issueTypes
ts
issueTypes: object;issueTypes.createIssueType
ts
createIssueType: (parameters) => Promise<{
[key: string]: unknown;
avatarId?: number;
description?: string;
entityId?: string;
hierarchyLevel?: number;
iconUrl?: string;
id?: string;
name?: string;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
subtask?: boolean;
untranslatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; hierarchyLevel?: number; name: string; } | - |
parameters.description? | string | The description of the issue type. |
parameters.hierarchyLevel? | number | The hierarchy level of the issue type. Use: - -1 for Subtask. - 0 for Base. Defaults to 0. |
parameters.name | string | The unique name for the issue type. The maximum length is 60 characters. |
Returns
Promise<{ [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; subtask?: boolean; untranslatedName?: string; }>
issueTypes.createIssueTypeAvatar
ts
createIssueTypeAvatar: (parameters) => Promise<{
[key: string]: unknown;
fileName?: string;
id: string;
isDeletable?: boolean;
isSelected?: boolean;
isSystemAvatar?: boolean;
owner?: string;
urls?: Record<string, any>;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; id: string; size: number; x?: number; y?: number; } | - |
parameters.body | Record<string, any> | - |
parameters.id | string | The ID of the issue type. |
parameters.size | number | The length of each side of the crop region. |
parameters.x? | number | The X coordinate of the top-left corner of the crop region. |
parameters.y? | number | The Y coordinate of the top-left corner of the crop region. |
Returns
Promise<{ [key: string]: unknown; fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; urls?: Record<string, any>; }>
issueTypes.deleteIssueType
ts
deleteIssueType: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { alternativeIssueTypeId?: string; id: string; } | - |
parameters.alternativeIssueTypeId? | string | The ID of the replacement issue type. |
parameters.id | string | The ID of the issue type. |
Returns
Promise<void>
issueTypes.getAlternativeIssueTypes
ts
getAlternativeIssueTypes: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the issue type. |
Returns
Promise<object[]>
issueTypes.getIssueAllTypes
ts
getIssueAllTypes: () => Promise<object[]>;Returns
Promise<object[]>
issueTypes.getIssueType
ts
getIssueType: (parameters) => Promise<{
[key: string]: unknown;
avatarId?: number;
description?: string;
entityId?: string;
hierarchyLevel?: number;
iconUrl?: string;
id?: string;
name?: string;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
subtask?: boolean;
untranslatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the issue type. |
Returns
Promise<{ [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; subtask?: boolean; untranslatedName?: string; }>
issueTypes.updateIssueType
ts
updateIssueType: (parameters) => Promise<{
[key: string]: unknown;
avatarId?: number;
description?: string;
entityId?: string;
hierarchyLevel?: number;
iconUrl?: string;
id?: string;
name?: string;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
subtask?: boolean;
untranslatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { avatarId?: number; description?: string; id: string; name?: string; } | - |
parameters.avatarId? | number | The ID of an issue type avatar. This can be obtained be obtained from the following endpoints: - System issue type avatar IDs only - System and custom issue type avatar IDs |
parameters.description? | string | The description of the issue type. |
parameters.id | string | The ID of the issue type. |
parameters.name? | string | The unique name for the issue type. The maximum length is 60 characters. |
Returns
Promise<{ [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; subtask?: boolean; untranslatedName?: string; }>
issueTypeSchemes
ts
issueTypeSchemes: object;issueTypeSchemes.addIssueTypesToIssueTypeScheme
ts
addIssueTypesToIssueTypeScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeIds: string[]; issueTypeSchemeId: number; } | - |
parameters.issueTypeIds | string[] | The list of issue type IDs. |
parameters.issueTypeSchemeId | number | The ID of the issue type scheme. |
Returns
Promise<void>
issueTypeSchemes.assignIssueTypeSchemeToProject
ts
assignIssueTypeSchemeToProject: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeSchemeId: string; projectId: string; } | - |
parameters.issueTypeSchemeId | string | The ID of the issue type scheme. |
parameters.projectId | string | The ID of the project. |
Returns
Promise<void>
issueTypeSchemes.createIssueTypeScheme
ts
createIssueTypeScheme: (parameters) => Promise<{
[key: string]: unknown;
issueTypeSchemeId: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { defaultIssueTypeId?: string; description?: string; issueTypeIds: string[]; name: string; } | - |
parameters.defaultIssueTypeId? | string | The ID of the default issue type of the issue type scheme. This ID must be included in issueTypeIds. |
parameters.description? | string | The description of the issue type scheme. The maximum length is 4000 characters. |
parameters.issueTypeIds | string[] | The list of issue types IDs of the issue type scheme. At least one standard issue type ID is required. |
parameters.name | string | The name of the issue type scheme. The name must be unique. The maximum length is 255 characters. |
Returns
Promise<{ [key: string]: unknown; issueTypeSchemeId: string; }>
issueTypeSchemes.deleteIssueTypeScheme
ts
deleteIssueTypeScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeSchemeId: number; } | - |
parameters.issueTypeSchemeId | number | The ID of the issue type scheme. |
Returns
Promise<void>
issueTypeSchemes.getAllIssueTypeSchemes
ts
getAllIssueTypeSchemes: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | (string & object | "issueTypes" | "projects")[]; id?: number[]; maxResults?: number; orderBy?: "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"; queryString?: string; startAt?: number; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "issueTypes" | "projects")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - projects For each issue type schemes, returns information about the projects the issue type scheme is assigned to. - issueTypes For each issue type schemes, returns information about the issueTypes the issue type scheme have. |
parameters.id? | number[] | The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id" | Order the results by a field: - name Sorts by issue type scheme name. - id Sorts by issue type scheme ID. |
parameters.queryString? | string | String used to perform a case-insensitive partial match with issue type scheme name. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueTypeSchemes.getIssueTypeSchemeForProjects
ts
getIssueTypeSchemeForProjects: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; projectId: number[]; startAt?: number; } | - |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectId | number[] | The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, projectId=10000&projectId=10001. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueTypeSchemes.getIssueTypeSchemesMapping
ts
getIssueTypeSchemesMapping: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { issueTypeSchemeId?: number[]; maxResults?: number; startAt?: number; } | - |
parameters.issueTypeSchemeId? | number[] | The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, issueTypeSchemeId=10000&issueTypeSchemeId=10001. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueTypeSchemes.removeIssueTypeFromIssueTypeScheme
ts
removeIssueTypeFromIssueTypeScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeId: number; issueTypeSchemeId: number; } | - |
parameters.issueTypeId | number | The ID of the issue type. |
parameters.issueTypeSchemeId | number | The ID of the issue type scheme. |
Returns
Promise<void>
issueTypeSchemes.reorderIssueTypesInIssueTypeScheme
ts
reorderIssueTypesInIssueTypeScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { after?: string; issueTypeIds: string[]; issueTypeSchemeId: number; position?: string & object | "First" | "Last"; } | - |
parameters.after? | string | The ID of the issue type to place the moved issue types after. Required if position isn't provided. |
parameters.issueTypeIds | string[] | A list of the issue type IDs to move. The order of the issue type IDs in the list is the order they are given after the move. |
parameters.issueTypeSchemeId | number | The ID of the issue type scheme. |
parameters.position? | string & object | "First" | "Last" | The position the issue types should be moved to. Required if after isn't provided. |
Returns
Promise<void>
issueTypeSchemes.updateIssueTypeScheme
ts
updateIssueTypeScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { defaultIssueTypeId?: string; description?: string; issueTypeSchemeId: number; name?: string; } | - |
parameters.defaultIssueTypeId? | string | The ID of the default issue type of the issue type scheme. |
parameters.description? | string | The description of the issue type scheme. The maximum length is 4000 characters. |
parameters.issueTypeSchemeId | number | The ID of the issue type scheme. |
parameters.name? | string | The name of the issue type scheme. The name must be unique. The maximum length is 255 characters. |
Returns
Promise<void>
issueTypeScreenSchemes
ts
issueTypeScreenSchemes: object;issueTypeScreenSchemes.appendMappingsForIssueTypeScreenScheme
ts
appendMappingsForIssueTypeScreenScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeMappings: object[]; issueTypeScreenSchemeId: string; } | - |
parameters.issueTypeMappings | object[] | The list of issue type to screen scheme mappings. A default entry cannot be specified because a default entry is added when an issue type screen scheme is created. |
parameters.issueTypeScreenSchemeId | string | The ID of the issue type screen scheme. |
Returns
Promise<void>
issueTypeScreenSchemes.assignIssueTypeScreenSchemeToProject
ts
assignIssueTypeScreenSchemeToProject: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeScreenSchemeId?: string; projectId?: string; } | - |
parameters.issueTypeScreenSchemeId? | string | The ID of the issue type screen scheme. |
parameters.projectId? | string | The ID of the project. |
Returns
Promise<void>
issueTypeScreenSchemes.createIssueTypeScreenScheme
ts
createIssueTypeScreenScheme: (parameters) => Promise<{
[key: string]: unknown;
id: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; issueTypeMappings: object[]; name: string; } | - |
parameters.description? | string | The description of the issue type screen scheme. The maximum length is 255 characters. |
parameters.issueTypeMappings | object[] | The IDs of the screen schemes for the issue type IDs and default. A default entry is required to create an issue type screen scheme, it defines the mapping for all issue types without a screen scheme. |
parameters.name | string | The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters. |
Returns
Promise<{ [key: string]: unknown; id: string; }>
issueTypeScreenSchemes.deleteIssueTypeScreenScheme
ts
deleteIssueTypeScreenScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeScreenSchemeId: string; } | - |
parameters.issueTypeScreenSchemeId | string | The ID of the issue type screen scheme. |
Returns
Promise<void>
issueTypeScreenSchemes.getIssueTypeScreenSchemeMappings
ts
getIssueTypeScreenSchemeMappings: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { issueTypeScreenSchemeId?: number[]; maxResults?: number; startAt?: number; } | - |
parameters.issueTypeScreenSchemeId? | number[] | The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueTypeScreenSchemes.getIssueTypeScreenSchemeProjectAssociations
ts
getIssueTypeScreenSchemeProjectAssociations: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; projectId: number[]; startAt?: number; } | - |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectId | number[] | The list of project IDs. To include multiple projects, separate IDs with ampersand: projectId=10000&projectId=10001. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueTypeScreenSchemes.getIssueTypeScreenSchemes
ts
getIssueTypeScreenSchemes: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | (string & object | "projects")[]; id?: number[]; maxResults?: number; orderBy?: "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"; queryString?: string; startAt?: number; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "projects")[] | Use expand to include additional information in the response. This parameter accepts projects that, for each issue type screen schemes, returns information about the projects the issue type screen scheme is assigned to. |
parameters.id? | number[] | The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id" | Order the results by a field: - name Sorts by issue type screen scheme name. - id Sorts by issue type screen scheme ID. |
parameters.queryString? | string | String used to perform a case-insensitive partial match with issue type screen scheme name. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueTypeScreenSchemes.getProjectsForIssueTypeScreenScheme
ts
getProjectsForIssueTypeScreenScheme: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeScreenSchemeId: number; maxResults?: number; query?: string; startAt?: number; } | - |
parameters.issueTypeScreenSchemeId | number | The ID of the issue type screen scheme. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.query? | string | - |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
issueTypeScreenSchemes.removeMappingsFromIssueTypeScreenScheme
ts
removeMappingsFromIssueTypeScreenScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeIds: string[]; issueTypeScreenSchemeId: string; } | - |
parameters.issueTypeIds | string[] | The list of issue type IDs. |
parameters.issueTypeScreenSchemeId | string | The ID of the issue type screen scheme. |
Returns
Promise<void>
issueTypeScreenSchemes.updateDefaultScreenScheme
ts
updateDefaultScreenScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeScreenSchemeId: string; screenSchemeId: string; } | - |
parameters.issueTypeScreenSchemeId | string | The ID of the issue type screen scheme. |
parameters.screenSchemeId | string | The ID of the screen scheme. |
Returns
Promise<void>
issueTypeScreenSchemes.updateIssueTypeScreenScheme
ts
updateIssueTypeScreenScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; issueTypeScreenSchemeId: string; name?: string; } | - |
parameters.description? | string | The description of the issue type screen scheme. The maximum length is 255 characters. |
parameters.issueTypeScreenSchemeId | string | The ID of the issue type screen scheme. |
parameters.name? | string | The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters. |
Returns
Promise<void>
issueVotes
ts
issueVotes: object;issueVotes.addVote
ts
addVote: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<void>
issueVotes.getVotes
ts
getVotes: (parameters) => Promise<{
[key: string]: unknown;
hasVoted?: boolean;
self?: string;
voters?: object[];
votes?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<{ [key: string]: unknown; hasVoted?: boolean; self?: string; voters?: object[]; votes?: number; }>
issueVotes.removeVote
ts
removeVote: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<void>
issueWatchers
ts
issueWatchers: object;issueWatchers.addWatcher
ts
addWatcher: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; issueIdOrKey: string; } | - |
parameters.body | Record<string, any> | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<void>
issueWatchers.getIssueWatchers
ts
getIssueWatchers: (parameters) => Promise<{
[key: string]: unknown;
isWatching?: boolean;
self?: string;
watchCount?: number;
watchers?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<{ [key: string]: unknown; isWatching?: boolean; self?: string; watchCount?: number; watchers?: object[]; }>
issueWatchers.getIsWatchingIssueBulk
ts
getIsWatchingIssueBulk: (parameters) => Promise<{
[key: string]: unknown;
issuesIsWatching?: Record<string, any>;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIds: string[]; } | - |
parameters.issueIds | string[] | The list of issue IDs. |
Returns
Promise<{ [key: string]: unknown; issuesIsWatching?: Record<string, any>; }>
issueWatchers.removeWatcher
ts
removeWatcher: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; issueIdOrKey: string; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<void>
issueWorklogProperties
ts
issueWorklogProperties: object;issueWorklogProperties.deleteWorklogProperty
ts
deleteWorklogProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; propertyKey: string; worklogId: string; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.propertyKey | string | The key of the property. |
parameters.worklogId | string | The ID of the worklog. |
Returns
Promise<void>
issueWorklogProperties.getWorklogProperty
ts
getWorklogProperty: (parameters) => Promise<{
[key: string]: unknown;
key?: string;
value?: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; propertyKey: string; worklogId: string; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.propertyKey | string | The key of the property. |
parameters.worklogId | string | The ID of the worklog. |
Returns
Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>
issueWorklogProperties.getWorklogPropertyKeys
ts
getWorklogPropertyKeys: (parameters) => Promise<{
[key: string]: unknown;
keys?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueIdOrKey: string; worklogId: string; } | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.worklogId | string | The ID of the worklog. |
Returns
Promise<{ [key: string]: unknown; keys?: object[]; }>
issueWorklogProperties.setWorklogProperty
ts
setWorklogProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; issueIdOrKey: string; propertyKey: string; worklogId: string; } | - |
parameters.body | Record<string, any> | - |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.propertyKey | string | The key of the issue property. The maximum length is 255 characters. |
parameters.worklogId | string | The ID of the worklog. |
Returns
Promise<void>
issueWorklogs
ts
issueWorklogs: object;issueWorklogs.addWorklog
ts
addWorklog: (parameters) => Promise<{
[key: string]: unknown;
author?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
comment?: {
[key: string]: unknown;
content: Record<string, any>[];
type: string & object | "doc";
version: number;
};
created?: Date;
id?: string;
issueId?: string;
properties?: object[];
self?: string;
started?: Date;
timeSpent?: string;
timeSpentSeconds?: number;
updateAuthor?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
updated?: Date;
visibility?: {
[key: string]: unknown;
identifier?: string | null;
type?: "role" | "group" | string & object;
value?: string;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { adjustEstimate?: "auto" | "new" | "manual" | string & object | "leave"; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; comment?: | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; expand?: | string | string[] | string & object | ("properties" | string & object)[]; id?: string; issueId?: string; issueIdOrKey: string; newEstimate?: string; notifyUsers?: boolean; overrideEditableFlag?: boolean; properties?: object[]; reduceBy?: string; self?: string; started?: unknown; timeSpent?: string; timeSpentSeconds?: number; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; } | - |
parameters.adjustEstimate? | "auto" | "new" | "manual" | string & object | "leave" | Defines how to update the issue's time estimate, the options are: - new Sets the estimate to a specific value, defined in newEstimate. - leave Leaves the estimate unchanged. - manual Reduces the estimate by amount specified in reduceBy. - auto Reduces the estimate by the value of timeSpent in the worklog. |
parameters.author? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.author.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.author.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.author.active? | boolean | Whether the user is active. |
parameters.author.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.author.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.author.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.author.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.author.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.author.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.author.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.author.self? | string | The URL of the user. |
parameters.author.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.comment? | | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; } | A document in Atlassian Document Format, or a string of wiki markup — a string is sent to the v2 endpoint that parses it, and the result is read back as a document. |
parameters.created? | unknown | The datetime on which the worklog was created. |
parameters.expand? | | string | string[] | string & object | ("properties" | string & object)[] | Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties. |
parameters.id? | string | The ID of the worklog record. |
parameters.issueId? | string | The ID of the issue this worklog is for. |
parameters.issueIdOrKey | string | The ID or key the issue. |
parameters.newEstimate? | string | The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new. |
parameters.notifyUsers? | boolean | Whether users watching the issue are notified by email. |
parameters.overrideEditableFlag? | boolean | Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag. |
parameters.properties? | object[] | Details of properties for the worklog. Optional when creating or updating a worklog. |
parameters.reduceBy? | string | The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, 2d. Required when adjustEstimate is manual. |
parameters.self? | string | The URL of the worklog item. |
parameters.started? | unknown | The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog. |
parameters.timeSpent? | string | The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided. |
parameters.timeSpentSeconds? | number | The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided. |
parameters.updateAuthor? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.updateAuthor.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.updateAuthor.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.updateAuthor.active? | boolean | Whether the user is active. |
parameters.updateAuthor.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.updateAuthor.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.updateAuthor.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.updateAuthor.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.updateAuthor.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.updateAuthor.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.updateAuthor.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.updateAuthor.self? | string | The URL of the user. |
parameters.updateAuthor.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.updated? | unknown | The datetime on which the worklog was last updated. |
parameters.visibility? | { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; } | - |
parameters.visibility.identifier? | string | null | The ID of the group or the name of the role that visibility of this item is restricted to. |
parameters.visibility.type? | "role" | "group" | string & object | Whether visibility of this item is restricted to a group or role. |
parameters.visibility.value? | string | The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier. |
Returns
Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; comment?: { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: Date; id?: string; issueId?: string; properties?: object[]; self?: string; started?: Date; timeSpent?: string; timeSpentSeconds?: number; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: Date; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }>
issueWorklogs.deleteWorklog
ts
deleteWorklog: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { adjustEstimate?: "auto" | "new" | "manual" | string & object | "leave"; id: string; increaseBy?: string; issueIdOrKey: string; newEstimate?: string; notifyUsers?: boolean; overrideEditableFlag?: boolean; } | - |
parameters.adjustEstimate? | "auto" | "new" | "manual" | string & object | "leave" | Defines how to update the issue's time estimate, the options are: - new Sets the estimate to a specific value, defined in newEstimate. - leave Leaves the estimate unchanged. - manual Increases the estimate by amount specified in increaseBy. - auto Reduces the estimate by the value of timeSpent in the worklog. |
parameters.id | string | The ID of the worklog. |
parameters.increaseBy? | string | The amount to increase the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is manual. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.newEstimate? | string | The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new. |
parameters.notifyUsers? | boolean | Whether users watching the issue are notified by email. |
parameters.overrideEditableFlag? | boolean | Whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag. |
Returns
Promise<void>
issueWorklogs.getIdsOfWorklogsDeletedSince
ts
getIdsOfWorklogsDeletedSince: (parameters?) => Promise<{
[key: string]: unknown;
lastPage?: boolean;
nextPage?: string;
self?: string;
since?: number;
until?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { since?: number; } | - |
parameters.since? | number | The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned. |
Returns
Promise<{ [key: string]: unknown; lastPage?: boolean; nextPage?: string; self?: string; since?: number; until?: number; values?: object[]; }>
issueWorklogs.getIdsOfWorklogsModifiedSince
ts
getIdsOfWorklogsModifiedSince: (parameters?) => Promise<{
[key: string]: unknown;
lastPage?: boolean;
nextPage?: string;
self?: string;
since?: number;
until?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | ("properties" | string & object)[]; since?: number; } | - |
parameters.expand? | | string | string[] | string & object | ("properties" | string & object)[] | Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog. |
parameters.since? | number | The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned. |
Returns
Promise<{ [key: string]: unknown; lastPage?: boolean; nextPage?: string; self?: string; since?: number; until?: number; values?: object[]; }>
issueWorklogs.getIssueWorklog
ts
getIssueWorklog: (parameters) => Promise<{
[key: string]: unknown;
maxResults?: number;
startAt?: number;
total?: number;
worklogs?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ("properties" | string & object)[]; issueIdOrKey: string; maxResults?: number; startAt?: number; startedAfter?: number; startedBefore?: number; } | - |
parameters.expand? | | string | string[] | string & object | ("properties" | string & object)[] | Use expand to include additional information about worklogs in the response. This parameter acceptsproperties, which returns worklog properties. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
parameters.startedAfter? | number | The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned. |
parameters.startedBefore? | number | The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned. |
Returns
Promise<{ [key: string]: unknown; maxResults?: number; startAt?: number; total?: number; worklogs?: object[]; }>
issueWorklogs.getWorklog
ts
getWorklog: (parameters) => Promise<{
[key: string]: unknown;
author?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
comment?: {
[key: string]: unknown;
content: Record<string, any>[];
type: string & object | "doc";
version: number;
};
created?: Date;
id?: string;
issueId?: string;
properties?: object[];
self?: string;
started?: Date;
timeSpent?: string;
timeSpentSeconds?: number;
updateAuthor?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
updated?: Date;
visibility?: {
[key: string]: unknown;
identifier?: string | null;
type?: "role" | "group" | string & object;
value?: string;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ("properties" | string & object)[]; id: string; issueIdOrKey: string; } | - |
parameters.expand? | | string | string[] | string & object | ("properties" | string & object)[] | Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties. |
parameters.id | string | The ID of the worklog. |
parameters.issueIdOrKey | string | The ID or key of the issue. |
Returns
Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; comment?: { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: Date; id?: string; issueId?: string; properties?: object[]; self?: string; started?: Date; timeSpent?: string; timeSpentSeconds?: number; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: Date; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }>
issueWorklogs.getWorklogsForIds
ts
getWorklogsForIds: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ("properties" | string & object)[]; ids: number[]; } | - |
parameters.expand? | | string | string[] | string & object | ("properties" | string & object)[] | Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog. |
parameters.ids | number[] | A list of worklog IDs. |
Returns
Promise<object[]>
issueWorklogs.updateWorklog
ts
updateWorklog: (parameters) => Promise<{
[key: string]: unknown;
author?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
comment?: {
[key: string]: unknown;
content: Record<string, any>[];
type: string & object | "doc";
version: number;
};
created?: Date;
id?: string;
issueId?: string;
properties?: object[];
self?: string;
started?: Date;
timeSpent?: string;
timeSpentSeconds?: number;
updateAuthor?: {
[key: string]: unknown;
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
};
updated?: Date;
visibility?: {
[key: string]: unknown;
identifier?: string | null;
type?: "role" | "group" | string & object;
value?: string;
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { adjustEstimate?: "auto" | "new" | "manual" | string & object | "leave"; body: { [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; comment?: | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; id?: string; issueId?: string; properties?: object[]; self?: string; started?: unknown; timeSpent?: string; timeSpentSeconds?: number; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }; expand?: | string | string[] | string & object | ("properties" | string & object)[]; id: string; issueIdOrKey: string; newEstimate?: string; notifyUsers?: boolean; overrideEditableFlag?: boolean; } | - |
parameters.adjustEstimate? | "auto" | "new" | "manual" | string & object | "leave" | Defines how to update the issue's time estimate, the options are: - new Sets the estimate to a specific value, defined in newEstimate. - leave Leaves the estimate unchanged. - auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds. |
parameters.body | { [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; comment?: | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; id?: string; issueId?: string; properties?: object[]; self?: string; started?: unknown; timeSpent?: string; timeSpentSeconds?: number; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; } | - |
parameters.body.author? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.body.author.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.body.author.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.body.author.active? | boolean | Whether the user is active. |
parameters.body.author.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.author.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.author.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.author.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.author.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.author.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.body.author.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.body.author.self? | string | The URL of the user. |
parameters.body.author.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.body.comment? | | string | { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; } | A document in Atlassian Document Format, or a string of wiki markup — a string is sent to the v2 endpoint that parses it, and the result is read back as a document. |
parameters.body.created? | unknown | The datetime on which the worklog was created. |
parameters.body.id? | string | The ID of the worklog record. |
parameters.body.issueId? | string | The ID of the issue this worklog is for. |
parameters.body.properties? | object[] | Details of properties for the worklog. Optional when creating or updating a worklog. |
parameters.body.self? | string | The URL of the worklog item. |
parameters.body.started? | unknown | The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog. |
parameters.body.timeSpent? | string | The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided. |
parameters.body.timeSpentSeconds? | number | The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided. |
parameters.body.updateAuthor? | { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; } | - |
parameters.body.updateAuthor.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.body.updateAuthor.accountType? | string | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) |
parameters.body.updateAuthor.active? | boolean | Whether the user is active. |
parameters.body.updateAuthor.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.updateAuthor.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.updateAuthor.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.updateAuthor.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.updateAuthor.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.updateAuthor.displayName? | string | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. |
parameters.body.updateAuthor.emailAddress? | string | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. |
parameters.body.updateAuthor.self? | string | The URL of the user. |
parameters.body.updateAuthor.timeZone? | string | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. |
parameters.body.updated? | unknown | The datetime on which the worklog was last updated. |
parameters.body.visibility? | { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; } | - |
parameters.body.visibility.identifier? | string | null | The ID of the group or the name of the role that visibility of this item is restricted to. |
parameters.body.visibility.type? | "role" | "group" | string & object | Whether visibility of this item is restricted to a group or role. |
parameters.body.visibility.value? | string | The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier. |
parameters.expand? | | string | string[] | string & object | ("properties" | string & object)[] | Use expand to include additional information about worklogs in the response. This parameter accepts properties, which returns worklog properties. |
parameters.id | string | The ID of the worklog. |
parameters.issueIdOrKey | string | The ID or key the issue. |
parameters.newEstimate? | string | The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new. |
parameters.notifyUsers? | boolean | Whether users watching the issue are notified by email. |
parameters.overrideEditableFlag? | boolean | Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag. |
Returns
Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; comment?: { [key: string]: unknown; content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: Date; id?: string; issueId?: string; properties?: object[]; self?: string; started?: Date; timeSpent?: string; timeSpentSeconds?: number; updateAuthor?: { [key: string]: unknown; accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: Date; visibility?: { [key: string]: unknown; identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }>
jiraExpressions
ts
jiraExpressions: object;jiraExpressions.analyseExpression
ts
analyseExpression: (parameters) => Promise<{
[key: string]: unknown;
results: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { check?: "type" | string & object | "complexity" | "syntax"; contextVariables?: Record<string, any>; expressions: string[]; } | - |
parameters.check? | "type" | string & object | "complexity" | "syntax" | The check to perform: - syntax Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are validated. For example, the expression's length. - type EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors that would result in the expression failure at runtime are reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. Also performs the syntax check. - complexity EXPERIMENTAL. Determines the formulae for how many expensive operations each expression may execute. |
parameters.contextVariables? | Record<string, any> | Context variables and their types. The type checker assumes that common context variables, such as issue or project, are available in context and sets their type. Use this property to override the default types or provide details of new variables. |
parameters.expressions | string[] | The list of Jira expressions to analyse. |
Returns
Promise<{ [key: string]: unknown; results: object[]; }>
jiraExpressions.evaluateJSISJiraExpression
ts
evaluateJSISJiraExpression: (parameters) => Promise<{
[key: string]: unknown;
meta?: {
[key: string]: unknown;
complexity?: {
[key: string]: unknown;
beans?: {
[key: ...]: ...;
limit: ...;
value: ...;
};
expensiveOperations?: {
[key: ...]: ...;
limit: ...;
value: ...;
};
primitiveValues?: {
[key: ...]: ...;
limit: ...;
value: ...;
};
steps?: {
[key: ...]: ...;
limit: ...;
value: ...;
};
};
issues?: {
[key: string]: unknown;
jql?: {
[key: ...]: ...;
isLast?: ...;
nextPageToken: ...;
};
};
};
value: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { context?: { [key: string]: unknown; board?: number; custom?: ( | { [key: string]: unknown; accountId: string; type: "user"; } | { [key: string]: unknown; id?: ... | ...; key?: ... | ...; type: "issue"; } | { [key: string]: unknown; type: "json"; value?: ... | ...; })[]; customerRequest?: number; issue?: { [key: string]: unknown; id?: number; key?: string; }; issues?: { [key: string]: unknown; jql?: { [key: string]: unknown; maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; }; }; project?: { [key: string]: unknown; id?: number; key?: string; }; serviceDesk?: number; sprint?: number; }; expand?: | string | string[] | string & object | (string & object | "meta.complexity")[]; expression: string; } | - |
parameters.context? | { [key: string]: unknown; board?: number; custom?: ( | { [key: string]: unknown; accountId: string; type: "user"; } | { [key: string]: unknown; id?: ... | ...; key?: ... | ...; type: "issue"; } | { [key: string]: unknown; type: "json"; value?: ... | ...; })[]; customerRequest?: number; issue?: { [key: string]: unknown; id?: number; key?: string; }; issues?: { [key: string]: unknown; jql?: { [key: string]: unknown; maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; }; }; project?: { [key: string]: unknown; id?: number; key?: string; }; serviceDesk?: number; sprint?: number; } | - |
parameters.context.board? | number | The ID of the board that is available under the board variable when evaluating the expression. |
parameters.context.custom? | ( | { [key: string]: unknown; accountId: string; type: "user"; } | { [key: string]: unknown; id?: ... | ...; key?: ... | ...; type: "issue"; } | { [key: string]: unknown; type: "json"; value?: ... | ...; })[] | Custom context variables and their types. These variable types are available for use in a custom context: - user: A user specified as an Atlassian account ID. - issue: An issue specified by ID or key. All the fields of the issue object are available in the Jira expression. - json: A JSON object containing custom content. - list: A JSON list of user, issue, or json variable types. |
parameters.context.customerRequest? | number | The ID of the customer request that is available under the customerRequest variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type. |
parameters.context.issue? | { [key: string]: unknown; id?: number; key?: string; } | - |
parameters.context.issue.id? | number | The ID of the referenced item. |
parameters.context.issue.key? | string | The key of the referenced item. |
parameters.context.issues? | { [key: string]: unknown; jql?: { [key: string]: unknown; maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; }; } | - |
parameters.context.issues.jql? | { [key: string]: unknown; maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; } | - |
parameters.context.issues.jql.maxResults? | ... | ... | The maximum number of issues to return from the JQL query. max results value considered may be lower than the number specific here. |
parameters.context.issues.jql.nextPageToken? | ... | ... | The token for a page to fetch that is not the first page. The first page has a nextPageToken of null. Use the nextPageToken to fetch the next page of issues. |
parameters.context.issues.jql.query? | ... | ... | The JQL query, required to be bounded. Additionally, orderBy clause can contain a maximum of 7 fields |
parameters.context.project? | { [key: string]: unknown; id?: number; key?: string; } | - |
parameters.context.project.id? | number | The ID of the referenced item. |
parameters.context.project.key? | string | The key of the referenced item. |
parameters.context.serviceDesk? | number | The ID of the service desk that is available under the serviceDesk variable when evaluating the expression. |
parameters.context.sprint? | number | The ID of the sprint that is available under the sprint variable when evaluating the expression. |
parameters.expand? | | string | string[] | string & object | (string & object | "meta.complexity")[] | Use expand to include additional information in the response. This parameter accepts meta.complexity that returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the complexity limit. Useful when designing and debugging your expressions. |
parameters.expression | string | The Jira expression to evaluate. |
Returns
Promise<{ [key: string]: unknown; meta?: { [key: string]: unknown; complexity?: { [key: string]: unknown; beans?: { [key: ...]: ...; limit: ...; value: ...; }; expensiveOperations?: { [key: ...]: ...; limit: ...; value: ...; }; primitiveValues?: { [key: ...]: ...; limit: ...; value: ...; }; steps?: { [key: ...]: ...; limit: ...; value: ...; }; }; issues?: { [key: string]: unknown; jql?: { [key: ...]: ...; isLast?: ...; nextPageToken: ...; }; }; }; value: unknown; }>
jiraSettings
ts
jiraSettings: object;jiraSettings.getAdvancedSettings
ts
getAdvancedSettings: () => Promise<object[]>;Returns
Promise<object[]>
jiraSettings.getApplicationProperty
ts
getApplicationProperty: (parameters?) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { key?: string; keyFilter?: string; permissionLevel?: string; } | - |
parameters.key? | string | The key of the application property. |
parameters.keyFilter? | string | When a key isn't provided, this filters the list of results by the application property key using a regular expression. For example, using jira.lf.* will return all application properties with keys that start with jira.lf.. |
parameters.permissionLevel? | string | The permission level of all items being returned in the list. |
Returns
Promise<object[]>
jiraSettings.getConfiguration
ts
getConfiguration: () => Promise<{
[key: string]: unknown;
attachmentsEnabled?: boolean;
issueLinkingEnabled?: boolean;
subTasksEnabled?: boolean;
timeTrackingConfiguration?: {
[key: string]: unknown;
defaultUnit: "day" | "hour" | "minute" | "week" | string & object;
timeFormat: "days" | "hours" | string & object | "pretty";
workingDaysPerWeek: number;
workingHoursPerDay: number;
};
timeTrackingEnabled?: boolean;
unassignedIssuesAllowed?: boolean;
votingEnabled?: boolean;
watchingEnabled?: boolean;
}>;Returns
Promise<{ [key: string]: unknown; attachmentsEnabled?: boolean; issueLinkingEnabled?: boolean; subTasksEnabled?: boolean; timeTrackingConfiguration?: { [key: string]: unknown; defaultUnit: "day" | "hour" | "minute" | "week" | string & object; timeFormat: "days" | "hours" | string & object | "pretty"; workingDaysPerWeek: number; workingHoursPerDay: number; }; timeTrackingEnabled?: boolean; unassignedIssuesAllowed?: boolean; votingEnabled?: boolean; watchingEnabled?: boolean; }>
jiraSettings.setApplicationProperty
ts
setApplicationProperty: (parameters) => Promise<{
[key: string]: unknown;
allowedValues?: string[];
defaultValue?: string;
desc?: string;
example?: string;
id?: string;
key?: string;
name?: string;
type?: string;
value?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; id?: string; value?: string; }; id: string; } | - |
parameters.body | { [key: string]: unknown; id?: string; value?: string; } | - |
parameters.body.id? | string | The ID of the application property. |
parameters.body.value? | string | The new value. |
parameters.id | string | The key of the application property to update. |
Returns
Promise<{ [key: string]: unknown; allowedValues?: string[]; defaultValue?: string; desc?: string; example?: string; id?: string; key?: string; name?: string; type?: string; value?: string; }>
jql
ts
jql: object;jql.getAutoComplete
ts
getAutoComplete: () => Promise<{
[key: string]: unknown;
jqlReservedWords?: string[];
visibleFieldNames?: object[];
visibleFunctionNames?: object[];
}>;Returns
Promise<{ [key: string]: unknown; jqlReservedWords?: string[]; visibleFieldNames?: object[]; visibleFunctionNames?: object[]; }>
jql.getAutoCompletePost
ts
getAutoCompletePost: (parameters) => Promise<{
[key: string]: unknown;
jqlReservedWords?: string[];
visibleFieldNames?: object[];
visibleFunctionNames?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { includeCollapsedFields?: boolean; projectIds?: number[]; } | - |
parameters.includeCollapsedFields? | boolean | Include collapsed fields for fields that have non-unique names. |
parameters.projectIds? | number[] | List of project IDs used to filter the visible field details returned. |
Returns
Promise<{ [key: string]: unknown; jqlReservedWords?: string[]; visibleFieldNames?: object[]; visibleFunctionNames?: object[]; }>
jql.getFieldAutoCompleteForQueryString
ts
getFieldAutoCompleteForQueryString: (parameters?) => Promise<{
[key: string]: unknown;
results?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { fieldName?: string; fieldValue?: string; predicateName?: string; predicateValue?: string; } | - |
parameters.fieldName? | string | The name of the field. |
parameters.fieldValue? | string | The partial field item name entered by the user. |
parameters.predicateName? | string | The name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to. |
parameters.predicateValue? | string | The partial predicate item name entered by the user. |
Returns
Promise<{ [key: string]: unknown; results?: object[]; }>
jql.migrateQueries
ts
migrateQueries: (parameters) => Promise<{
[key: string]: unknown;
queriesWithUnknownUsers?: object[];
queryStrings?: string[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { queryStrings?: string[]; } | - |
parameters.queryStrings? | string[] | A list of queries with user identifiers. Maximum of 100 queries. |
Returns
Promise<{ [key: string]: unknown; queriesWithUnknownUsers?: object[]; queryStrings?: string[]; }>
jql.parseJqlQueries
ts
parseJqlQueries: (parameters) => Promise<{
[key: string]: unknown;
queries: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { queries: string[]; validation: "none" | "strict" | string & object | "warn"; } | - |
parameters.queries | string[] | A list of queries to parse. |
parameters.validation | "none" | "strict" | string & object | "warn" | How to validate the JQL query and treat the validation results. Validation options include: - strict Returns all errors. If validation fails, the query structure is not returned. - warn Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is returned. - none No validation is performed. If JQL query is correctly formed, the query structure is returned. |
Returns
Promise<{ [key: string]: unknown; queries: object[]; }>
jqlFunctionsApps
ts
jqlFunctionsApps: object;jqlFunctionsApps.getPrecomputations
ts
getPrecomputations: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { functionKey?: string[]; maxResults?: number; orderBy?: string; startAt?: number; } | - |
parameters.functionKey? | string[] | The function key in format: - Forge: ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest] - Connect: [App key]__[Module key] |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | string | Order the results by a field: - functionKey Sorts by the functionKey. - used Sorts by the used timestamp. - created Sorts by the created timestamp. - updated Sorts by the updated timestamp. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
jqlFunctionsApps.getPrecomputationsByID
ts
getPrecomputationsByID: (parameters) => Promise<{
[key: string]: unknown;
notFoundPrecomputationIDs?: string[];
precomputations?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { orderBy?: string; precomputationIDs?: string[]; } | - |
parameters.orderBy? | string | Order the results by a field: - functionKey Sorts by the functionKey. - used Sorts by the used timestamp. - created Sorts by the created timestamp. - updated Sorts by the updated timestamp. |
parameters.precomputationIDs? | string[] | - |
Returns
Promise<{ [key: string]: unknown; notFoundPrecomputationIDs?: string[]; precomputations?: object[]; }>
jqlFunctionsApps.updatePrecomputations
ts
updatePrecomputations: (parameters) => Promise<void>;Parameters
| Parameter | Type |
|---|---|
parameters | { skipNotFoundPrecomputations?: boolean; values?: object[]; } |
parameters.skipNotFoundPrecomputations? | boolean |
parameters.values? | object[] |
Returns
Promise<void>
labels
ts
labels: object;labels.getAllLabels
ts
getAllLabels: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: string[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { maxResults?: number; startAt?: number; } | - |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: string[]; }>
migrationOfConnectModulesToForge
ts
migrationOfConnectModulesToForge: object;migrationOfConnectModulesToForge.fetchMigrationTask
ts
fetchMigrationTask: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
elapsedRuntime: number;
finished?: Date;
id: string;
lastUpdate: Date;
message?: string;
progress: number;
result?: unknown;
self: string;
started?: Date;
status: | string & object
| "ENQUEUED"
| "RUNNING"
| "COMPLETE"
| "FAILED"
| "CANCEL_REQUESTED"
| "CANCELLED"
| "DEAD";
submitted?: Date;
submittedBy: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { connectKey: string; jiraIssueFieldsKey: string; } | - |
parameters.connectKey | string | The key of the Connect app that contains the Jira issue field being migrated. |
parameters.jiraIssueFieldsKey | string | The module key of the Connect issue field being migrated. |
Returns
Promise<{ [key: string]: unknown; description?: string; elapsedRuntime: number; finished?: Date; id: string; lastUpdate: Date; message?: string; progress: number; result?: unknown; self: string; started?: Date; status: | string & object | "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD"; submitted?: Date; submittedBy: number; }>
migrationOfConnectModulesToForge.submitTask
ts
submitTask: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { connectKey: string; jiraIssueFieldsKey: string; retriggerCompletedMigration?: boolean; } | - |
parameters.connectKey | string | The key of the Connect app that contains the Jira issue field being migrated. |
parameters.jiraIssueFieldsKey | string | The module key of the Connect issue field being migrated. |
parameters.retriggerCompletedMigration? | boolean | Whether to retrigger the migration if it has already completed. |
Returns
Promise<void>
myself
ts
myself: object;myself.getCurrentUser
ts
getCurrentUser: (parameters?) => Promise<{
[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;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | "groups" | string & object | "applicationRoles" | ("groups" | string & object | "applicationRoles")[]; } | - |
parameters.expand? | | "groups" | string & object | "applicationRoles" | ("groups" | string & object | "applicationRoles")[] | Use expand to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: - groups Returns all groups, including nested groups, the user belongs to. - applicationRoles Returns the application roles the user is assigned to. |
Returns
Promise<{ [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; }>
myself.getLocale
ts
getLocale: () => Promise<{
[key: string]: unknown;
locale?: string;
}>;Returns
Promise<{ [key: string]: unknown; locale?: string; }>
myself.getPreference
ts
getPreference: (parameters) => Promise<string>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { key: string; } | - |
parameters.key | string | The key of the preference. |
Returns
Promise<string>
myself.removePreference
ts
removePreference: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { key: string; } | - |
parameters.key | string | The key of the preference. |
Returns
Promise<void>
myself.setPreference
ts
setPreference: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; key: string; } | - |
parameters.body | Record<string, any> | - |
parameters.key | string | The key of the preference. The maximum length is 255 characters. |
Returns
Promise<void>
permissions
ts
permissions: object;permissions.getAllPermissions
ts
getAllPermissions: () => Promise<{
[key: string]: unknown;
permissions?: Record<string, any>;
}>;Returns
Promise<{ [key: string]: unknown; permissions?: Record<string, any>; }>
permissions.getBulkPermissions
ts
getBulkPermissions: (parameters) => Promise<{
[key: string]: unknown;
globalPermissions: string[];
projectPermissions: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; globalPermissions?: string[]; projectPermissions?: object[]; } | - |
parameters.accountId? | string | The account ID of a user. |
parameters.globalPermissions? | string[] | Global permissions to look up. |
parameters.projectPermissions? | object[] | Project permissions with associated projects and issues to look up. |
Returns
Promise<{ [key: string]: unknown; globalPermissions: string[]; projectPermissions: object[]; }>
permissions.getMyPermissions
ts
getMyPermissions: (parameters?) => Promise<{
[key: string]: unknown;
permissions?: Record<string, any>;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { commentId?: string; issueId?: string; issueKey?: string; permissions?: string | string[]; projectConfigurationUuid?: string; projectId?: string; projectKey?: string; projectUuid?: string; } | - |
parameters.commentId? | string | The ID of the comment. |
parameters.issueId? | string | The ID of the issue. |
parameters.issueKey? | string | The key of the issue. Ignored if issueId is provided. |
parameters.permissions? | string | string[] | A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use Get all permissions. |
parameters.projectConfigurationUuid? | string | - |
parameters.projectId? | string | The ID of project. |
parameters.projectKey? | string | The key of project. Ignored if projectId is provided. |
parameters.projectUuid? | string | - |
Returns
Promise<{ [key: string]: unknown; permissions?: Record<string, any>; }>
permissions.getPermittedProjects
ts
getPermittedProjects: (parameters) => Promise<{
[key: string]: unknown;
projects?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { permissions: string[]; } | - |
parameters.permissions | string[] | A list of permission keys. |
Returns
Promise<{ [key: string]: unknown; projects?: object[]; }>
permissionSchemes
ts
permissionSchemes: object;permissionSchemes.createPermissionGrant
ts
createPermissionGrant: (parameters) => Promise<{
[key: string]: unknown;
holder?: {
[key: string]: unknown;
expand?: string;
parameter?: string;
type: string;
value?: string;
};
id?: number;
permission?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; holder?: { [key: string]: unknown; expand?: string; parameter?: string; type: string; value?: string; }; id?: number; permission?: string; schemeId: number; self?: string; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: - permissions Returns all permission grants for each permission scheme. - user Returns information about the user who is granted the permission. - group Returns information about the group that is granted the permission. - projectRole Returns information about the project role granted the permission. - field Returns information about the custom field granted the permission. - all Returns all expandable information. |
parameters.holder? | { [key: string]: unknown; expand?: string; parameter?: string; type: string; value?: string; } | - |
parameters.holder.expand? | string | Expand options that include additional permission holder details in the response. |
parameters.holder.parameter? | string | As a group's name can change, use of value is recommended. The identifier associated withthe type value that defines the holder of the permission. |
parameters.holder.type | string | The type of permission holder. |
parameters.holder.value? | string | The identifier associated with the type value that defines the holder of the permission. |
parameters.id? | number | The ID of the permission granted details. |
parameters.permission? | string | The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See Built-in permissions in Get all permission schemes for more information about the built-in permissions. See the project permission and global permission module documentation for more information about custom permissions. |
parameters.schemeId | number | The ID of the permission scheme in which to create a new permission grant. |
parameters.self? | string | The URL of the permission granted details. |
Returns
Promise<{ [key: string]: unknown; holder?: { [key: string]: unknown; expand?: string; parameter?: string; type: string; value?: string; }; id?: number; permission?: string; self?: string; }>
permissionSchemes.createPermissionScheme
ts
createPermissionScheme: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
expand?: string;
id?: number;
name: string;
permissions?: object[];
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }; expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; } | - |
parameters.body | { [key: string]: unknown; description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; } | - |
parameters.body.description? | string | A description for the permission scheme. |
parameters.body.expand? | string | The expand options available for the permission scheme. |
parameters.body.id? | number | The ID of the permission scheme. |
parameters.body.name | string | The name of the permission scheme. Must be unique. |
parameters.body.permissions? | object[] | The permission scheme to create or update. See About permission schemes and grants for more information. |
parameters.body.scope? | { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; } | - |
parameters.body.scope.project? | { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; } | - |
parameters.body.scope.project.avatarUrls? | { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; } | - |
parameters.body.scope.project.avatarUrls.16x16? | ... | The URL of the item's 16x16 pixel avatar. |
parameters.body.scope.project.avatarUrls.24x24? | ... | The URL of the item's 24x24 pixel avatar. |
parameters.body.scope.project.avatarUrls.32x32? | ... | The URL of the item's 32x32 pixel avatar. |
parameters.body.scope.project.avatarUrls.48x48? | ... | The URL of the item's 48x48 pixel avatar. |
parameters.body.scope.project.id? | string | The ID of the project. |
parameters.body.scope.project.key? | string | The key of the project. |
parameters.body.scope.project.name? | string | The name of the project. |
parameters.body.scope.project.projectCategory? | { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; } | - |
parameters.body.scope.project.projectCategory.description? | ... | The name of the project category. |
parameters.body.scope.project.projectCategory.id? | ... | The ID of the project category. |
parameters.body.scope.project.projectCategory.name? | ... | The description of the project category. |
parameters.body.scope.project.projectCategory.self? | ... | The URL of the project category. |
parameters.body.scope.project.projectTypeKey? | | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service" | The project type of the project. |
parameters.body.scope.project.self? | string | The URL of the project details. |
parameters.body.scope.project.simplified? | boolean | Whether or not the project is simplified. |
parameters.body.scope.type? | string & object | "PROJECT" | "TEMPLATE" | The type of scope. |
parameters.body.self? | string | The URL of the permission scheme. |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: - all Returns all expandable information. - field Returns information about the custom field granted the permission. - group Returns information about the group that is granted the permission. - permissions Returns all permission grants for each permission scheme. - projectRole Returns information about the project role granted the permission. - user Returns information about the user who is granted the permission. |
Returns
Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }>
permissionSchemes.deletePermissionScheme
ts
deletePermissionScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { schemeId: number; } | - |
parameters.schemeId | number | The ID of the permission scheme being deleted. |
Returns
Promise<void>
permissionSchemes.deletePermissionSchemeEntity
ts
deletePermissionSchemeEntity: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { permissionId: number; schemeId: number; } | - |
parameters.permissionId | number | The ID of the permission grant to delete. |
parameters.schemeId | number | The ID of the permission scheme to delete the permission grant from. |
Returns
Promise<void>
permissionSchemes.getAllPermissionSchemes
ts
getAllPermissionSchemes: (parameters?) => Promise<{
[key: string]: unknown;
permissionSchemes?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: - all Returns all expandable information. - field Returns information about the custom field granted the permission. - group Returns information about the group that is granted the permission. - permissions Returns all permission grants for each permission scheme. - projectRole Returns information about the project role granted the permission. - user Returns information about the user who is granted the permission. |
Returns
Promise<{ [key: string]: unknown; permissionSchemes?: object[]; }>
permissionSchemes.getPermissionScheme
ts
getPermissionScheme: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
expand?: string;
id?: number;
name: string;
permissions?: object[];
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; schemeId: number; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: - all Returns all expandable information. - field Returns information about the custom field granted the permission. - group Returns information about the group that is granted the permission. - permissions Returns all permission grants for each permission scheme. - projectRole Returns information about the project role granted the permission. - user Returns information about the user who is granted the permission. |
parameters.schemeId | number | The ID of the permission scheme to return. |
Returns
Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }>
permissionSchemes.getPermissionSchemeGrant
ts
getPermissionSchemeGrant: (parameters) => Promise<{
[key: string]: unknown;
holder?: {
[key: string]: unknown;
expand?: string;
parameter?: string;
type: string;
value?: string;
};
id?: number;
permission?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; permissionId: number; schemeId: number; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: - all Returns all expandable information. - field Returns information about the custom field granted the permission. - group Returns information about the group that is granted the permission. - permissions Returns all permission grants for each permission scheme. - projectRole Returns information about the project role granted the permission. - user Returns information about the user who is granted the permission. |
parameters.permissionId | number | The ID of the permission grant. |
parameters.schemeId | number | The ID of the permission scheme. |
Returns
Promise<{ [key: string]: unknown; holder?: { [key: string]: unknown; expand?: string; parameter?: string; type: string; value?: string; }; id?: number; permission?: string; self?: string; }>
permissionSchemes.getPermissionSchemeGrants
ts
getPermissionSchemeGrants: (parameters) => Promise<{
[key: string]: unknown;
expand?: string;
permissions?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; schemeId: number; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: - permissions Returns all permission grants for each permission scheme. - user Returns information about the user who is granted the permission. - group Returns information about the group that is granted the permission. - projectRole Returns information about the project role granted the permission. - field Returns information about the custom field granted the permission. - all Returns all expandable information. |
parameters.schemeId | number | The ID of the permission scheme. |
Returns
Promise<{ [key: string]: unknown; expand?: string; permissions?: object[]; }>
permissionSchemes.updatePermissionScheme
ts
updatePermissionScheme: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
expand?: string;
id?: number;
name: string;
permissions?: object[];
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }; expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; schemeId: number; } | - |
parameters.body | { [key: string]: unknown; description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; } | - |
parameters.body.description? | string | A description for the permission scheme. |
parameters.body.expand? | string | The expand options available for the permission scheme. |
parameters.body.id? | number | The ID of the permission scheme. |
parameters.body.name | string | The name of the permission scheme. Must be unique. |
parameters.body.permissions? | object[] | The permission scheme to create or update. See About permission schemes and grants for more information. |
parameters.body.scope? | { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; } | - |
parameters.body.scope.project? | { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; } | - |
parameters.body.scope.project.avatarUrls? | { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; } | - |
parameters.body.scope.project.avatarUrls.16x16? | ... | The URL of the item's 16x16 pixel avatar. |
parameters.body.scope.project.avatarUrls.24x24? | ... | The URL of the item's 24x24 pixel avatar. |
parameters.body.scope.project.avatarUrls.32x32? | ... | The URL of the item's 32x32 pixel avatar. |
parameters.body.scope.project.avatarUrls.48x48? | ... | The URL of the item's 48x48 pixel avatar. |
parameters.body.scope.project.id? | string | The ID of the project. |
parameters.body.scope.project.key? | string | The key of the project. |
parameters.body.scope.project.name? | string | The name of the project. |
parameters.body.scope.project.projectCategory? | { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; } | - |
parameters.body.scope.project.projectCategory.description? | ... | The name of the project category. |
parameters.body.scope.project.projectCategory.id? | ... | The ID of the project category. |
parameters.body.scope.project.projectCategory.name? | ... | The description of the project category. |
parameters.body.scope.project.projectCategory.self? | ... | The URL of the project category. |
parameters.body.scope.project.projectTypeKey? | | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service" | The project type of the project. |
parameters.body.scope.project.self? | string | The URL of the project details. |
parameters.body.scope.project.simplified? | boolean | Whether or not the project is simplified. |
parameters.body.scope.type? | string & object | "PROJECT" | "TEMPLATE" | The type of scope. |
parameters.body.self? | string | The URL of the permission scheme. |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: - all Returns all expandable information. - field Returns information about the custom field granted the permission. - group Returns information about the group that is granted the permission. - permissions Returns all permission grants for each permission scheme. - projectRole Returns information about the project role granted the permission. - user Returns information about the user who is granted the permission. |
parameters.schemeId | number | The ID of the permission scheme to update. |
Returns
Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }>
projectAvatars
ts
projectAvatars: object;projectAvatars.createProjectAvatar
ts
createProjectAvatar: (parameters) => Promise<{
[key: string]: unknown;
fileName?: string;
id: string;
isDeletable?: boolean;
isSelected?: boolean;
isSystemAvatar?: boolean;
owner?: string;
urls?: Record<string, any>;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; projectIdOrKey: string; size?: number; x?: number; y?: number; } | - |
parameters.body | Record<string, any> | - |
parameters.projectIdOrKey | string | The ID or (case-sensitive) key of the project. |
parameters.size? | number | The length of each side of the crop region. |
parameters.x? | number | The X coordinate of the top-left corner of the crop region. |
parameters.y? | number | The Y coordinate of the top-left corner of the crop region. |
Returns
Promise<{ [key: string]: unknown; fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; urls?: Record<string, any>; }>
projectAvatars.deleteProjectAvatar
ts
deleteProjectAvatar: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; projectIdOrKey: string; } | - |
parameters.id | number | The ID of the avatar. |
parameters.projectIdOrKey | string | The project ID or (case-sensitive) key. |
Returns
Promise<void>
projectAvatars.getAllProjectAvatars
ts
getAllProjectAvatars: (parameters) => Promise<{
[key: string]: unknown;
custom?: object[];
system?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectIdOrKey: string; } | - |
parameters.projectIdOrKey | string | The ID or (case-sensitive) key of the project. |
Returns
Promise<{ [key: string]: unknown; custom?: object[]; system?: object[]; }>
projectAvatars.updateProjectAvatar
ts
updateProjectAvatar: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; projectIdOrKey: string; urls?: Record<string, any>; } | - |
parameters.fileName? | string | The file name of the avatar icon. Returned for system avatars. |
parameters.id | string | The ID of the avatar. |
parameters.isDeletable? | boolean | Whether the avatar can be deleted. |
parameters.isSelected? | boolean | Whether the avatar is used in Jira. For example, shown as a project's avatar. |
parameters.isSystemAvatar? | boolean | Whether the avatar is a system avatar. |
parameters.owner? | string | The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user. |
parameters.projectIdOrKey | string | The ID or (case-sensitive) key of the project. |
parameters.urls? | Record<string, any> | The list of avatar icon URLs. |
Returns
Promise<void>
projectCategories
ts
projectCategories: object;projectCategories.createProjectCategory
ts
createProjectCategory: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
id?: string;
name?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; id?: string; name?: string; self?: string; } | - |
parameters.description? | string | The description of the project category. |
parameters.id? | string | The ID of the project category. |
parameters.name? | string | The name of the project category. Required on create, optional on update. |
parameters.self? | string | The URL of the project category. |
Returns
Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>
projectCategories.getAllProjectCategories
ts
getAllProjectCategories: () => Promise<object[]>;Returns
Promise<object[]>
projectCategories.getProjectCategoryById
ts
getProjectCategoryById: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
id?: string;
name?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the project category. |
Returns
Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>
projectCategories.removeProjectCategory
ts
removeProjectCategory: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | ID of the project category to delete. |
Returns
Promise<void>
projectCategories.updateProjectCategory
ts
updateProjectCategory: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
id?: string;
name?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }; id: number; } | - |
parameters.body | { [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; } | - |
parameters.body.description? | string | The description of the project category. |
parameters.body.id? | string | The ID of the project category. |
parameters.body.name? | string | The name of the project category. Required on create, optional on update. |
parameters.body.self? | string | The URL of the project category. |
parameters.id | number | - |
Returns
Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>
projectComponents
ts
projectComponents: object;projectComponents.createComponent
ts
createComponent: (parameters) => Promise<{
[key: string]: unknown;
ari?: string;
assignee?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
assigneeType?: | string & object
| "PROJECT_DEFAULT"
| "COMPONENT_LEAD"
| "PROJECT_LEAD"
| "UNASSIGNED";
description?: string;
id?: string;
isAssigneeTypeValid?: boolean;
lead?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
leadAccountId?: string;
metadata?: Record<string, any>;
name?: string;
project?: string;
projectId?: number;
realAssignee?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
realAssigneeType?: | string & object
| "PROJECT_DEFAULT"
| "COMPONENT_LEAD"
| "PROJECT_LEAD"
| "UNASSIGNED";
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { ari?: string; assignee?: { [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; }; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; description?: string; id?: string; isAssigneeTypeValid?: boolean; 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; }; leadAccountId?: string; metadata?: Record<string, any>; name?: string; project?: string; projectId?: number; realAssignee?: { [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; }; realAssigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; self?: string; } | - |
parameters.ari? | string | Compass component's ID. Can't be updated. Not required for creating a Project Component. |
parameters.assignee? | { [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; } | - |
parameters.assignee.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.assignee.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.assignee.active? | boolean | Whether the user is active. |
parameters.assignee.applicationRoles? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.assignee.applicationRoles.callback? | { [key: string]: unknown; } | - |
parameters.assignee.applicationRoles.items? | object[] | - |
parameters.assignee.applicationRoles.max-results? | number | - |
parameters.assignee.applicationRoles.pagingCallback? | { [key: string]: unknown; } | - |
parameters.assignee.applicationRoles.size? | number | - |
parameters.assignee.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.assignee.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.assignee.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.assignee.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.assignee.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.assignee.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.assignee.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.assignee.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.assignee.expand? | string | Expand options that include additional user details in the response. |
parameters.assignee.groups? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.assignee.groups.callback? | { [key: string]: unknown; } | - |
parameters.assignee.groups.items? | object[] | - |
parameters.assignee.groups.max-results? | number | - |
parameters.assignee.groups.pagingCallback? | { [key: string]: unknown; } | - |
parameters.assignee.groups.size? | number | - |
parameters.assignee.guest? | boolean | Whether the user is a guest. |
parameters.assignee.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.assignee.self? | string | The URL of the user. |
parameters.assignee.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.assigneeType? | | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED" | The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: - PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in. - COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component. - UNASSIGNED an assignee is not set for issues created with this component. - PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: PROJECT_DEFAULT. Optional when creating or updating a component. |
parameters.description? | string | The description for the component. Optional when creating or updating a component. |
parameters.id? | string | The unique identifier for the component. |
parameters.isAssigneeTypeValid? | boolean | Whether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned. |
parameters.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; } | - |
parameters.lead.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.lead.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.lead.active? | boolean | Whether the user is active. |
parameters.lead.applicationRoles? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.lead.applicationRoles.callback? | { [key: string]: unknown; } | - |
parameters.lead.applicationRoles.items? | object[] | - |
parameters.lead.applicationRoles.max-results? | number | - |
parameters.lead.applicationRoles.pagingCallback? | { [key: string]: unknown; } | - |
parameters.lead.applicationRoles.size? | number | - |
parameters.lead.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.lead.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.lead.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.lead.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.lead.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.lead.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.lead.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.lead.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.lead.expand? | string | Expand options that include additional user details in the response. |
parameters.lead.groups? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.lead.groups.callback? | { [key: string]: unknown; } | - |
parameters.lead.groups.items? | object[] | - |
parameters.lead.groups.max-results? | number | - |
parameters.lead.groups.pagingCallback? | { [key: string]: unknown; } | - |
parameters.lead.groups.size? | number | - |
parameters.lead.guest? | boolean | Whether the user is a guest. |
parameters.lead.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.lead.self? | string | The URL of the user. |
parameters.lead.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.leadAccountId? | string | The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.metadata? | Record<string, any> | Compass component's metadata. Can't be updated. Not required for creating a Project Component. |
parameters.name? | string | The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters. |
parameters.project? | string | The key of the project the component is assigned to. Required when creating a component. Can't be updated. |
parameters.projectId? | number | The ID of the project the component is assigned to. |
parameters.realAssignee? | { [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; } | - |
parameters.realAssignee.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.realAssignee.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.realAssignee.active? | boolean | Whether the user is active. |
parameters.realAssignee.applicationRoles? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.realAssignee.applicationRoles.callback? | { [key: string]: unknown; } | - |
parameters.realAssignee.applicationRoles.items? | object[] | - |
parameters.realAssignee.applicationRoles.max-results? | number | - |
parameters.realAssignee.applicationRoles.pagingCallback? | { [key: string]: unknown; } | - |
parameters.realAssignee.applicationRoles.size? | number | - |
parameters.realAssignee.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.realAssignee.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.realAssignee.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.realAssignee.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.realAssignee.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.realAssignee.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.realAssignee.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.realAssignee.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.realAssignee.expand? | string | Expand options that include additional user details in the response. |
parameters.realAssignee.groups? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.realAssignee.groups.callback? | { [key: string]: unknown; } | - |
parameters.realAssignee.groups.items? | object[] | - |
parameters.realAssignee.groups.max-results? | number | - |
parameters.realAssignee.groups.pagingCallback? | { [key: string]: unknown; } | - |
parameters.realAssignee.groups.size? | number | - |
parameters.realAssignee.guest? | boolean | Whether the user is a guest. |
parameters.realAssignee.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.realAssignee.self? | string | The URL of the user. |
parameters.realAssignee.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.realAssigneeType? | | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED" | The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values: - PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in. - COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in. - UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues. - PROJECT_DEFAULT when none of the preceding cases are true. |
parameters.self? | string | The URL of the component. |
Returns
Promise<{ [key: string]: unknown; ari?: string; assignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; description?: string; id?: string; isAssigneeTypeValid?: boolean; lead?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; leadAccountId?: string; metadata?: Record<string, any>; name?: string; project?: string; projectId?: number; realAssignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; realAssigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; self?: string; }>
projectComponents.deleteComponent
ts
deleteComponent: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; moveIssuesTo?: string; } | - |
parameters.id | string | The ID of the component. |
parameters.moveIssuesTo? | string | The ID of the component to replace the deleted component. If this value is null no replacement is made. |
Returns
Promise<void>
projectComponents.findComponentsForProjects
ts
findComponentsForProjects: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { maxResults?: number; orderBy?: | "name" | "description" | string & object | "-description" | "+description" | "-name" | "+name"; projectIdsOrKeys?: string[]; query?: string; startAt?: number; } | - |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | | "name" | "description" | string & object | "-description" | "+description" | "-name" | "+name" | Order the results by a field: - description Sorts by the component description. - name Sorts by component name. |
parameters.projectIdsOrKeys? | string[] | The project IDs and/or project keys (case sensitive). |
parameters.query? | string | Filter the results using a literal string. Components with a matching name or description are returned (case insensitive). |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
projectComponents.getComponent
ts
getComponent: (parameters) => Promise<{
[key: string]: unknown;
ari?: string;
assignee?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
assigneeType?: | string & object
| "PROJECT_DEFAULT"
| "COMPONENT_LEAD"
| "PROJECT_LEAD"
| "UNASSIGNED";
description?: string;
id?: string;
isAssigneeTypeValid?: boolean;
lead?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
leadAccountId?: string;
metadata?: Record<string, any>;
name?: string;
project?: string;
projectId?: number;
realAssignee?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
realAssigneeType?: | string & object
| "PROJECT_DEFAULT"
| "COMPONENT_LEAD"
| "PROJECT_LEAD"
| "UNASSIGNED";
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the component. |
Returns
Promise<{ [key: string]: unknown; ari?: string; assignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; description?: string; id?: string; isAssigneeTypeValid?: boolean; lead?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; leadAccountId?: string; metadata?: Record<string, any>; name?: string; project?: string; projectId?: number; realAssignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; realAssigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; self?: string; }>
projectComponents.getComponentRelatedIssues
ts
getComponentRelatedIssues: (parameters) => Promise<{
[key: string]: unknown;
issueCount?: number;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the component. |
Returns
Promise<{ [key: string]: unknown; issueCount?: number; self?: string; }>
projectComponents.getProjectComponents
ts
getProjectComponents: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { componentSource?: "auto" | "jira" | string & object | "compass"; projectIdOrKey: string; } | - |
parameters.componentSource? | "auto" | "jira" | string & object | "compass" | The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<object[]>
projectComponents.getProjectComponentsPaginated
ts
getProjectComponentsPaginated: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { componentSource?: "auto" | "jira" | string & object | "compass"; maxResults?: number; orderBy?: | "name" | "description" | string & object | "lead" | "issueCount" | "-description" | "+description" | "-name" | "+name" | "-issueCount" | "+issueCount" | "-lead" | "+lead"; projectIdOrKey: string; query?: string; startAt?: number; } | - |
parameters.componentSource? | "auto" | "jira" | string & object | "compass" | The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | | "name" | "description" | string & object | "lead" | "issueCount" | "-description" | "+description" | "-name" | "+name" | "-issueCount" | "+issueCount" | "-lead" | "+lead" | Order the results by a field: - description Sorts by the component description. - issueCount Sorts by the count of issues associated with the component. - lead Sorts by the user key of the component's project lead. - name Sorts by component name. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
parameters.query? | string | Filter the results using a literal string. Components with a matching name or description are returned (case insensitive). |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
projectComponents.updateComponent
ts
updateComponent: (parameters) => Promise<{
[key: string]: unknown;
ari?: string;
assignee?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
assigneeType?: | string & object
| "PROJECT_DEFAULT"
| "COMPONENT_LEAD"
| "PROJECT_LEAD"
| "UNASSIGNED";
description?: string;
id?: string;
isAssigneeTypeValid?: boolean;
lead?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
leadAccountId?: string;
metadata?: Record<string, any>;
name?: string;
project?: string;
projectId?: number;
realAssignee?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
realAssigneeType?: | string & object
| "PROJECT_DEFAULT"
| "COMPONENT_LEAD"
| "PROJECT_LEAD"
| "UNASSIGNED";
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; ari?: string; assignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; description?: string; id?: string; isAssigneeTypeValid?: boolean; lead?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; leadAccountId?: string; metadata?: Record<string, any>; name?: string; project?: string; projectId?: number; realAssignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; realAssigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; self?: string; }; id: string; } | - |
parameters.body | { [key: string]: unknown; ari?: string; assignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; description?: string; id?: string; isAssigneeTypeValid?: boolean; lead?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; leadAccountId?: string; metadata?: Record<string, any>; name?: string; project?: string; projectId?: number; realAssignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; realAssigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; self?: string; } | - |
parameters.body.ari? | string | Compass component's ID. Can't be updated. Not required for creating a Project Component. |
parameters.body.assignee? | { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; } | - |
parameters.body.assignee.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.body.assignee.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.body.assignee.active? | boolean | Whether the user is active. |
parameters.body.assignee.applicationRoles? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.assignee.applicationRoles.callback? | { [key: ...]: ...; } | - |
parameters.body.assignee.applicationRoles.items? | ...[] | - |
parameters.body.assignee.applicationRoles.max-results? | number | - |
parameters.body.assignee.applicationRoles.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.assignee.applicationRoles.size? | number | - |
parameters.body.assignee.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.body.assignee.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.assignee.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.assignee.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.assignee.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.assignee.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.assignee.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.body.assignee.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.assignee.expand? | string | Expand options that include additional user details in the response. |
parameters.body.assignee.groups? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.assignee.groups.callback? | { [key: ...]: ...; } | - |
parameters.body.assignee.groups.items? | ...[] | - |
parameters.body.assignee.groups.max-results? | number | - |
parameters.body.assignee.groups.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.assignee.groups.size? | number | - |
parameters.body.assignee.guest? | boolean | Whether the user is a guest. |
parameters.body.assignee.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.assignee.self? | string | The URL of the user. |
parameters.body.assignee.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.body.assigneeType? | | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED" | The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: - PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in. - COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component. - UNASSIGNED an assignee is not set for issues created with this component. - PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: PROJECT_DEFAULT. Optional when creating or updating a component. |
parameters.body.description? | string | The description for the component. Optional when creating or updating a component. |
parameters.body.id? | string | The unique identifier for the component. |
parameters.body.isAssigneeTypeValid? | boolean | Whether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned. |
parameters.body.lead? | { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; } | - |
parameters.body.lead.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.body.lead.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.body.lead.active? | boolean | Whether the user is active. |
parameters.body.lead.applicationRoles? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.lead.applicationRoles.callback? | { [key: ...]: ...; } | - |
parameters.body.lead.applicationRoles.items? | ...[] | - |
parameters.body.lead.applicationRoles.max-results? | number | - |
parameters.body.lead.applicationRoles.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.lead.applicationRoles.size? | number | - |
parameters.body.lead.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.body.lead.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.lead.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.lead.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.lead.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.lead.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.lead.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.body.lead.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.lead.expand? | string | Expand options that include additional user details in the response. |
parameters.body.lead.groups? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.lead.groups.callback? | { [key: ...]: ...; } | - |
parameters.body.lead.groups.items? | ...[] | - |
parameters.body.lead.groups.max-results? | number | - |
parameters.body.lead.groups.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.lead.groups.size? | number | - |
parameters.body.lead.guest? | boolean | Whether the user is a guest. |
parameters.body.lead.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.lead.self? | string | The URL of the user. |
parameters.body.lead.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.body.leadAccountId? | string | The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.body.metadata? | Record<string, any> | Compass component's metadata. Can't be updated. Not required for creating a Project Component. |
parameters.body.name? | string | The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters. |
parameters.body.project? | string | The key of the project the component is assigned to. Required when creating a component. Can't be updated. |
parameters.body.projectId? | number | The ID of the project the component is assigned to. |
parameters.body.realAssignee? | { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; } | - |
parameters.body.realAssignee.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.body.realAssignee.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.body.realAssignee.active? | boolean | Whether the user is active. |
parameters.body.realAssignee.applicationRoles? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.realAssignee.applicationRoles.callback? | { [key: ...]: ...; } | - |
parameters.body.realAssignee.applicationRoles.items? | ...[] | - |
parameters.body.realAssignee.applicationRoles.max-results? | number | - |
parameters.body.realAssignee.applicationRoles.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.realAssignee.applicationRoles.size? | number | - |
parameters.body.realAssignee.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.body.realAssignee.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.realAssignee.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.realAssignee.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.realAssignee.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.realAssignee.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.realAssignee.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.body.realAssignee.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.realAssignee.expand? | string | Expand options that include additional user details in the response. |
parameters.body.realAssignee.groups? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.realAssignee.groups.callback? | { [key: ...]: ...; } | - |
parameters.body.realAssignee.groups.items? | ...[] | - |
parameters.body.realAssignee.groups.max-results? | number | - |
parameters.body.realAssignee.groups.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.realAssignee.groups.size? | number | - |
parameters.body.realAssignee.guest? | boolean | Whether the user is a guest. |
parameters.body.realAssignee.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.realAssignee.self? | string | The URL of the user. |
parameters.body.realAssignee.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.body.realAssigneeType? | | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED" | The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values: - PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in. - COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in. - UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues. - PROJECT_DEFAULT when none of the preceding cases are true. |
parameters.body.self? | string | The URL of the component. |
parameters.id | string | The ID of the component. |
Returns
Promise<{ [key: string]: unknown; ari?: string; assignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; description?: string; id?: string; isAssigneeTypeValid?: boolean; lead?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; leadAccountId?: string; metadata?: Record<string, any>; name?: string; project?: string; projectId?: number; realAssignee?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; realAssigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; self?: string; }>
projectEmail
ts
projectEmail: object;projectEmail.getProjectEmail
ts
getProjectEmail: (parameters) => Promise<{
[key: string]: unknown;
emailAddress?: string;
emailAddressStatus?: string[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectId: number; } | - |
parameters.projectId | number | The project ID. |
Returns
Promise<{ [key: string]: unknown; emailAddress?: string; emailAddressStatus?: string[]; }>
projectEmail.updateProjectEmail
ts
updateProjectEmail: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { emailAddress?: string; emailAddressStatus?: string[]; projectId: number; } | - |
parameters.emailAddress? | string | The email address. |
parameters.emailAddressStatus? | string[] | When using a custom domain, the status of the email address. |
parameters.projectId | number | The project ID. |
Returns
Promise<void>
projectFeatures
ts
projectFeatures: object;projectFeatures.getFeaturesForProject
ts
getFeaturesForProject: (parameters) => Promise<{
[key: string]: unknown;
features?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectIdOrKey: string; } | - |
parameters.projectIdOrKey | string | The ID or (case-sensitive) key of the project. |
Returns
Promise<{ [key: string]: unknown; features?: object[]; }>
projectFeatures.toggleFeatureForProject
ts
toggleFeatureForProject: (parameters) => Promise<{
[key: string]: unknown;
features?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { featureKey: string; projectIdOrKey: string; state?: string & object | "ENABLED" | "DISABLED" | "COMING_SOON"; } | - |
parameters.featureKey | string | The key of the feature. |
parameters.projectIdOrKey | string | The ID or (case-sensitive) key of the project. |
parameters.state? | string & object | "ENABLED" | "DISABLED" | "COMING_SOON" | The feature state. |
Returns
Promise<{ [key: string]: unknown; features?: object[]; }>
projectKeyAndNameValidation
ts
projectKeyAndNameValidation: object;projectKeyAndNameValidation.getValidProjectKey
ts
getValidProjectKey: (parameters?) => Promise<string>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { key?: string; } | - |
parameters.key? | string | The project key. |
Returns
Promise<string>
projectKeyAndNameValidation.getValidProjectName
ts
getValidProjectName: (parameters) => Promise<string>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { name: string; } | - |
parameters.name | string | The project name. |
Returns
Promise<string>
projectKeyAndNameValidation.validateProjectKey
ts
validateProjectKey: (parameters?) => Promise<{
[key: string]: unknown;
errorMessages?: string[];
errors?: Record<string, any>;
status?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { key?: string; } | - |
parameters.key? | string | The project key. |
Returns
Promise<{ [key: string]: unknown; errorMessages?: string[]; errors?: Record<string, any>; status?: number; }>
projectPermissionSchemes
ts
projectPermissionSchemes: object;projectPermissionSchemes.assignPermissionScheme
ts
assignPermissionScheme: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
expand?: string;
id?: number;
name: string;
permissions?: object[];
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; id: number; projectKeyOrId: string; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: - all Returns all expandable information. - field Returns information about the custom field granted the permission. - group Returns information about the group that is granted the permission. - permissions Returns all permission grants for each permission scheme. - projectRole Returns information about the project role granted the permission. - user Returns information about the user who is granted the permission. |
parameters.id | number | The ID of the permission scheme to associate with the project. Use the Get all permission schemes resource to get a list of permission scheme IDs. |
parameters.projectKeyOrId | string | The project ID or project key (case sensitive). |
Returns
Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }>
projectPermissionSchemes.getAssignedPermissionScheme
ts
getAssignedPermissionScheme: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
expand?: string;
id?: number;
name: string;
permissions?: object[];
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; projectKeyOrId: string; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: - all Returns all expandable information. - field Returns information about the custom field granted the permission. - group Returns information about the group that is granted the permission. - permissions Returns all permission grants for each permission scheme. - projectRole Returns information about the project role granted the permission. - user Returns information about the user who is granted the permission. |
parameters.projectKeyOrId | string | The project ID or project key (case sensitive). |
Returns
Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }>
projectPermissionSchemes.getProjectIssueSecurityScheme
ts
getProjectIssueSecurityScheme: (parameters) => Promise<{
[key: string]: unknown;
defaultSecurityLevelId?: number;
description?: string;
id?: number;
levels?: object[];
name?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectKeyOrId: string; } | - |
parameters.projectKeyOrId | string | The project ID or project key (case sensitive). |
Returns
Promise<{ [key: string]: unknown; defaultSecurityLevelId?: number; description?: string; id?: number; levels?: object[]; name?: string; self?: string; }>
projectPermissionSchemes.getSecurityLevelsForProject
ts
getSecurityLevelsForProject: (parameters) => Promise<{
[key: string]: unknown;
levels: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectKeyOrId: string; } | - |
parameters.projectKeyOrId | string | The project ID or project key (case sensitive). |
Returns
Promise<{ [key: string]: unknown; levels: object[]; }>
projectProperties
ts
projectProperties: object;projectProperties.deleteProjectProperty
ts
deleteProjectProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectIdOrKey: string; propertyKey: string; } | - |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
parameters.propertyKey | string | The project property key. Use Get project property keys to get a list of all project property keys. |
Returns
Promise<void>
projectProperties.getProjectProperty
ts
getProjectProperty: (parameters) => Promise<{
[key: string]: unknown;
key?: string;
value?: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectIdOrKey: string; propertyKey: string; } | - |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
parameters.propertyKey | string | The project property key. Use Get project property keys to get a list of all project property keys. |
Returns
Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>
projectProperties.getProjectPropertyKeys
ts
getProjectPropertyKeys: (parameters) => Promise<{
[key: string]: unknown;
keys?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectIdOrKey: string; } | - |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<{ [key: string]: unknown; keys?: object[]; }>
projectProperties.setProjectProperty
ts
setProjectProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: Record<string, any>; projectIdOrKey: string; propertyKey: string; } | - |
parameters.body | Record<string, any> | - |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
parameters.propertyKey | string | The key of the project property. The maximum length is 255 characters. |
Returns
Promise<void>
projectRoleActors
ts
projectRoleActors: object;projectRoleActors.addActorUsers
ts
addActorUsers: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { group?: string[]; groupId?: string[]; id: number; projectIdOrKey: string; user?: string[]; } | - |
parameters.group? | string[] | The name of the group to add. This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended. |
parameters.groupId? | string[] | The ID of the group to add. This parameter cannot be used with the group parameter. |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
parameters.user? | string[] | The user account ID of the user to add. |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projectRoleActors.addProjectRoleActorsToRole
ts
addProjectRoleActorsToRole: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { group?: string[]; groupId?: string[]; id: number; user?: string[]; } | - |
parameters.group? | string[] | The name of the group to add as a default actor. This parameter cannot be used with the groupId parameter. As a group's name can change,use of groupId is recommended. This parameter accepts a comma-separated list. For example, "group":["project-admin", "jira-developers"]. |
parameters.groupId? | string[] | The ID of the group to add as a default actor. This parameter cannot be used with the group parameter This parameter accepts a comma-separated list. For example, "groupId":["77f6ab39-e755-4570-a6ae-2d7a8df0bcb8", "0c011f85-69ed-49c4-a801-3b18d0f771bc"]. |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
parameters.user? | string[] | The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For example, "user":["5b10a2844c20165700ede21g", "5b109f2e9729b51b54dc274d"]. |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projectRoleActors.deleteActor
ts
deleteActor: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { group?: string; groupId?: string; id: number; projectIdOrKey: string; user?: string; } | - |
parameters.group? | string | The name of the group to remove from the project role. This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended. |
parameters.groupId? | string | The ID of the group to remove from the project role. This parameter cannot be used with the group parameter. |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
parameters.user? | string | The user account ID of the user to remove from the project role. |
Returns
Promise<void>
projectRoleActors.deleteProjectRoleActorsFromRole
ts
deleteProjectRoleActorsFromRole: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { group?: string; groupId?: string; id: number; user?: string; } | - |
parameters.group? | string | The group name of the group to be removed as a default actor.This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended. |
parameters.groupId? | string | The group ID of the group to be removed as a default actor. This parameter cannot be used with the group parameter. |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
parameters.user? | string | The user account ID of the user to remove as a default actor. |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projectRoleActors.getProjectRoleActorsForRole
ts
getProjectRoleActorsForRole: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projectRoleActors.setActors
ts
setActors: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; categorisedActors?: Record<string, any>; id?: number; }; id: number; projectIdOrKey: string; } | - |
parameters.body | { [key: string]: unknown; categorisedActors?: Record<string, any>; id?: number; } | - |
parameters.body.categorisedActors? | Record<string, any> | The actors to add to the project role. Add groups using: - atlassian-group-role-actor and a list of group names. - atlassian-group-role-actor-id and a list of group IDs. As a group's name can change, use of atlassian-group-role-actor-id is recommended. For example, "atlassian-group-role-actor-id":["eef79f81-0b89-4fca-a736-4be531a10869","77f6ab39-e755-4570-a6ae-2d7a8df0bcb8"]. Add users using atlassian-user-role-actor and a list of account IDs. For example, "atlassian-user-role-actor":["12345678-9abc-def1-2345-6789abcdef12", "abcdef12-3456-789a-bcde-f123456789ab"]. |
parameters.body.id? | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projectRoles
ts
projectRoles: object;projectRoles.createProjectRole
ts
createProjectRole: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; name?: string; } | - |
parameters.description? | string | A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role. |
parameters.name? | string | The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role. |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projectRoles.deleteProjectRole
ts
deleteProjectRole: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; swap?: number; } | - |
parameters.id | number | The ID of the project role to delete. Use Get all project roles to get a list of project role IDs. |
parameters.swap? | number | The ID of the project role that will replace the one being deleted. The swap will attempt to swap the role in schemes (notifications, permissions, issue security), workflows, worklogs and comments. |
Returns
Promise<void>
projectRoles.fullyUpdateProjectRole
ts
fullyUpdateProjectRole: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; id: number; name?: string; } | - |
parameters.description? | string | A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role. |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
parameters.name? | string | The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role. |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projectRoles.getAllProjectRoles
ts
getAllProjectRoles: () => Promise<object[]>;Returns
Promise<object[]>
projectRoles.getProjectRole
ts
getProjectRole: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { excludeInactiveUsers?: boolean; id: number; projectIdOrKey: string; } | - |
parameters.excludeInactiveUsers? | boolean | Exclude inactive users. |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projectRoles.getProjectRoleById
ts
getProjectRoleById: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projectRoles.getProjectRoleDetails
ts
getProjectRoleDetails: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { currentMember?: boolean; excludeConnectAddons?: boolean; excludeOtherServiceRoles?: boolean; projectIdOrKey: string; } | - |
parameters.currentMember? | boolean | Whether the roles should be filtered to include only those the user is assigned to. |
parameters.excludeConnectAddons? | boolean | - |
parameters.excludeOtherServiceRoles? | boolean | Do not return the default JSM company-managed space from CSM spaces, or the default CSM roles from JSM spaces. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<object[]>
projectRoles.getProjectRoles
ts
getProjectRoles: (parameters) => Promise<Record<string, string>>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectIdOrKey: string; } | - |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<Record<string, string>>
projectRoles.partialUpdateProjectRole
ts
partialUpdateProjectRole: (parameters) => Promise<{
[key: string]: unknown;
actors?: object[];
admin?: boolean;
currentUserRole?: boolean;
default?: boolean;
description?: string;
id?: number;
name?: string;
roleConfigurable?: boolean;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
translatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; id: number; name?: string; } | - |
parameters.description? | string | A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role. |
parameters.id | number | The ID of the project role. Use Get all project roles to get a list of project role IDs. |
parameters.name? | string | The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role. |
Returns
Promise<{ [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }>
projects
ts
projects: object;projects.archiveProject
ts
archiveProject: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectIdOrKey: string; } | - |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<void>
projects.createProject
ts
createProject: (parameters) => Promise<{
[key: string]: unknown;
id: number;
key: string;
self: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED"; avatarId?: number; categoryId?: number; description?: string; fieldScheme?: number; issueSecurityScheme?: number; issueTypeScheme?: number; issueTypeScreenScheme?: number; key: string; leadAccountId: string; name: string; notificationScheme?: number; permissionScheme?: number; projectTemplateKey?: | string & object | "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban" | "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum" | "com.pyxis.greenhopper.jira:gh-simplified-basic" | "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic" | "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic" | "com.pyxis.greenhopper.jira:gh-cross-team-template" | "com.pyxis.greenhopper.jira:gh-cross-team-planning-template" | "com.atlassian.servicedesk:simplified-it-service-management" | "com.atlassian.servicedesk:simplified-it-service-management-basic" | "com.atlassian.servicedesk:simplified-it-service-management-operations" | "com.atlassian.servicedesk:simplified-internal-service-desk" | "com.atlassian.servicedesk:simplified-external-service-desk" | "com.atlassian.servicedesk:simplified-hr-service-desk" | "com.atlassian.servicedesk:simplified-facilities-service-desk" | "com.atlassian.servicedesk:simplified-legal-service-desk" | "com.atlassian.servicedesk:simplified-marketing-service-desk" | "com.atlassian.servicedesk:simplified-finance-service-desk" | "com.atlassian.servicedesk:simplified-analytics-service-desk" | "com.atlassian.servicedesk:simplified-design-service-desk" | "com.atlassian.servicedesk:simplified-sales-service-desk" | "com.atlassian.servicedesk:simplified-halp-service-desk" | "com.atlassian.servicedesk:next-gen-it-service-desk" | "com.atlassian.servicedesk:next-gen-hr-service-desk" | "com.atlassian.servicedesk:next-gen-legal-service-desk" | "com.atlassian.servicedesk:next-gen-marketing-service-desk" | "com.atlassian.servicedesk:next-gen-facilities-service-desk" | "com.atlassian.servicedesk:next-gen-analytics-service-desk" | "com.atlassian.servicedesk:next-gen-finance-service-desk" | "com.atlassian.servicedesk:next-gen-design-service-desk" | "com.atlassian.servicedesk:next-gen-sales-service-desk" | "com.atlassian.servicedesk:company-managed-blank-service-project" | "com.atlassian.servicedesk:company-managed-general-service-project" | "com.atlassian.servicedesk:team-managed-general-service-project" | "com.atlassian.jira-core-project-templates:jira-core-simplified-content-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval" | "com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking" | "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control" | "com.atlassian.jira-core-project-templates:jira-core-simplified-procurement" | "com.atlassian.jira-core-project-templates:jira-core-simplified-project-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment" | "com.atlassian.jira-core-project-templates:jira-core-simplified-task-" | "com.atlassian.jcs:customer-service-management"; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; url?: string; workflowScheme?: number; } | - |
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. |
parameters.description? | string | A brief description of the project. |
parameters.fieldScheme? | number | The ID of the field scheme for the project. Use the Get field schemes operation to get a list of field scheme IDs. If you specify the field scheme you cannot specify the project template key. |
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.issueTypeScheme? | number | The ID of the issue type scheme for the project. Use the Get all issue type schemes operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key. |
parameters.issueTypeScreenScheme? | number | The ID of the issue type screen scheme for the project. Use the Get all issue type screen schemes operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key. |
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. Either lead or leadAccountId must be set when creating a project. 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.projectTemplateKey? | | string & object | "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban" | "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum" | "com.pyxis.greenhopper.jira:gh-simplified-basic" | "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic" | "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic" | "com.pyxis.greenhopper.jira:gh-cross-team-template" | "com.pyxis.greenhopper.jira:gh-cross-team-planning-template" | "com.atlassian.servicedesk:simplified-it-service-management" | "com.atlassian.servicedesk:simplified-it-service-management-basic" | "com.atlassian.servicedesk:simplified-it-service-management-operations" | "com.atlassian.servicedesk:simplified-internal-service-desk" | "com.atlassian.servicedesk:simplified-external-service-desk" | "com.atlassian.servicedesk:simplified-hr-service-desk" | "com.atlassian.servicedesk:simplified-facilities-service-desk" | "com.atlassian.servicedesk:simplified-legal-service-desk" | "com.atlassian.servicedesk:simplified-marketing-service-desk" | "com.atlassian.servicedesk:simplified-finance-service-desk" | "com.atlassian.servicedesk:simplified-analytics-service-desk" | "com.atlassian.servicedesk:simplified-design-service-desk" | "com.atlassian.servicedesk:simplified-sales-service-desk" | "com.atlassian.servicedesk:simplified-halp-service-desk" | "com.atlassian.servicedesk:next-gen-it-service-desk" | "com.atlassian.servicedesk:next-gen-hr-service-desk" | "com.atlassian.servicedesk:next-gen-legal-service-desk" | "com.atlassian.servicedesk:next-gen-marketing-service-desk" | "com.atlassian.servicedesk:next-gen-facilities-service-desk" | "com.atlassian.servicedesk:next-gen-analytics-service-desk" | "com.atlassian.servicedesk:next-gen-finance-service-desk" | "com.atlassian.servicedesk:next-gen-design-service-desk" | "com.atlassian.servicedesk:next-gen-sales-service-desk" | "com.atlassian.servicedesk:company-managed-blank-service-project" | "com.atlassian.servicedesk:company-managed-general-service-project" | "com.atlassian.servicedesk:team-managed-general-service-project" | "com.atlassian.jira-core-project-templates:jira-core-simplified-content-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval" | "com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking" | "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control" | "com.atlassian.jira-core-project-templates:jira-core-simplified-procurement" | "com.atlassian.jira-core-project-templates:jira-core-simplified-project-management" | "com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment" | "com.atlassian.jira-core-project-templates:jira-core-simplified-task-" | "com.atlassian.jcs:customer-service-management" | A predefined configuration for a project. The type of the projectTemplateKey must match with the type of the projectTypeKey. |
parameters.projectTypeKey? | | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service" | The project type, which defines the application-specific feature set. If you don't specify the project template you have to specify the project type. |
parameters.url? | string | A link to information about this project, such as project documentation |
parameters.workflowScheme? | number | The ID of the workflow scheme for the project. Use the Get all workflow schemes operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key. |
Returns
Promise<{ [key: string]: unknown; id: number; key: string; self: string; }>
projects.deleteProject
ts
deleteProject: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { enableUndo?: boolean; projectIdOrKey: string; } | - |
parameters.enableUndo? | boolean | Whether this project is placed in the Jira recycle bin where it will be available for restoration. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<void>
projects.getAllStatuses
ts
getAllStatuses: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectIdOrKey: string; } | - |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<object[]>
projects.getHierarchy
ts
getHierarchy: (parameters) => Promise<{
[key: string]: unknown;
hierarchy?: object[];
projectId?: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectId: number; } | - |
parameters.projectId | number | The ID of the project. |
Returns
Promise<{ [key: string]: unknown; hierarchy?: object[]; projectId?: number; }>
projects.getNotificationSchemeForProject
ts
getNotificationSchemeForProject: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
expand?: string;
id?: number;
name?: string;
notificationSchemeEvents?: object[];
projects?: number[];
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[]; projectKeyOrId: string; } | - |
parameters.expand? | | string | string[] | string & object | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - all Returns all expandable information - field Returns information about any custom fields assigned to receive an event - group Returns information about any groups assigned to receive an event - notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information - projectRole Returns information about any project roles assigned to receive an event - user Returns information about any users assigned to receive an event |
parameters.projectKeyOrId | string | The project ID or project key (case sensitive). |
Returns
Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; notificationSchemeEvents?: object[]; projects?: number[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }>
projects.getProject
ts
getProject: (parameters) => 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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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, any>;
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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, any>;
self?: string;
simplified?: boolean;
style?: "classic" | string & object | "next-gen";
url?: string;
uuid?: string;
versions?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | "description" | string & object | "issueTypes" | "lead" | "issueTypeHierarchy" | "projectKeys")[]; projectIdOrKey: string; properties?: string[]; } | - |
parameters.expand? | | string | string[] | string & object | ( | "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. |
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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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, any>; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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, any>; self?: string; simplified?: boolean; style?: "classic" | string & object | "next-gen"; url?: string; uuid?: string; versions?: object[]; }>
projects.searchProjects
ts
searchProjects: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { action?: "view" | string & object | "edit" | "create" | "browse"; categoryId?: number; expand?: | string | string[] | string & object | ( | "url" | "description" | string & object | "issueTypes" | "lead" | "insight" | "projectKeys")[]; id?: number[]; keys?: string[]; maxResults?: number; orderBy?: | "name" | "key" | string & object | "category" | "owner" | "archivedDate" | "deletedDate" | "issueCount" | "-name" | "+name" | "-issueCount" | "+issueCount" | "-owner" | "+owner" | "-category" | "+category" | "-key" | "+key" | "lastIssueUpdatedDate" | "-lastIssueUpdatedDate" | "+lastIssueUpdatedDate" | "+archivedDate" | "-archivedDate" | "+deletedDate" | "-deletedDate"; properties?: object[]; propertyQuery?: string; query?: string; startAt?: number; status?: ("deleted" | "live" | string & object | "archived")[]; typeKey?: string | string[]; } | - |
parameters.action? | "view" | string & object | "edit" | "create" | "browse" | Filter results by projects for which the user can: - view the project, meaning that they have one of the following permissions: - Browse projects project permission for the project. - Administer projects project permission for the project. - Administer Jira global permission. - browse the project, meaning that they have the Browse projects project permission for the project. - edit the project, meaning that they have one of the following permissions: - Administer projects project permission for the project. - Administer Jira global permission. - create the project, meaning that they have the Create issues project permission for the project in which the issue is created. |
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. |
parameters.expand? | | string | string[] | string & object | ( | "url" | "description" | string & object | "issueTypes" | "lead" | "insight" | "projectKeys")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: - description Returns the project description. - projectKeys Returns all project keys associated with a project. - lead Returns information about the project lead. - issueTypes Returns all issue types associated with the project. - url Returns the URL associated with the project. - insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. |
parameters.id? | number[] | The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Up to 50 project IDs can be provided. |
parameters.keys? | string[] | The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&keys=PB. Up to 50 project keys can be provided. |
parameters.maxResults? | number | The maximum number of items to return per page. Must be less than or equal to 100. If a value greater than 100 is provided, the maxResults parameter will default to 100. |
parameters.orderBy? | | "name" | "key" | string & object | "category" | "owner" | "archivedDate" | "deletedDate" | "issueCount" | "-name" | "+name" | "-issueCount" | "+issueCount" | "-owner" | "+owner" | "-category" | "+category" | "-key" | "+key" | "lastIssueUpdatedDate" | "-lastIssueUpdatedDate" | "+lastIssueUpdatedDate" | "+archivedDate" | "-archivedDate" | "+deletedDate" | "-deletedDate" | Order the results by a field. - category Sorts by project category. A complete list of category IDs is found using Get all project categories. - issueCount Sorts by the total number of issues in each project. - key Sorts by project key. - lastIssueUpdatedTime Sorts by the last issue update time. - name Sorts by project name. - owner Sorts by project lead. - archivedDate EXPERIMENTAL. Sorts by project archived date. - deletedDate EXPERIMENTAL. Sorts by project deleted date. |
parameters.properties? | object[] | EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. |
parameters.propertyQuery? | string | EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties. |
parameters.query? | string | Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive). |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
parameters.status? | ("deleted" | "live" | string & object | "archived")[] | EXPERIMENTAL. Filter results by project status: - live Search live projects. - archived Search archived projects. - deleted Search deleted projects, those in the recycle bin. |
parameters.typeKey? | string | string[] | Orders results by the project type. This parameter accepts a comma-separated list. Valid values are business, service_desk, and software. |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
projects.updateProject
ts
updateProject: (parameters) => 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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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, any>;
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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, any>;
self?: string;
simplified?: boolean;
style?: "classic" | string & object | "next-gen";
url?: string;
uuid?: string;
versions?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED"; avatarId?: number; categoryId?: number; description?: string; expand?: | string | string[] | string & object | ( | "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? | | string | string[] | string & object | ( | "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 |
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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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, any>; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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, any>; self?: string; simplified?: boolean; style?: "classic" | string & object | "next-gen"; url?: string; uuid?: string; versions?: object[]; }>
projectTemplates
ts
projectTemplates: object;projectTemplates.createProjectWithCustomTemplate
ts
createProjectWithCustomTemplate: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { details?: { [key: string]: unknown; accessLevel?: "open" | "private" | string & object | "limited" | "free"; additionalProperties?: Record<string, any>; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; avatarId?: number; categoryId?: number; description?: string; enableComponents?: boolean; key?: string; language?: string; leadAccountId?: string; name?: string; url?: string; }; template?: { [key: string]: unknown; boardFeatures?: { [key: string]: unknown; boardFeatures?: Record<string, any>; }; boards?: { [key: string]: unknown; boards?: object[]; }; field?: { [key: string]: unknown; customFieldDefinitions?: object[] | null; fieldLayoutScheme?: { [key: string]: unknown; defaultFieldLayout?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; fieldScheme?: { [key: string]: unknown; description?: ... | ...; items?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; issueLayouts?: object[] | null; issueTypeScreenScheme?: { [key: string]: unknown; defaultScreenScheme?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; screens?: object[] | null; screenScheme?: object[] | null; }; issueType?: { [key: string]: unknown; issueTypeHierarchy?: object[] | null; issueTypes?: object[] | null; issueTypeScheme?: { [key: string]: unknown; defaultIssueTypeId?: ... | ...; description?: ... | ... | ...; issueTypeIds?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; }; notification?: { [key: string]: unknown; description?: string; name?: string; notificationSchemeEvents?: object[]; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; permissionScheme?: { [key: string]: unknown; addAddonRole?: boolean; description?: string; grants?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; project?: { [key: string]: unknown; fieldLayoutSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueSecuritySchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeScreenSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; notificationSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; permissionSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; workflowSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; role?: { [key: string]: unknown; roles?: object[]; roleToProjectActors?: Record<string, any>; }; scope?: { [key: string]: unknown; type?: string & object | "PROJECT" | "GLOBAL"; }; security?: { [key: string]: unknown; description?: string; name?: string; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; securityLevels?: object[]; }; workflow?: { [key: string]: unknown; statuses?: object[]; workflows?: object[]; workflowScheme?: { [key: string]: unknown; defaultWorkflow?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; }; }; } | - |
parameters.details? | { [key: string]: unknown; accessLevel?: "open" | "private" | string & object | "limited" | "free"; additionalProperties?: Record<string, any>; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; avatarId?: number; categoryId?: number; description?: string; enableComponents?: boolean; key?: string; language?: string; leadAccountId?: string; name?: string; url?: string; } | - |
parameters.details.accessLevel? | "open" | "private" | string & object | "limited" | "free" | The access level of the project. Only used by team-managed project |
parameters.details.additionalProperties? | Record<string, any> | Additional properties of the project |
parameters.details.assigneeType? | | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED" | The default assignee when creating issues in the project |
parameters.details.avatarId? | number | The ID of the project's avatar. Use the Get project avatars operation to list the available avatars in a project. |
parameters.details.categoryId? | number | The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. |
parameters.details.description? | string | Brief description of the project |
parameters.details.enableComponents? | boolean | Whether components are enabled for the project. Only used by company-managed project |
parameters.details.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.details.language? | string | The default language for the project |
parameters.details.leadAccountId? | string | The account ID of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with lead. |
parameters.details.name? | string | Name of the project |
parameters.details.url? | string | A link to information about this project, such as project documentation |
parameters.template? | { [key: string]: unknown; boardFeatures?: { [key: string]: unknown; boardFeatures?: Record<string, any>; }; boards?: { [key: string]: unknown; boards?: object[]; }; field?: { [key: string]: unknown; customFieldDefinitions?: object[] | null; fieldLayoutScheme?: { [key: string]: unknown; defaultFieldLayout?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; fieldScheme?: { [key: string]: unknown; description?: ... | ...; items?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; issueLayouts?: object[] | null; issueTypeScreenScheme?: { [key: string]: unknown; defaultScreenScheme?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; screens?: object[] | null; screenScheme?: object[] | null; }; issueType?: { [key: string]: unknown; issueTypeHierarchy?: object[] | null; issueTypes?: object[] | null; issueTypeScheme?: { [key: string]: unknown; defaultIssueTypeId?: ... | ...; description?: ... | ... | ...; issueTypeIds?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; }; notification?: { [key: string]: unknown; description?: string; name?: string; notificationSchemeEvents?: object[]; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; permissionScheme?: { [key: string]: unknown; addAddonRole?: boolean; description?: string; grants?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; project?: { [key: string]: unknown; fieldLayoutSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueSecuritySchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeScreenSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; notificationSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; permissionSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; workflowSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; role?: { [key: string]: unknown; roles?: object[]; roleToProjectActors?: Record<string, any>; }; scope?: { [key: string]: unknown; type?: string & object | "PROJECT" | "GLOBAL"; }; security?: { [key: string]: unknown; description?: string; name?: string; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; securityLevels?: object[]; }; workflow?: { [key: string]: unknown; statuses?: object[]; workflows?: object[]; workflowScheme?: { [key: string]: unknown; defaultWorkflow?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; }; } | - |
parameters.template.boardFeatures? | { [key: string]: unknown; boardFeatures?: Record<string, any>; } | - |
parameters.template.boardFeatures.boardFeatures? | Record<string, any> | A map of board PCRIs to the list of features to enable on each board. |
parameters.template.boards? | { [key: string]: unknown; boards?: object[]; } | - |
parameters.template.boards.boards? | object[] | The boards to be associated with the project. |
parameters.template.field? | { [key: string]: unknown; customFieldDefinitions?: object[] | null; fieldLayoutScheme?: { [key: string]: unknown; defaultFieldLayout?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; fieldScheme?: { [key: string]: unknown; description?: ... | ...; items?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; issueLayouts?: object[] | null; issueTypeScreenScheme?: { [key: string]: unknown; defaultScreenScheme?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; screens?: object[] | null; screenScheme?: object[] | null; } | - |
parameters.template.field.customFieldDefinitions? | object[] | null | The custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-post |
parameters.template.field.fieldLayoutScheme? | { [key: string]: unknown; defaultFieldLayout?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; } | - |
parameters.template.field.fieldLayoutScheme.defaultFieldLayout? | ... | ... | - |
parameters.template.field.fieldLayoutScheme.description? | ... | ... | The description of the field layout scheme |
parameters.template.field.fieldLayoutScheme.explicitMappings? | ... | ... | There is a default configuration "fieldlayout" that is applied to all issue types using this scheme that don't have an explicit mapping users can create (or re-use existing) configurations for other issue types and map them to this scheme |
parameters.template.field.fieldLayoutScheme.name? | ... | ... | The name of the field layout scheme |
parameters.template.field.fieldLayoutScheme.pcri? | ... | ... | - |
parameters.template.field.fieldScheme? | { [key: string]: unknown; description?: ... | ...; items?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; } | - |
parameters.template.field.fieldScheme.description? | ... | ... | The description of the field scheme |
parameters.template.field.fieldScheme.items? | ... | ... | The field association items for this field scheme. |
parameters.template.field.fieldScheme.name? | ... | ... | The name of the field scheme |
parameters.template.field.fieldScheme.onConflict? | ... | ... | ... | ... | ... | The strategy to use when there is a conflict with an existing field scheme. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters |
parameters.template.field.fieldScheme.pcri? | ... | ... | - |
parameters.template.field.issueLayouts? | object[] | null | The issue layouts configuration |
parameters.template.field.issueTypeScreenScheme? | { [key: string]: unknown; defaultScreenScheme?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; } | - |
parameters.template.field.issueTypeScreenScheme.defaultScreenScheme? | ... | ... | - |
parameters.template.field.issueTypeScreenScheme.description? | ... | ... | The description of the issue type screen scheme |
parameters.template.field.issueTypeScreenScheme.explicitMappings? | ... | ... | The IDs of the screen schemes for the issue type IDs and default. A default entry is required to create an issue type screen scheme, it defines the mapping for all issue types without a screen scheme. |
parameters.template.field.issueTypeScreenScheme.name? | ... | ... | The name of the issue type screen scheme |
parameters.template.field.issueTypeScreenScheme.pcri? | ... | ... | - |
parameters.template.field.screens? | object[] | null | The screens. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens/#api-rest-api-3-screens-post |
parameters.template.field.screenScheme? | object[] | null | The screen schemes See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes/#api-rest-api-3-screenscheme-post |
parameters.template.issueType? | { [key: string]: unknown; issueTypeHierarchy?: object[] | null; issueTypes?: object[] | null; issueTypeScheme?: { [key: string]: unknown; defaultIssueTypeId?: ... | ...; description?: ... | ... | ...; issueTypeIds?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; } | - |
parameters.template.issueType.issueTypeHierarchy? | object[] | null | Defines the issue type hierarhy to be created and used during this project creation. This will only add new levels if there isn't an existing level |
parameters.template.issueType.issueTypes? | object[] | null | Only needed if you want to create issue types, you can otherwise use the ids of issue types in the scheme configuration |
parameters.template.issueType.issueTypeScheme? | { [key: string]: unknown; defaultIssueTypeId?: ... | ...; description?: ... | ... | ...; issueTypeIds?: ... | ...; name?: ... | ...; pcri?: ... | ...; } | - |
parameters.template.issueType.issueTypeScheme.defaultIssueTypeId? | ... | ... | - |
parameters.template.issueType.issueTypeScheme.description? | ... | ... | ... | The description of the issue type scheme |
parameters.template.issueType.issueTypeScheme.issueTypeIds? | ... | ... | The issue type IDs for the issue type scheme |
parameters.template.issueType.issueTypeScheme.name? | ... | ... | The name of the issue type scheme |
parameters.template.issueType.issueTypeScheme.pcri? | ... | ... | - |
parameters.template.notification? | { [key: string]: unknown; description?: string; name?: string; notificationSchemeEvents?: object[]; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; } | - |
parameters.template.notification.description? | string | The description of the notification scheme |
parameters.template.notification.name? | string | The name of the notification scheme |
parameters.template.notification.notificationSchemeEvents? | object[] | The events and notifications for the notification scheme |
parameters.template.notification.onConflict? | string & object | "FAIL" | "USE" | "NEW" | The strategy to use when there is a conflict with an existing entity |
parameters.template.notification.pcri? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.notification.pcri.anID? | ... | ... | ... | - |
parameters.template.notification.pcri.areference? | ... | ... | ... | - |
parameters.template.notification.pcri.entityId? | ... | ... | - |
parameters.template.notification.pcri.entityType? | ... | ... | - |
parameters.template.notification.pcri.id? | ... | ... | - |
parameters.template.notification.pcri.type? | ... | ... | ... | ... | - |
parameters.template.permissionScheme? | { [key: string]: unknown; addAddonRole?: boolean; description?: string; grants?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; } | - |
parameters.template.permissionScheme.addAddonRole? | boolean | Configuration to generate addon role. Default is false if null. Only applies to GLOBAL-scoped permission scheme |
parameters.template.permissionScheme.description? | string | The description of the permission scheme |
parameters.template.permissionScheme.grants? | object[] | List of permission grants |
parameters.template.permissionScheme.name? | string | The name of the permission scheme |
parameters.template.permissionScheme.onConflict? | string & object | "FAIL" | "USE" | "NEW" | The strategy to use when there is a conflict with an existing permission scheme. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters; NEW - If the entity exist, try and create a new one with a different name |
parameters.template.permissionScheme.pcri? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.permissionScheme.pcri.anID? | ... | ... | ... | - |
parameters.template.permissionScheme.pcri.areference? | ... | ... | ... | - |
parameters.template.permissionScheme.pcri.entityId? | ... | ... | - |
parameters.template.permissionScheme.pcri.entityType? | ... | ... | - |
parameters.template.permissionScheme.pcri.id? | ... | ... | - |
parameters.template.permissionScheme.pcri.type? | ... | ... | ... | ... | - |
parameters.template.project? | { [key: string]: unknown; fieldLayoutSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueSecuritySchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeScreenSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; notificationSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; permissionSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; workflowSchemeId?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; } | - |
parameters.template.project.fieldLayoutSchemeId? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.project.fieldLayoutSchemeId.anID? | ... | ... | ... | - |
parameters.template.project.fieldLayoutSchemeId.areference? | ... | ... | ... | - |
parameters.template.project.fieldLayoutSchemeId.entityId? | ... | ... | - |
parameters.template.project.fieldLayoutSchemeId.entityType? | ... | ... | - |
parameters.template.project.fieldLayoutSchemeId.id? | ... | ... | - |
parameters.template.project.fieldLayoutSchemeId.type? | ... | ... | ... | ... | - |
parameters.template.project.issueSecuritySchemeId? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.project.issueSecuritySchemeId.anID? | ... | ... | ... | - |
parameters.template.project.issueSecuritySchemeId.areference? | ... | ... | ... | - |
parameters.template.project.issueSecuritySchemeId.entityId? | ... | ... | - |
parameters.template.project.issueSecuritySchemeId.entityType? | ... | ... | - |
parameters.template.project.issueSecuritySchemeId.id? | ... | ... | - |
parameters.template.project.issueSecuritySchemeId.type? | ... | ... | ... | ... | - |
parameters.template.project.issueTypeSchemeId? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.project.issueTypeSchemeId.anID? | ... | ... | ... | - |
parameters.template.project.issueTypeSchemeId.areference? | ... | ... | ... | - |
parameters.template.project.issueTypeSchemeId.entityId? | ... | ... | - |
parameters.template.project.issueTypeSchemeId.entityType? | ... | ... | - |
parameters.template.project.issueTypeSchemeId.id? | ... | ... | - |
parameters.template.project.issueTypeSchemeId.type? | ... | ... | ... | ... | - |
parameters.template.project.issueTypeScreenSchemeId? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.project.issueTypeScreenSchemeId.anID? | ... | ... | ... | - |
parameters.template.project.issueTypeScreenSchemeId.areference? | ... | ... | ... | - |
parameters.template.project.issueTypeScreenSchemeId.entityId? | ... | ... | - |
parameters.template.project.issueTypeScreenSchemeId.entityType? | ... | ... | - |
parameters.template.project.issueTypeScreenSchemeId.id? | ... | ... | - |
parameters.template.project.issueTypeScreenSchemeId.type? | ... | ... | ... | ... | - |
parameters.template.project.notificationSchemeId? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.project.notificationSchemeId.anID? | ... | ... | ... | - |
parameters.template.project.notificationSchemeId.areference? | ... | ... | ... | - |
parameters.template.project.notificationSchemeId.entityId? | ... | ... | - |
parameters.template.project.notificationSchemeId.entityType? | ... | ... | - |
parameters.template.project.notificationSchemeId.id? | ... | ... | - |
parameters.template.project.notificationSchemeId.type? | ... | ... | ... | ... | - |
parameters.template.project.pcri? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.project.pcri.anID? | ... | ... | ... | - |
parameters.template.project.pcri.areference? | ... | ... | ... | - |
parameters.template.project.pcri.entityId? | ... | ... | - |
parameters.template.project.pcri.entityType? | ... | ... | - |
parameters.template.project.pcri.id? | ... | ... | - |
parameters.template.project.pcri.type? | ... | ... | ... | ... | - |
parameters.template.project.permissionSchemeId? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.project.permissionSchemeId.anID? | ... | ... | ... | - |
parameters.template.project.permissionSchemeId.areference? | ... | ... | ... | - |
parameters.template.project.permissionSchemeId.entityId? | ... | ... | - |
parameters.template.project.permissionSchemeId.entityType? | ... | ... | - |
parameters.template.project.permissionSchemeId.id? | ... | ... | - |
parameters.template.project.permissionSchemeId.type? | ... | ... | ... | ... | - |
parameters.template.project.projectTypeKey? | | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service" | The project type, which defines the application-specific feature set. If you don't specify the project template you have to specify the project type. |
parameters.template.project.workflowSchemeId? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.project.workflowSchemeId.anID? | ... | ... | ... | - |
parameters.template.project.workflowSchemeId.areference? | ... | ... | ... | - |
parameters.template.project.workflowSchemeId.entityId? | ... | ... | - |
parameters.template.project.workflowSchemeId.entityType? | ... | ... | - |
parameters.template.project.workflowSchemeId.id? | ... | ... | - |
parameters.template.project.workflowSchemeId.type? | ... | ... | ... | ... | - |
parameters.template.role? | { [key: string]: unknown; roles?: object[]; roleToProjectActors?: Record<string, any>; } | - |
parameters.template.role.roles? | object[] | The list of roles to create. |
parameters.template.role.roleToProjectActors? | Record<string, any> | A map of role PCRI (can be ID or REF) to a list of user or group PCRI IDs to associate with the role and project. |
parameters.template.scope? | { [key: string]: unknown; type?: string & object | "PROJECT" | "GLOBAL"; } | - |
parameters.template.scope.type? | string & object | "PROJECT" | "GLOBAL" | The type of the scope. Use GLOBAL or empty for company-managed project, and PROJECT for team-managed project |
parameters.template.security? | { [key: string]: unknown; description?: string; name?: string; pcri?: { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; securityLevels?: object[]; } | - |
parameters.template.security.description? | string | The description of the security scheme |
parameters.template.security.name? | string | The name of the security scheme |
parameters.template.security.pcri? | { [key: string]: unknown; anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; } | - |
parameters.template.security.pcri.anID? | ... | ... | ... | - |
parameters.template.security.pcri.areference? | ... | ... | ... | - |
parameters.template.security.pcri.entityId? | ... | ... | - |
parameters.template.security.pcri.entityType? | ... | ... | - |
parameters.template.security.pcri.id? | ... | ... | - |
parameters.template.security.pcri.type? | ... | ... | ... | ... | - |
parameters.template.security.securityLevels? | object[] | The security levels for the security scheme |
parameters.template.workflow? | { [key: string]: unknown; statuses?: object[]; workflows?: object[]; workflowScheme?: { [key: string]: unknown; defaultWorkflow?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; } | - |
parameters.template.workflow.statuses? | object[] | The statuses for the workflow |
parameters.template.workflow.workflows? | object[] | The transitions for the workflow |
parameters.template.workflow.workflowScheme? | { [key: string]: unknown; defaultWorkflow?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; } | - |
parameters.template.workflow.workflowScheme.defaultWorkflow? | ... | ... | - |
parameters.template.workflow.workflowScheme.description? | ... | ... | The description of the workflow scheme |
parameters.template.workflow.workflowScheme.explicitMappings? | ... | ... | Association between issuetypes and workflows |
parameters.template.workflow.workflowScheme.name? | ... | ... | The name of the workflow scheme |
parameters.template.workflow.workflowScheme.onConflict? | ... | ... | ... | ... | ... | The strategy to use if there is a conflict with another workflow scheme |
parameters.template.workflow.workflowScheme.pcri? | ... | ... | - |
Returns
Promise<void>
projectTypes
ts
projectTypes: object;projectTypes.getAccessibleProjectTypeByKey
ts
getAccessibleProjectTypeByKey: (parameters) => Promise<{
[key: string]: unknown;
color?: string;
descriptionI18nKey?: string;
formattedKey?: string;
icon?: string;
key?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectTypeKey: | string & object | "software" | "service_desk" | "business" | "product_discovery"; } | - |
parameters.projectTypeKey | | string & object | "software" | "service_desk" | "business" | "product_discovery" | The key of the project type. |
Returns
Promise<{ [key: string]: unknown; color?: string; descriptionI18nKey?: string; formattedKey?: string; icon?: string; key?: string; }>
projectTypes.getAllAccessibleProjectTypes
ts
getAllAccessibleProjectTypes: () => Promise<object[]>;Returns
Promise<object[]>
projectTypes.getAllProjectTypes
ts
getAllProjectTypes: () => Promise<object[]>;Returns
Promise<object[]>
projectTypes.getProjectTypeByKey
ts
getProjectTypeByKey: (parameters) => Promise<{
[key: string]: unknown;
color?: string;
descriptionI18nKey?: string;
formattedKey?: string;
icon?: string;
key?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectTypeKey: | string & object | "software" | "service_desk" | "business" | "product_discovery"; } | - |
parameters.projectTypeKey | | string & object | "software" | "service_desk" | "business" | "product_discovery" | The key of the project type. |
Returns
Promise<{ [key: string]: unknown; color?: string; descriptionI18nKey?: string; formattedKey?: string; icon?: string; key?: string; }>
projectVersions
ts
projectVersions: object;projectVersions.createRelatedWork
ts
createRelatedWork: (parameters) => Promise<{
[key: string]: unknown;
category: string;
issueId?: number;
relatedWorkId?: string;
title?: string;
url?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { category: string; id: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; } | - |
parameters.category | string | The category of the related work |
parameters.id | string | - |
parameters.issueId? | number | The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API. |
parameters.relatedWorkId? | string | The id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it. |
parameters.title? | string | The title of the related work |
parameters.url? | string | The URL of the related work. Will be null for the native release note related work item, but is otherwise required. |
Returns
Promise<{ [key: string]: unknown; category: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; }>
projectVersions.createVersion
ts
createVersion: (parameters) => Promise<{
[key: string]: unknown;
approvers?: object[];
archived?: boolean;
description?: string;
driver?: string;
expand?: string;
id?: string;
issuesStatusForFixVersion?: {
[key: string]: unknown;
done?: number;
inProgress?: number;
toDo?: number;
unmapped?: number;
};
moveUnfixedIssuesTo?: string;
name?: string;
operations?: object[];
overdue?: boolean;
projectId?: number;
released?: boolean;
releaseDate?: string;
self?: string;
startDate?: string;
userReleaseDate?: string;
userStartDate?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { [key: string]: unknown; done?: number; inProgress?: number; toDo?: number; unmapped?: number; }; moveUnfixedIssuesTo?: string; name?: string; operations?: object[]; overdue?: boolean; projectId?: number; released?: boolean; releaseDate?: string; self?: string; startDate?: string; userReleaseDate?: string; userStartDate?: string; } | - |
parameters.approvers? | object[] | If the expand option approvers is used, returns a list containing the approvers for this version. |
parameters.archived? | boolean | Indicates that the version is archived. Optional when creating or updating a version. |
parameters.description? | string | The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes. |
parameters.driver? | string | The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option driver is used, returns the Atlassian account ID of the driver. |
parameters.expand? | string | Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: - operations Returns the list of operations available for this version. - issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done. - driver Returns the Atlassian account ID of the version driver. - approvers Returns a list containing approvers for this version. Optional for create and update. |
parameters.id? | string | The ID of the version. |
parameters.issuesStatusForFixVersion? | { [key: string]: unknown; done?: number; inProgress?: number; toDo?: number; unmapped?: number; } | - |
parameters.issuesStatusForFixVersion.done? | number | Count of issues with status done. |
parameters.issuesStatusForFixVersion.inProgress? | number | Count of issues with status in progress. |
parameters.issuesStatusForFixVersion.toDo? | number | Count of issues with status to do. |
parameters.issuesStatusForFixVersion.unmapped? | number | Count of issues with a status other than to do, in progress, and done. |
parameters.moveUnfixedIssuesTo? | string | The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version. |
parameters.name? | string | The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters. |
parameters.operations? | object[] | If the expand option operations is used, returns the list of operations available for this version. |
parameters.overdue? | boolean | Indicates that the version is overdue. |
parameters.projectId? | number | The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version. |
parameters.released? | boolean | Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version. |
parameters.releaseDate? | string | The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. |
parameters.self? | string | The URL of the version. |
parameters.startDate? | string | The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. |
parameters.userReleaseDate? | string | The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format. |
parameters.userStartDate? | string | The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format. |
Returns
Promise<{ [key: string]: unknown; approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { [key: string]: unknown; done?: number; inProgress?: number; toDo?: number; unmapped?: number; }; moveUnfixedIssuesTo?: string; name?: string; operations?: object[]; overdue?: boolean; projectId?: number; released?: boolean; releaseDate?: string; self?: string; startDate?: string; userReleaseDate?: string; userStartDate?: string; }>
projectVersions.deleteAndReplaceVersion
ts
deleteAndReplaceVersion: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { customFieldReplacementList?: object[]; id: string; moveAffectedIssuesTo?: number; moveFixIssuesTo?: number; } | - |
parameters.customFieldReplacementList? | object[] | An array of custom field IDs (customFieldId) and version IDs (moveTo) to update when the fields contain the deleted version. |
parameters.id | string | The ID of the version. |
parameters.moveAffectedIssuesTo? | number | The ID of the version to update affectedVersion to when the field contains the deleted version. |
parameters.moveFixIssuesTo? | number | The ID of the version to update fixVersion to when the field contains the deleted version. |
Returns
Promise<void>
projectVersions.deleteRelatedWork
ts
deleteRelatedWork: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { relatedWorkId: string; versionId: string; } | - |
parameters.relatedWorkId | string | The ID of the related work to delete. |
parameters.versionId | string | The ID of the version that the target related work belongs to. |
Returns
Promise<void>
projectVersions.getProjectVersions
ts
getProjectVersions: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | (string & object | "operations")[]; projectIdOrKey: string; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "operations")[] | Use expand to include additional information in the response. This parameter accepts operations, which returns actions that can be performed on the version. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<object[]>
projectVersions.getProjectVersionsPaginated
ts
getProjectVersionsPaginated: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | string & object | "approvers" | "driver" | "operations" | "issuesstatus")[]; maxResults?: number; orderBy?: | "name" | "description" | "sequence" | string & object | "releaseDate" | "startDate" | "-description" | "+description" | "-name" | "+name" | "-releaseDate" | "+releaseDate" | "-sequence" | "+sequence" | "-startDate" | "+startDate"; projectIdOrKey: string; query?: string; startAt?: number; status?: string | string[]; } | - |
parameters.expand? | | string | string[] | string & object | ( | string & object | "approvers" | "driver" | "operations" | "issuesstatus")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - issuesstatus Returns the number of issues in each status category for each version. - operations Returns actions that can be performed on the specified version. - driver Returns the Atlassian account ID of the version driver. - approvers Returns a list containing the approvers for this version. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | | "name" | "description" | "sequence" | string & object | "releaseDate" | "startDate" | "-description" | "+description" | "-name" | "+name" | "-releaseDate" | "+releaseDate" | "-sequence" | "+sequence" | "-startDate" | "+startDate" | Order the results by a field: - description Sorts by version description. - name Sorts by version name. - releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last. - sequence Sorts by the order of appearance in the user interface. - startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
parameters.query? | string | Filter the results using a literal string. Versions with matching name or description are returned (case insensitive). |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
parameters.status? | string | string[] | A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived. |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
projectVersions.getRelatedWork
ts
getRelatedWork: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the version. |
Returns
Promise<object[]>
projectVersions.getVersion
ts
getVersion: (parameters) => Promise<{
[key: string]: unknown;
approvers?: object[];
archived?: boolean;
description?: string;
driver?: string;
expand?: string;
id?: string;
issuesStatusForFixVersion?: {
[key: string]: unknown;
done?: number;
inProgress?: number;
toDo?: number;
unmapped?: number;
};
moveUnfixedIssuesTo?: string;
name?: string;
operations?: object[];
overdue?: boolean;
projectId?: number;
released?: boolean;
releaseDate?: string;
self?: string;
startDate?: string;
userReleaseDate?: string;
userStartDate?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | ( | string & object | "approvers" | "driver" | "operations" | "issuesstatus")[]; id: string; } | - |
parameters.expand? | | string | string[] | string & object | ( | string & object | "approvers" | "driver" | "operations" | "issuesstatus")[] | Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: - operations Returns the list of operations available for this version. - issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property represents the number of issues with a status other than to do, in progress, and done. - driver Returns the Atlassian account ID of the version driver. - approvers Returns a list containing the Atlassian account IDs of approvers for this version. |
parameters.id | string | The ID of the version. |
Returns
Promise<{ [key: string]: unknown; approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { [key: string]: unknown; done?: number; inProgress?: number; toDo?: number; unmapped?: number; }; moveUnfixedIssuesTo?: string; name?: string; operations?: object[]; overdue?: boolean; projectId?: number; released?: boolean; releaseDate?: string; self?: string; startDate?: string; userReleaseDate?: string; userStartDate?: string; }>
projectVersions.getVersionRelatedIssues
ts
getVersionRelatedIssues: (parameters) => Promise<{
[key: string]: unknown;
customFieldUsage?: object[];
issueCountWithCustomFieldsShowingVersion?: number;
issuesAffectedCount?: number;
issuesFixedCount?: number;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the version. |
Returns
Promise<{ [key: string]: unknown; customFieldUsage?: object[]; issueCountWithCustomFieldsShowingVersion?: number; issuesAffectedCount?: number; issuesFixedCount?: number; self?: string; }>
projectVersions.getVersionUnresolvedIssues
ts
getVersionUnresolvedIssues: (parameters) => Promise<{
[key: string]: unknown;
issuesCount?: number;
issuesUnresolvedCount?: number;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; } | - |
parameters.id | string | The ID of the version. |
Returns
Promise<{ [key: string]: unknown; issuesCount?: number; issuesUnresolvedCount?: number; self?: string; }>
projectVersions.mergeVersions
ts
mergeVersions: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; moveIssuesTo: string; } | - |
parameters.id | string | The ID of the version to delete. |
parameters.moveIssuesTo | string | The ID of the version to merge into. |
Returns
Promise<void>
projectVersions.moveVersion
ts
moveVersion: (parameters) => Promise<{
[key: string]: unknown;
approvers?: object[];
archived?: boolean;
description?: string;
driver?: string;
expand?: string;
id?: string;
issuesStatusForFixVersion?: {
[key: string]: unknown;
done?: number;
inProgress?: number;
toDo?: number;
unmapped?: number;
};
moveUnfixedIssuesTo?: string;
name?: string;
operations?: object[];
overdue?: boolean;
projectId?: number;
released?: boolean;
releaseDate?: string;
self?: string;
startDate?: string;
userReleaseDate?: string;
userStartDate?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { after?: string; id: string; position?: string & object | "Earlier" | "Later" | "First" | "Last"; } | - |
parameters.after? | string | The URL (self link) of the version after which to place the moved version. Cannot be used with position. |
parameters.id | string | The ID of the version to be moved. |
parameters.position? | string & object | "Earlier" | "Later" | "First" | "Last" | An absolute position in which to place the moved version. Cannot be used with after. |
Returns
Promise<{ [key: string]: unknown; approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { [key: string]: unknown; done?: number; inProgress?: number; toDo?: number; unmapped?: number; }; moveUnfixedIssuesTo?: string; name?: string; operations?: object[]; overdue?: boolean; projectId?: number; released?: boolean; releaseDate?: string; self?: string; startDate?: string; userReleaseDate?: string; userStartDate?: string; }>
projectVersions.updateRelatedWork
ts
updateRelatedWork: (parameters) => Promise<{
[key: string]: unknown;
category: string;
issueId?: number;
relatedWorkId?: string;
title?: string;
url?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { category: string; id: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; } | - |
parameters.category | string | The category of the related work |
parameters.id | string | The ID of the version to update the related work on. For the related work id, pass it to the input JSON. |
parameters.issueId? | number | The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API. |
parameters.relatedWorkId? | string | The id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it. |
parameters.title? | string | The title of the related work |
parameters.url? | string | The URL of the related work. Will be null for the native release note related work item, but is otherwise required. |
Returns
Promise<{ [key: string]: unknown; category: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; }>
projectVersions.updateVersion
ts
updateVersion: (parameters) => Promise<{
[key: string]: unknown;
approvers?: object[];
archived?: boolean;
description?: string;
driver?: string;
expand?: string;
id?: string;
issuesStatusForFixVersion?: {
[key: string]: unknown;
done?: number;
inProgress?: number;
toDo?: number;
unmapped?: number;
};
moveUnfixedIssuesTo?: string;
name?: string;
operations?: object[];
overdue?: boolean;
projectId?: number;
released?: boolean;
releaseDate?: string;
self?: string;
startDate?: string;
userReleaseDate?: string;
userStartDate?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { [key: string]: unknown; done?: number; inProgress?: number; toDo?: number; unmapped?: number; }; moveUnfixedIssuesTo?: string; name?: string; operations?: object[]; overdue?: boolean; projectId?: number; released?: boolean; releaseDate?: string; self?: string; startDate?: string; userReleaseDate?: string; userStartDate?: string; }; id: string; } | - |
parameters.body | { [key: string]: unknown; approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { [key: string]: unknown; done?: number; inProgress?: number; toDo?: number; unmapped?: number; }; moveUnfixedIssuesTo?: string; name?: string; operations?: object[]; overdue?: boolean; projectId?: number; released?: boolean; releaseDate?: string; self?: string; startDate?: string; userReleaseDate?: string; userStartDate?: string; } | - |
parameters.body.approvers? | object[] | If the expand option approvers is used, returns a list containing the approvers for this version. |
parameters.body.archived? | boolean | Indicates that the version is archived. Optional when creating or updating a version. |
parameters.body.description? | string | The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes. |
parameters.body.driver? | string | The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option driver is used, returns the Atlassian account ID of the driver. |
parameters.body.expand? | string | Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: - operations Returns the list of operations available for this version. - issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done. - driver Returns the Atlassian account ID of the version driver. - approvers Returns a list containing approvers for this version. Optional for create and update. |
parameters.body.id? | string | The ID of the version. |
parameters.body.issuesStatusForFixVersion? | { [key: string]: unknown; done?: number; inProgress?: number; toDo?: number; unmapped?: number; } | - |
parameters.body.issuesStatusForFixVersion.done? | number | Count of issues with status done. |
parameters.body.issuesStatusForFixVersion.inProgress? | number | Count of issues with status in progress. |
parameters.body.issuesStatusForFixVersion.toDo? | number | Count of issues with status to do. |
parameters.body.issuesStatusForFixVersion.unmapped? | number | Count of issues with a status other than to do, in progress, and done. |
parameters.body.moveUnfixedIssuesTo? | string | The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version. |
parameters.body.name? | string | The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters. |
parameters.body.operations? | object[] | If the expand option operations is used, returns the list of operations available for this version. |
parameters.body.overdue? | boolean | Indicates that the version is overdue. |
parameters.body.projectId? | number | The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version. |
parameters.body.released? | boolean | Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version. |
parameters.body.releaseDate? | string | The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. |
parameters.body.self? | string | The URL of the version. |
parameters.body.startDate? | string | The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. |
parameters.body.userReleaseDate? | string | The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format. |
parameters.body.userStartDate? | string | The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format. |
parameters.id | string | The ID of the version. |
Returns
Promise<{ [key: string]: unknown; approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { [key: string]: unknown; done?: number; inProgress?: number; toDo?: number; unmapped?: number; }; moveUnfixedIssuesTo?: string; name?: string; operations?: object[]; overdue?: boolean; projectId?: number; released?: boolean; releaseDate?: string; self?: string; startDate?: string; userReleaseDate?: string; userStartDate?: string; }>
screens
ts
screens: object;screens.addFieldToDefaultScreen
ts
addFieldToDefaultScreen: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldId: string; } | - |
parameters.fieldId | string | The ID of the field. |
Returns
Promise<void>
screens.getAvailableScreenFields
ts
getAvailableScreenFields: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { screenId: number; } | - |
parameters.screenId | number | The ID of the screen. |
Returns
Promise<object[]>
screens.getScreens
ts
getScreens: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { id?: number[]; maxResults?: number; orderBy?: "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"; queryString?: string; scope?: (string & object | "PROJECT" | "TEMPLATE" | "GLOBAL")[]; startAt?: number; } | - |
parameters.id? | number[] | The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id" | Order the results by a field: - id Sorts by screen ID. - name Sorts by screen name. |
parameters.queryString? | string | String used to perform a case-insensitive partial match with screen name. |
parameters.scope? | (string & object | "PROJECT" | "TEMPLATE" | "GLOBAL")[] | The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, scope=GLOBAL&scope=PROJECT. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
screens.getScreensForField
ts
getScreensForField: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | (string & object | "tab")[]; fieldId: string; maxResults?: number; startAt?: number; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "tab")[] | Use expand to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in. |
parameters.fieldId | string | The ID of the field to return screens for. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
screenSchemes
ts
screenSchemes: object;screenSchemes.createScreenScheme
ts
createScreenScheme: (parameters) => Promise<{
[key: string]: unknown;
id: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; name: string; screens?: { [key: string]: unknown; create?: number; default: number; edit?: number; view?: number; }; } | - |
parameters.description? | string | The description of the screen scheme. The maximum length is 255 characters. |
parameters.name | string | The name of the screen scheme. The name must be unique. The maximum length is 255 characters. |
parameters.screens? | { [key: string]: unknown; create?: number; default: number; edit?: number; view?: number; } | - |
parameters.screens.create? | number | The ID of the create screen. |
parameters.screens.default | number | The ID of the default screen. Required when creating a screen scheme. |
parameters.screens.edit? | number | The ID of the edit screen. |
parameters.screens.view? | number | The ID of the view screen. |
Returns
Promise<{ [key: string]: unknown; id: number; }>
screenSchemes.deleteScreenScheme
ts
deleteScreenScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { screenSchemeId: string; } | - |
parameters.screenSchemeId | string | The ID of the screen scheme. |
Returns
Promise<void>
screenSchemes.getScreenSchemes
ts
getScreenSchemes: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | (string & object | "issueTypeScreenSchemes")[]; id?: number[]; maxResults?: number; orderBy?: "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"; queryString?: string; startAt?: number; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "issueTypeScreenSchemes")[] | Use expand include additional information in the response. This parameter accepts issueTypeScreenSchemes that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to. |
parameters.id? | number[] | The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id" | Order the results by a field: - id Sorts by screen scheme ID. - name Sorts by screen scheme name. |
parameters.queryString? | string | String used to perform a case-insensitive partial match with screen scheme name. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
screenSchemes.updateScreenScheme
ts
updateScreenScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { description?: string; name?: string; screens?: { [key: string]: unknown; create?: string; default?: string; edit?: string; view?: string; }; screenSchemeId: string; } | - |
parameters.description? | string | The description of the screen scheme. The maximum length is 255 characters. |
parameters.name? | string | The name of the screen scheme. The name must be unique. The maximum length is 255 characters. |
parameters.screens? | { [key: string]: unknown; create?: string; default?: string; edit?: string; view?: string; } | - |
parameters.screens.create? | string | The ID of the create screen. To remove the screen association, pass a null. |
parameters.screens.default? | string | The ID of the default screen. When specified, must include a screen ID as a default screen is required. |
parameters.screens.edit? | string | The ID of the edit screen. To remove the screen association, pass a null. |
parameters.screens.view? | string | The ID of the view screen. To remove the screen association, pass a null. |
parameters.screenSchemeId | string | The ID of the screen scheme. |
Returns
Promise<void>
screenTabFields
ts
screenTabFields: object;screenTabFields.addScreenTabField
ts
addScreenTabField: (parameters) => Promise<{
[key: string]: unknown;
id?: string;
name?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { fieldId: string; screenId: number; skipFieldAssociation?: boolean; tabId: number; } | - |
parameters.fieldId | string | The ID of the field to add. |
parameters.screenId | number | The ID of the screen. |
parameters.skipFieldAssociation? | boolean | - |
parameters.tabId | number | The ID of the screen tab. |
Returns
Promise<{ [key: string]: unknown; id?: string; name?: string; }>
screenTabFields.getAllScreenTabFields
ts
getAllScreenTabFields: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectKey?: string; screenId: number; tabId: number; } | - |
parameters.projectKey? | string | The key of the project. |
parameters.screenId | number | The ID of the screen. |
parameters.tabId | number | The ID of the screen tab. |
Returns
Promise<object[]>
screenTabFields.moveScreenTabField
ts
moveScreenTabField: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { after?: string; id: string; position?: string & object | "Earlier" | "Later" | "First" | "Last"; screenId: number; tabId: number; } | - |
parameters.after? | string | The ID of the screen tab field after which to place the moved screen tab field. Required if position isn't provided. |
parameters.id | string | The ID of the field. |
parameters.position? | string & object | "Earlier" | "Later" | "First" | "Last" | The named position to which the screen tab field should be moved. Required if after isn't provided. |
parameters.screenId | number | The ID of the screen. |
parameters.tabId | number | The ID of the screen tab. |
Returns
Promise<void>
screenTabFields.removeScreenTabField
ts
removeScreenTabField: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string; screenId: number; tabId: number; } | - |
parameters.id | string | The ID of the field. |
parameters.screenId | number | The ID of the screen. |
parameters.tabId | number | The ID of the screen tab. |
Returns
Promise<void>
screenTabs
ts
screenTabs: object;screenTabs.addScreenTab
ts
addScreenTab: (parameters) => Promise<{
[key: string]: unknown;
id?: number;
name: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id?: number; name: string; screenId: number; } | - |
parameters.id? | number | The ID of the screen tab. |
parameters.name | string | The name of the screen tab. The maximum length is 255 characters. |
parameters.screenId | number | The ID of the screen. |
Returns
Promise<{ [key: string]: unknown; id?: number; name: string; }>
screenTabs.deleteScreenTab
ts
deleteScreenTab: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { screenId: number; tabId: number; } | - |
parameters.screenId | number | The ID of the screen. |
parameters.tabId | number | The ID of the screen tab. |
Returns
Promise<void>
screenTabs.getAllScreenTabs
ts
getAllScreenTabs: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectKey?: string; screenId: number; } | - |
parameters.projectKey? | string | The key of the project. |
parameters.screenId | number | The ID of the screen. |
Returns
Promise<object[]>
screenTabs.moveScreenTab
ts
moveScreenTab: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { pos: number; screenId: number; tabId: number; } | - |
parameters.pos | number | The position of tab. The base index is 0. |
parameters.screenId | number | The ID of the screen. |
parameters.tabId | number | The ID of the screen tab. |
Returns
Promise<void>
screenTabs.renameScreenTab
ts
renameScreenTab: (parameters) => Promise<{
[key: string]: unknown;
id?: number;
name: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id?: number; name: string; screenId: number; tabId: number; } | - |
parameters.id? | number | The ID of the screen tab. |
parameters.name | string | The name of the screen tab. The maximum length is 255 characters. |
parameters.screenId | number | The ID of the screen. |
parameters.tabId | number | The ID of the screen tab. |
Returns
Promise<{ [key: string]: unknown; id?: number; name: string; }>
serverInfo
ts
serverInfo: object;serverInfo.getServerInfo
ts
getServerInfo: () => Promise<{
[key: string]: unknown;
baseUrl?: string;
buildDate?: Date;
buildNumber?: number;
defaultLocale?: Record<string, any>;
deploymentType?: string;
displayUrl?: string;
displayUrlConfluence?: string;
displayUrlCSMHelpSeeker?: string;
displayUrlServicedeskHelpCenter?: string;
healthChecks?: object[];
scmInfo?: string;
serverTime?: Date;
serverTimeZone?: string;
serverTitle?: string;
version?: string;
versionNumbers?: number[];
}>;Returns
Promise<{ [key: string]: unknown; baseUrl?: string; buildDate?: Date; buildNumber?: number; defaultLocale?: Record<string, any>; deploymentType?: string; displayUrl?: string; displayUrlConfluence?: string; displayUrlCSMHelpSeeker?: string; displayUrlServicedeskHelpCenter?: string; healthChecks?: object[]; scmInfo?: string; serverTime?: Date; serverTimeZone?: string; serverTitle?: string; version?: string; versionNumbers?: number[]; }>
status
ts
status: object;status.createStatuses
ts
createStatuses: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { scope: { [key: string]: unknown; project?: { [key: string]: unknown; id: string; }; type: string & object | "PROJECT" | "GLOBAL"; }; statuses: object[]; } | - |
parameters.scope | { [key: string]: unknown; project?: { [key: string]: unknown; id: string; }; type: string & object | "PROJECT" | "GLOBAL"; } | - |
parameters.scope.project? | { [key: string]: unknown; id: string; } | - |
parameters.scope.project.id | string | The ID of the project. |
parameters.scope.type | string & object | "PROJECT" | "GLOBAL" | The scope of the status. GLOBAL for company-managed projects and PROJECT for team-managed projects. |
parameters.statuses | object[] | Details of the statuses being created. |
Returns
Promise<object[]>
status.deleteStatusesById
ts
deleteStatusesById: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string[]; } | - |
parameters.id | string[] | The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Min items 1, Max items 50 |
Returns
Promise<void>
status.getProjectIssueTypeUsagesForStatus
ts
getProjectIssueTypeUsagesForStatus: (parameters) => Promise<{
[key: string]: unknown;
issueTypes?: {
[key: string]: unknown;
nextPageToken?: string | null;
values?: object[];
};
projectId?: string;
statusId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; nextPageToken?: string; projectId: string; statusId: string; } | - |
parameters.maxResults? | number | The maximum number of results to return. Must be an integer between 1 and 200. |
parameters.nextPageToken? | string | The cursor for pagination |
parameters.projectId | string | The projectId to fetch issue type usages for |
parameters.statusId | string | The statusId to fetch issue type usages for |
Returns
Promise<{ [key: string]: unknown; issueTypes?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; projectId?: string; statusId?: string; }>
status.getProjectUsagesForStatus
ts
getProjectUsagesForStatus: (parameters) => Promise<{
[key: string]: unknown;
projects?: {
[key: string]: unknown;
nextPageToken?: string | null;
values?: object[];
};
statusId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; nextPageToken?: string; statusId: string; } | - |
parameters.maxResults? | number | The maximum number of results to return. Must be an integer between 1 and 200. |
parameters.nextPageToken? | string | The cursor for pagination |
parameters.statusId | string | The statusId to fetch project usages for |
Returns
Promise<{ [key: string]: unknown; projects?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; statusId?: string; }>
status.getStatusesById
ts
getStatusesById: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: string[]; } | - |
parameters.id | string[] | The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Min items 1, Max items 50 |
Returns
Promise<object[]>
status.getStatusesByName
ts
getStatusesByName: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { name: string[]; projectId?: string; } | - |
parameters.name | string[] | The list of status names. To include multiple names, provide an ampersand-separated list. For example, name=nameXX&name=nameYY. Min items 1, Max items 50 |
parameters.projectId? | string | The project the status is part of or null for global statuses. |
Returns
Promise<object[]>
status.getWorkflowUsagesForStatus
ts
getWorkflowUsagesForStatus: (parameters) => Promise<{
[key: string]: unknown;
statusId?: string;
workflows?: {
[key: string]: unknown;
nextPageToken?: string | null;
values?: object[];
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; nextPageToken?: string; statusId: string; } | - |
parameters.maxResults? | number | The maximum number of results to return. Must be an integer between 1 and 200. |
parameters.nextPageToken? | string | The cursor for pagination |
parameters.statusId | string | The statusId to fetch workflow usages for |
Returns
Promise<{ [key: string]: unknown; statusId?: string; workflows?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; }>
status.search
ts
search: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { includeGlobalStatuses?: boolean; maxResults?: number; projectId?: string; searchString?: string; startAt?: number; statusCategory?: string; } | - |
parameters.includeGlobalStatuses? | boolean | Whether to include global statuses (scope = null, not tied to any project) in the response. Defaults to false. Only relevant for project scoped queries. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectId? | string | The project the status is part of or null for global statuses. |
parameters.searchString? | string | Term to match status names against or null to search for all statuses in the search scope. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
parameters.statusCategory? | string | Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE. |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
status.updateStatuses
ts
updateStatuses: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { statuses: object[]; } | - |
parameters.statuses | object[] | The list of statuses that will be updated. |
Returns
Promise<void>
tasks
ts
tasks: object;tasks.getTask
ts
getTask: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
elapsedRuntime: number;
finished?: number;
id: string;
lastUpdate: number;
message?: string;
progress: number;
result?: unknown;
self: string;
started?: number;
status: | string & object
| "ENQUEUED"
| "RUNNING"
| "COMPLETE"
| "FAILED"
| "CANCEL_REQUESTED"
| "CANCELLED"
| "DEAD";
submitted: number;
submittedBy: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { taskId: string; } | - |
parameters.taskId | string | The ID of the task. |
Returns
Promise<{ [key: string]: unknown; description?: string; elapsedRuntime: number; finished?: number; id: string; lastUpdate: number; message?: string; progress: number; result?: unknown; self: string; started?: number; status: | string & object | "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD"; submitted: number; submittedBy: number; }>
timeTracking
ts
timeTracking: object;timeTracking.getAvailableTimeTrackingImplementations
ts
getAvailableTimeTrackingImplementations: () => Promise<object[]>;Returns
Promise<object[]>
timeTracking.getSelectedTimeTrackingImplementation
ts
getSelectedTimeTrackingImplementation: () => Promise<void>;Returns
Promise<void>
timeTracking.getSharedTimeTrackingConfiguration
ts
getSharedTimeTrackingConfiguration: () => Promise<{
[key: string]: unknown;
defaultUnit: "day" | "hour" | "minute" | "week" | string & object;
timeFormat: "days" | "hours" | string & object | "pretty";
workingDaysPerWeek: number;
workingHoursPerDay: number;
}>;Returns
Promise<{ [key: string]: unknown; defaultUnit: "day" | "hour" | "minute" | "week" | string & object; timeFormat: "days" | "hours" | string & object | "pretty"; workingDaysPerWeek: number; workingHoursPerDay: number; }>
timeTracking.selectTimeTrackingImplementation
ts
selectTimeTrackingImplementation: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { key: string; name?: string; url?: string; } | - |
parameters.key | string | The key for the time tracking provider. For example, JIRA. |
parameters.name? | string | The name of the time tracking provider. For example, JIRA provided time tracking. |
parameters.url? | string | The URL of the configuration page for the time tracking provider app. For example, /example/config/url. This property is only returned if the adminPageKey property is set in the module descriptor of the time tracking provider app. |
Returns
Promise<void>
timeTracking.setSharedTimeTrackingConfiguration
ts
setSharedTimeTrackingConfiguration: (parameters) => Promise<{
[key: string]: unknown;
defaultUnit: "day" | "hour" | "minute" | "week" | string & object;
timeFormat: "days" | "hours" | string & object | "pretty";
workingDaysPerWeek: number;
workingHoursPerDay: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { defaultUnit: "day" | "hour" | "minute" | "week" | string & object; timeFormat: "days" | "hours" | string & object | "pretty"; workingDaysPerWeek: number; workingHoursPerDay: number; } | - |
parameters.defaultUnit | "day" | "hour" | "minute" | "week" | string & object | The default unit of time applied to logged time. |
parameters.timeFormat | "days" | "hours" | string & object | "pretty" | The format that will appear on an issue's Time Spent field. |
parameters.workingDaysPerWeek | number | The number of days in a working week. |
parameters.workingHoursPerDay | number | The number of hours in a working day. |
Returns
Promise<{ [key: string]: unknown; defaultUnit: "day" | "hour" | "minute" | "week" | string & object; timeFormat: "days" | "hours" | string & object | "pretty"; workingDaysPerWeek: number; workingHoursPerDay: number; }>
uiModificationsApps
ts
uiModificationsApps: object;uiModificationsApps.createUiModification
ts
createUiModification: (parameters) => Promise<{
[key: string]: unknown;
id: string;
self: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contexts?: object[]; data?: string; description?: string; name: string; } | - |
parameters.contexts? | object[] | List of contexts of the UI modification. The maximum number of contexts is 1000. |
parameters.data? | string | The data of the UI modification. The maximum size of the data is 50000 characters. |
parameters.description? | string | The description of the UI modification. The maximum length is 255 characters. |
parameters.name | string | The name of the UI modification. The maximum length is 255 characters. |
Returns
Promise<{ [key: string]: unknown; id: string; self: string; }>
uiModificationsApps.deleteUiModification
ts
deleteUiModification: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { uiModificationId: string; } | - |
parameters.uiModificationId | string | The ID of the UI modification. |
Returns
Promise<void>
uiModificationsApps.getUiModifications
ts
getUiModifications: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | ("data" | string & object | "contexts")[]; maxResults?: number; startAt?: number; } | - |
parameters.expand? | | string | string[] | string & object | ("data" | string & object | "contexts")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - data Returns UI modification data. - contexts Returns UI modification contexts. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
uiModificationsApps.updateUiModification
ts
updateUiModification: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { contexts?: object[]; data?: string; description?: string; name?: string; uiModificationId: string; } | - |
parameters.contexts? | object[] | List of contexts of the UI modification. The maximum number of contexts is 1000. If provided, replaces all existing contexts. |
parameters.data? | string | The data of the UI modification. The maximum size of the data is 50000 characters. |
parameters.description? | string | The description of the UI modification. The maximum length is 255 characters. |
parameters.name? | string | The name of the UI modification. The maximum length is 255 characters. |
parameters.uiModificationId | string | The ID of the UI modification. |
Returns
Promise<void>
userProperties
ts
userProperties: object;userProperties.deleteUserProperty
ts
deleteUserProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; propertyKey: string; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.propertyKey | string | The key of the user's property. |
Returns
Promise<void>
userProperties.getUserProperty
ts
getUserProperty: (parameters) => Promise<{
[key: string]: unknown;
key?: string;
value?: unknown;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; propertyKey: string; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.propertyKey | string | The key of the user's property. |
Returns
Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>
userProperties.getUserPropertyKeys
ts
getUserPropertyKeys: (parameters?) => Promise<{
[key: string]: unknown;
keys?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { accountId?: string; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
Returns
Promise<{ [key: string]: unknown; keys?: object[]; }>
userProperties.setUserProperty
ts
setUserProperty: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; body: Record<string, any>; propertyKey: string; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.body | Record<string, any> | - |
parameters.propertyKey | string | The key of the user's property. The maximum length is 255 characters. |
Returns
Promise<void>
users
ts
users: object;users.createUser
ts
createUser: (parameters) => Promise<{
[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;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { emailAddress: string; products: string[]; self?: string; } | - |
parameters.emailAddress | string | The email address for the user. |
parameters.products | string[] | Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. To create a user without product access, set this field to be an empty array. |
parameters.self? | string | The URL of the user. |
Returns
Promise<{ [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; }>
users.getAllUsers
ts
getAllUsers: (parameters?) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: string; maxResults?: number; startAt?: number; } | - |
parameters.expand? | string | - |
parameters.maxResults? | number | The maximum number of items to return (limited to 1000). |
parameters.startAt? | number | The index of the first item to return. |
Returns
Promise<object[]>
users.getAllUsersDefault
ts
getAllUsersDefault: (parameters?) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: string; maxResults?: number; startAt?: number; } | - |
parameters.expand? | string | - |
parameters.maxResults? | number | The maximum number of items to return (limited to 1000). |
parameters.startAt? | number | The index of the first item to return. |
Returns
Promise<object[]>
users.getUser
ts
getUser: (parameters?) => Promise<{
[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;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { accountId?: string; expand?: | string | string[] | string & object | ("groups" | string & object | "applicationRoles")[]; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required. |
parameters.expand? | | string | string[] | string & object | ("groups" | string & object | "applicationRoles")[] | Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: - groups includes all groups and nested groups to which the user belongs. - applicationRoles includes details of all the applications to which the user has access. |
Returns
Promise<{ [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; }>
users.getUserDefaultColumns
ts
getUserDefaultColumns: (parameters?) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { accountId?: string; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
Returns
Promise<object[]>
users.getUserEmail
ts
getUserEmail: (parameters) => Promise<{
[key: string]: unknown;
accountId?: string;
email?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId: string; } | - |
parameters.accountId | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
Returns
Promise<{ [key: string]: unknown; accountId?: string; email?: string; }>
users.getUserEmailBulk
ts
getUserEmailBulk: (parameters) => Promise<{
[key: string]: unknown;
accountId?: string;
email?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId: string[]; } | - |
parameters.accountId | string[] | The account IDs of the users for which emails are required. An accountId is an identifier that uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value). |
Returns
Promise<{ [key: string]: unknown; accountId?: string; email?: string; }>
users.getUserGroups
ts
getUserGroups: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId: string; } | - |
parameters.accountId | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
Returns
Promise<object[]>
users.removeUser
ts
removeUser: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId: string; } | - |
parameters.accountId | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
Returns
Promise<void>
users.resetUserColumns
ts
resetUserColumns: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
Returns
Promise<void>
users.setUserColumns
ts
setUserColumns: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; body: Record<string, any>; } | - |
parameters.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
parameters.body | Record<string, any> | - |
Returns
Promise<void>
userSearch
ts
userSearch: object;userSearch.findAssignableUsers
ts
findAssignableUsers: (parameters?) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { accountId?: string; accountType?: string[]; actionDescriptorId?: number; appType?: string[]; issueId?: string; issueKey?: string; maxResults?: number; project?: string; query?: string; recommend?: boolean; sessionId?: string; startAt?: number; } | - |
parameters.accountId? | string | A query string that is matched exactly against user accountId. Required, unless query is specified. |
parameters.accountType? | string[] | - |
parameters.actionDescriptorId? | number | The ID of the transition. |
parameters.appType? | string[] | - |
parameters.issueId? | string | The ID of the issue. Required, unless issueKey or project is specified. |
parameters.issueKey? | string | The key of the issue. Required, unless issueId or project is specified. |
parameters.maxResults? | number | The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue. |
parameters.project? | string | The project ID or project key (case sensitive). Required, unless issueKey or issueId is specified. |
parameters.query? | string | A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless username or accountId is specified. |
parameters.recommend? | boolean | - |
parameters.sessionId? | string | The sessionId of this request. SessionId is the same until the assignee is set. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<object[]>
userSearch.findBulkAssignableUsers
ts
findBulkAssignableUsers: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; maxResults?: number; projectKeys: string | string[]; query?: string; startAt?: number; } | - |
parameters.accountId? | string | A query string that is matched exactly against user accountId. Required, unless query is specified. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectKeys | string | string[] | A list of project keys (case sensitive). This parameter accepts a comma-separated list. |
parameters.query? | string | A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<object[]>
userSearch.findUserKeysByQuery
ts
findUserKeysByQuery: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResult?: number; query: string; startAt?: number; } | - |
parameters.maxResult? | number | The maximum number of items to return per page. |
parameters.query | string | The search query. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
userSearch.findUsers
ts
findUsers: (parameters?) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { accountId?: string; maxResults?: number; property?: string; query?: string; startAt?: number; username?: string; } | - |
parameters.accountId? | string | A query string that is matched exactly against a user accountId. Required, unless query or property is specified. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.property? | string | A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified. |
parameters.query? | string | A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId or property is specified. |
parameters.startAt? | number | The index of the first item to return in a page of filtered results (page offset). |
parameters.username? | string | - |
Returns
Promise<object[]>
userSearch.findUsersByQuery
ts
findUsersByQuery: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; query: string; startAt?: number; } | - |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.query | string | The search query. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
userSearch.findUsersForPicker
ts
findUsersForPicker: (parameters) => Promise<{
[key: string]: unknown;
header?: string;
total?: number;
users?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { avatarSize?: string; excludeAccountIds?: string[]; excludeConnectUsers?: boolean; maxResults?: number; query: string; showAvatar?: boolean; } | - |
parameters.avatarSize? | string | - |
parameters.excludeAccountIds? | string[] | A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude. |
parameters.excludeConnectUsers? | boolean | - |
parameters.maxResults? | number | The maximum number of items to return. The total number of matched users is returned in total. |
parameters.query | string | A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. |
parameters.showAvatar? | boolean | Include the URI to the user's avatar. |
Returns
Promise<{ [key: string]: unknown; header?: string; total?: number; users?: object[]; }>
userSearch.findUsersWithAllPermissions
ts
findUsersWithAllPermissions: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { accountId?: string; issueKey?: string; maxResults?: number; permissions: string; projectKey?: string; query?: string; startAt?: number; } | - |
parameters.accountId? | string | A query string that is matched exactly against user accountId. Required, unless query is specified. |
parameters.issueKey? | string | The issue key for the issue. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.permissions | string | A comma separated list of permissions. Permissions can be specified as any: - Permission returned by Get all permissions. - Custom project permission added by Connect apps. - (deprecated) one of the following: - ASSIGNABLE_USER - ASSIGN_ISSUE - ATTACHMENT_DELETE_ALL - ATTACHMENT_DELETE_OWN - BROWSE - CLOSE_ISSUE - COMMENT_DELETE_ALL - COMMENT_DELETE_OWN - COMMENT_EDIT_ALL - COMMENT_EDIT_OWN - COMMENT_ISSUE - CREATE_ATTACHMENT - CREATE_ISSUE - DELETE_ISSUE - EDIT_ISSUE - LINK_ISSUE - MANAGE_WATCHER_LIST - MODIFY_REPORTER - MOVE_ISSUE - PROJECT_ADMIN - RESOLVE_ISSUE - SCHEDULE_ISSUE - SET_ISSUE_SECURITY - TRANSITION_ISSUE - VIEW_VERSION_CONTROL - VIEW_VOTERS_AND_WATCHERS - VIEW_WORKFLOW_READONLY - WORKLOG_DELETE_ALL - WORKLOG_DELETE_OWN - WORKLOG_EDIT_ALL - WORKLOG_EDIT_OWN - WORK_ISSUE |
parameters.projectKey? | string | The project key for the project (case sensitive). |
parameters.query? | string | A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<object[]>
userSearch.findUsersWithBrowsePermission
ts
findUsersWithBrowsePermission: (parameters?) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { accountId?: string; issueKey?: string; maxResults?: number; projectKey?: string; query?: string; startAt?: number; } | - |
parameters.accountId? | string | A query string that is matched exactly against user accountId. Required, unless query is specified. |
parameters.issueKey? | string | The issue key for the issue. Required, unless projectKey is specified. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.projectKey? | string | The project key for the project (case sensitive). Required, unless issueKey is specified. |
parameters.query? | string | A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<object[]>
webhooks
ts
webhooks: object;webhooks.deleteWebhookById
ts
deleteWebhookById: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { webhookIds: number[]; } | - |
parameters.webhookIds | number[] | A list of webhook IDs. |
Returns
Promise<void>
webhooks.getDynamicWebhooksForApp
ts
getDynamicWebhooksForApp: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { maxResults?: number; startAt?: number; } | - |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
webhooks.refreshWebhooks
ts
refreshWebhooks: (parameters) => Promise<{
[key: string]: unknown;
expirationDate: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { webhookIds: number[]; } | - |
parameters.webhookIds | number[] | A list of webhook IDs. |
Returns
Promise<{ [key: string]: unknown; expirationDate: number; }>
webhooks.registerDynamicWebhooks
ts
registerDynamicWebhooks: (parameters) => Promise<{
[key: string]: unknown;
webhookRegistrationResult?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { url: string; webhooks: object[]; } | - |
parameters.url | string | The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app. Only a single URL per app is allowed to be registered. |
parameters.webhooks | object[] | A list of webhooks. |
Returns
Promise<{ [key: string]: unknown; webhookRegistrationResult?: object[]; }>
workflows
ts
workflows: object;workflows.createWorkflows
ts
createWorkflows: (parameters) => Promise<{
[key: string]: unknown;
statuses?: object[];
workflows?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { scope?: { [key: string]: unknown; project?: { [key: string]: unknown; id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }; statuses?: object[]; workflows?: object[]; } | - |
parameters.scope? | { [key: string]: unknown; project?: { [key: string]: unknown; id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; } | - |
parameters.scope.project? | { [key: string]: unknown; id: string; } | - |
parameters.scope.project.id | string | The ID of the project. |
parameters.scope.type? | string & object | "PROJECT" | "GLOBAL" | The scope of the workflow. GLOBAL for company-managed projects and PROJECT for team-managed projects. |
parameters.statuses? | object[] | The statuses to associate with the workflows. |
parameters.workflows? | object[] | The details of the workflows to create. |
Returns
Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>
workflows.deleteInactiveWorkflow
ts
deleteInactiveWorkflow: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { entityId: string; } | - |
parameters.entityId | string | The entity ID of the workflow. |
Returns
Promise<void>
workflows.getDefaultEditor
ts
getDefaultEditor: () => Promise<{
[key: string]: unknown;
value?: string & object | "NEW" | "LEGACY";
}>;Returns
Promise<{ [key: string]: unknown; value?: string & object | "NEW" | "LEGACY"; }>
workflows.getProjectUsagesForWorkflow
ts
getProjectUsagesForWorkflow: (parameters) => Promise<{
[key: string]: unknown;
projects?: {
[key: string]: unknown;
nextPageToken?: string | null;
values?: object[];
};
workflowId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; nextPageToken?: string; workflowId: string; } | - |
parameters.maxResults? | number | The maximum number of results to return. Must be an integer between 1 and 200. |
parameters.nextPageToken? | string | The cursor for pagination |
parameters.workflowId | string | The workflow ID |
Returns
Promise<{ [key: string]: unknown; projects?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; workflowId?: string; }>
workflows.getWorkflowProjectIssueTypeUsages
ts
getWorkflowProjectIssueTypeUsages: (parameters) => Promise<{
[key: string]: unknown;
issueTypes?: {
[key: string]: unknown;
nextPageToken?: string | null;
values?: object[];
};
projectId?: string;
workflowId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; nextPageToken?: string; projectId: number; workflowId: string; } | - |
parameters.maxResults? | number | The maximum number of results to return. Must be an integer between 1 and 200. |
parameters.nextPageToken? | string | The cursor for pagination |
parameters.projectId | number | The project ID |
parameters.workflowId | string | The workflow ID |
Returns
Promise<{ [key: string]: unknown; issueTypes?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; projectId?: string; workflowId?: string; }>
workflows.getWorkflowSchemeUsagesForWorkflow
ts
getWorkflowSchemeUsagesForWorkflow: (parameters) => Promise<{
[key: string]: unknown;
workflowId?: string;
workflowSchemes?: {
[key: string]: unknown;
nextPageToken?: string | null;
values?: object[];
};
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; nextPageToken?: string; workflowId: string; } | - |
parameters.maxResults? | number | The maximum number of results to return. Must be an integer between 1 and 200. |
parameters.nextPageToken? | string | The cursor for pagination |
parameters.workflowId | string | The workflow ID |
Returns
Promise<{ [key: string]: unknown; workflowId?: string; workflowSchemes?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; }>
workflows.listWorkflowHistory
ts
listWorkflowHistory: (parameters) => Promise<{
[key: string]: unknown;
entries?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { expand?: | string | string[] | string & object | (string & object | "includeIntermediateWorkflows")[]; workflowId?: string; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "includeIntermediateWorkflows")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - includeIntermediateWorkflows Includes intermediate workflow versions that are sometimes created during workflow updates or migrations. By default, these are omitted from the response. |
parameters.workflowId? | string | The id of the workflow to read the history for. |
Returns
Promise<{ [key: string]: unknown; entries?: object[]; }>
workflows.readWorkflowFromHistory
ts
readWorkflowFromHistory: (parameters) => Promise<{
[key: string]: unknown;
statuses?: object[];
workflows?: object[];
}>;Parameters
| Parameter | Type |
|---|---|
parameters | { version?: number; workflowId?: string; } |
parameters.version? | number |
parameters.workflowId? | string |
Returns
Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>
workflows.readWorkflowPreviews
ts
readWorkflowPreviews: (parameters) => Promise<{
[key: string]: unknown;
statuses?: object[];
workflows?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { issueTypeIds?: string[]; projectId: string; workflowIds?: string[]; workflowNames?: string[]; } | - |
parameters.issueTypeIds? | string[] | The list of issue type IDs. At most 25 issue type IDs can be specified. |
parameters.projectId | string | The projectId parameter is required and will be used for permission checks. In addition, you must supply at least one of the following lookup terms: workflowNames, workflowIds, or issueTypeIds. The specified workflows must be associated with the given project. |
parameters.workflowIds? | string[] | The list of workflow IDs to be returned. At most 25 workflow IDs can be specified. |
parameters.workflowNames? | string[] | The list of workflow names to be returned. At most 25 workflow names can be specified. |
Returns
Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>
workflows.readWorkflows
ts
readWorkflows: (parameters) => Promise<{
[key: string]: unknown;
statuses?: object[];
workflows?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectAndIssueTypes?: object[]; workflowIds?: string[]; workflowNames?: string[]; } | - |
parameters.projectAndIssueTypes? | object[] | The list of projects and issue types to query. |
parameters.workflowIds? | string[] | The list of workflow IDs to query. |
parameters.workflowNames? | string[] | The list of workflow names to query. |
Returns
Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>
workflows.searchWorkflows
ts
searchWorkflows: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
statuses?: object[];
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { expand?: | string | string[] | string & object | (string & object | "values.transitions")[]; isActive?: boolean; maxResults?: number; orderBy?: string; projectId?: number; queryString?: string; scope?: string; startAt?: number; } | - |
parameters.expand? | | string | string[] | string & object | (string & object | "values.transitions")[] | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - values.transitions Returns the transitions that each workflow is associated with. |
parameters.isActive? | boolean | Filters active and inactive workflows. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.orderBy? | string | Order the results by a field: - name Sorts by workflow name. - created Sorts by create time. - updated Sorts by update time. |
parameters.projectId? | number | The ID of the project to filter the workflows by. Only workflows associated with the given project are returned. |
parameters.queryString? | string | String used to perform a case-insensitive partial match with workflow name. |
parameters.scope? | string | The scope of the workflow. Global for company-managed projects and Project for team-managed projects. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; statuses?: object[]; total?: number; values?: object[]; }>
workflows.updateWorkflows
ts
updateWorkflows: (parameters) => Promise<{
[key: string]: unknown;
statuses?: object[];
taskId?: string | null;
workflows?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { statuses?: object[]; workflows?: object[]; } | - |
parameters.statuses? | object[] | The statuses to associate with the workflows. |
parameters.workflows? | object[] | The details of the workflows to update. |
Returns
Promise<{ [key: string]: unknown; statuses?: object[]; taskId?: string | null; workflows?: object[]; }>
workflows.validateCreateWorkflows
ts
validateCreateWorkflows: (parameters) => Promise<{
[key: string]: unknown;
errors?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { payload: { [key: string]: unknown; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }; statuses?: object[]; workflows?: object[]; }; validationOptions?: { [key: string]: unknown; levels?: (string & object | "WARNING" | "ERROR")[]; }; } | - |
parameters.payload | { [key: string]: unknown; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }; statuses?: object[]; workflows?: object[]; } | - |
parameters.payload.scope? | { [key: string]: unknown; project?: { [key: string]: unknown; id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; } | - |
parameters.payload.scope.project? | { [key: string]: unknown; id: string; } | - |
parameters.payload.scope.project.id | string | The ID of the project. |
parameters.payload.scope.type? | string & object | "PROJECT" | "GLOBAL" | The scope of the workflow. GLOBAL for company-managed projects and PROJECT for team-managed projects. |
parameters.payload.statuses? | object[] | The statuses to associate with the workflows. |
parameters.payload.workflows? | object[] | The details of the workflows to create. |
parameters.validationOptions? | { [key: string]: unknown; levels?: (string & object | "WARNING" | "ERROR")[]; } | - |
parameters.validationOptions.levels? | (string & object | "WARNING" | "ERROR")[] | - |
Returns
Promise<{ [key: string]: unknown; errors?: object[]; }>
workflows.validateUpdateWorkflows
ts
validateUpdateWorkflows: (parameters) => Promise<{
[key: string]: unknown;
errors?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { payload: { [key: string]: unknown; statuses?: object[]; workflows?: object[]; }; validationOptions?: { [key: string]: unknown; levels?: (string & object | "WARNING" | "ERROR")[]; }; } | - |
parameters.payload | { [key: string]: unknown; statuses?: object[]; workflows?: object[]; } | - |
parameters.payload.statuses? | object[] | The statuses to associate with the workflows. |
parameters.payload.workflows? | object[] | The details of the workflows to update. |
parameters.validationOptions? | { [key: string]: unknown; levels?: (string & object | "WARNING" | "ERROR")[]; } | - |
parameters.validationOptions.levels? | (string & object | "WARNING" | "ERROR")[] | - |
Returns
Promise<{ [key: string]: unknown; errors?: object[]; }>
workflows.workflowCapabilities
ts
workflowCapabilities: (parameters?) => Promise<{
[key: string]: unknown;
connectRules?: object[];
editorScope?: string & object | "PROJECT" | "GLOBAL";
forgeRules?: object[];
projectTypes?: (
| "unknown"
| string & object
| "software"
| "service_desk"
| "business"
| "product_discovery")[];
systemRules?: object[];
triggerRules?: object[];
}>;Parameters
| Parameter | Type |
|---|---|
parameters? | { issueTypeId?: string; projectId?: string; workflowId?: string; } |
parameters.issueTypeId? | string |
parameters.projectId? | string |
parameters.workflowId? | string |
Returns
Promise<{ [key: string]: unknown; connectRules?: object[]; editorScope?: string & object | "PROJECT" | "GLOBAL"; forgeRules?: object[]; projectTypes?: ( | "unknown" | string & object | "software" | "service_desk" | "business" | "product_discovery")[]; systemRules?: object[]; triggerRules?: object[]; }>
workflowSchemeDrafts
ts
workflowSchemeDrafts: object;workflowSchemeDrafts.createWorkflowSchemeDraftFromParent
ts
createWorkflowSchemeDraftFromParent: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the active workflow scheme that the draft is created from. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemeDrafts.deleteDraftDefaultWorkflow
ts
deleteDraftDefaultWorkflow: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemeDrafts.deleteDraftWorkflowMapping
ts
deleteDraftWorkflowMapping: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; workflowName: string; } | - |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
parameters.workflowName | string | The name of the workflow. |
Returns
Promise<void>
workflowSchemeDrafts.deleteWorkflowSchemeDraft
ts
deleteWorkflowSchemeDraft: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the active workflow scheme that the draft was created from. |
Returns
Promise<void>
workflowSchemeDrafts.deleteWorkflowSchemeDraftIssueType
ts
deleteWorkflowSchemeDraftIssueType: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; issueType: string; } | - |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
parameters.issueType | string | The ID of the issue type. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemeDrafts.getDraftDefaultWorkflow
ts
getDraftDefaultWorkflow: (parameters) => Promise<{
[key: string]: unknown;
updateDraftIfNeeded?: boolean;
workflow: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
Returns
Promise<{ [key: string]: unknown; updateDraftIfNeeded?: boolean; workflow: string; }>
workflowSchemeDrafts.getDraftWorkflow
ts
getDraftWorkflow: (parameters) => Promise<{
[key: string]: unknown;
defaultMapping?: boolean;
issueTypes?: string[];
updateDraftIfNeeded?: boolean;
workflow?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; workflowName?: string; } | - |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
parameters.workflowName? | string | The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. |
Returns
Promise<{ [key: string]: unknown; defaultMapping?: boolean; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; }>
workflowSchemeDrafts.getWorkflowSchemeDraft
ts
getWorkflowSchemeDraft: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the active workflow scheme that the draft was created from. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemeDrafts.getWorkflowSchemeDraftIssueType
ts
getWorkflowSchemeDraftIssueType: (parameters) => Promise<{
[key: string]: unknown;
issueType?: string;
updateDraftIfNeeded?: boolean;
workflow?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; issueType: string; } | - |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
parameters.issueType | string | The ID of the issue type. |
Returns
Promise<{ [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }>
workflowSchemeDrafts.publishDraftWorkflowScheme
ts
publishDraftWorkflowScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; statusMappings?: object[]; validateOnly?: boolean; } | - |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
parameters.statusMappings? | object[] | Mappings of statuses to new statuses for issue types. |
parameters.validateOnly? | boolean | Whether the request only performs a validation. |
Returns
Promise<void>
workflowSchemeDrafts.setWorkflowSchemeDraftIssueType
ts
setWorkflowSchemeDraftIssueType: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }; id: number; issueType: string; } | - |
parameters.body | { [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; } | - |
parameters.body.issueType? | string | The ID of the issue type. Not required if updating the issue type-workflow mapping. |
parameters.body.updateDraftIfNeeded? | boolean | Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false. Only applicable when updating the workflow-issue types mapping. |
parameters.body.workflow? | string | The name of the workflow. |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
parameters.issueType | string | The ID of the issue type. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemeDrafts.updateDraftDefaultWorkflow
ts
updateDraftDefaultWorkflow: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; updateDraftIfNeeded?: boolean; workflow: string; } | - |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
parameters.updateDraftIfNeeded? | boolean | Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to false. |
parameters.workflow | string | The name of the workflow to set as the default workflow. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemeDrafts.updateDraftWorkflowMapping
ts
updateDraftWorkflowMapping: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { defaultMapping?: boolean; id: number; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; workflowName: string; } | - |
parameters.defaultMapping? | boolean | Whether the workflow is the default workflow for the workflow scheme. |
parameters.id | number | The ID of the workflow scheme that the draft belongs to. |
parameters.issueTypes? | string[] | The list of issue type IDs. |
parameters.updateDraftIfNeeded? | boolean | Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to false. |
parameters.workflow? | string | The name of the workflow. Optional if updating the workflow-issue types mapping. |
parameters.workflowName | string | The name of the workflow. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemeDrafts.updateWorkflowSchemeDraft
ts
updateWorkflowSchemeDraft: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }; id: number; } | - |
parameters.body | { [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; } | - |
parameters.body.defaultWorkflow? | string | The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira). |
parameters.body.description? | string | The description of the workflow scheme. |
parameters.body.draft? | boolean | Whether the workflow scheme is a draft or not. |
parameters.body.id? | number | The ID of the workflow scheme. |
parameters.body.issueTypeMappings? | Record<string, any> | The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. |
parameters.body.issueTypes? | Record<string, any> | The issue types available in Jira. |
parameters.body.lastModified? | string | The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows. |
parameters.body.lastModifiedUser? | { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; } | - |
parameters.body.lastModifiedUser.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.body.lastModifiedUser.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.body.lastModifiedUser.active? | boolean | Whether the user is active. |
parameters.body.lastModifiedUser.applicationRoles? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.lastModifiedUser.applicationRoles.callback? | { [key: ...]: ...; } | - |
parameters.body.lastModifiedUser.applicationRoles.items? | ...[] | - |
parameters.body.lastModifiedUser.applicationRoles.max-results? | number | - |
parameters.body.lastModifiedUser.applicationRoles.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.lastModifiedUser.applicationRoles.size? | number | - |
parameters.body.lastModifiedUser.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.body.lastModifiedUser.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.lastModifiedUser.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.lastModifiedUser.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.lastModifiedUser.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.lastModifiedUser.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.lastModifiedUser.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.body.lastModifiedUser.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.lastModifiedUser.expand? | string | Expand options that include additional user details in the response. |
parameters.body.lastModifiedUser.groups? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.lastModifiedUser.groups.callback? | { [key: ...]: ...; } | - |
parameters.body.lastModifiedUser.groups.items? | ...[] | - |
parameters.body.lastModifiedUser.groups.max-results? | number | - |
parameters.body.lastModifiedUser.groups.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.lastModifiedUser.groups.size? | number | - |
parameters.body.lastModifiedUser.guest? | boolean | Whether the user is a guest. |
parameters.body.lastModifiedUser.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.lastModifiedUser.self? | string | The URL of the user. |
parameters.body.lastModifiedUser.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.body.name? | string | The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme. |
parameters.body.originalDefaultWorkflow? | string | For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. |
parameters.body.originalIssueTypeMappings? | Record<string, any> | For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. |
parameters.body.self? | string | - |
parameters.body.updateDraftIfNeeded? | boolean | Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works: - Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created. - Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated. - Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update. Defaults to false. |
parameters.id | number | The ID of the active workflow scheme that the draft was created from. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemeProjectAssociations
ts
workflowSchemeProjectAssociations: object;workflowSchemeProjectAssociations.assignSchemeToProject
ts
assignSchemeToProject: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectId: string; workflowSchemeId?: string; } | - |
parameters.projectId | string | The ID of the project. |
parameters.workflowSchemeId? | string | The ID of the workflow scheme. If the workflow scheme ID is null, the operation assigns the default workflow scheme. |
Returns
Promise<void>
workflowSchemeProjectAssociations.getWorkflowSchemeProjectAssociations
ts
getWorkflowSchemeProjectAssociations: (parameters) => Promise<{
[key: string]: unknown;
values: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectId: number[]; } | - |
parameters.projectId | number[] | The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, projectId=10000&projectId=10001. |
Returns
Promise<{ [key: string]: unknown; values: object[]; }>
workflowSchemes
ts
workflowSchemes: object;workflowSchemes.createWorkflowScheme
ts
createWorkflowScheme: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [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; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; } | - |
parameters.defaultWorkflow? | string | The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira). |
parameters.description? | string | The description of the workflow scheme. |
parameters.draft? | boolean | Whether the workflow scheme is a draft or not. |
parameters.id? | number | The ID of the workflow scheme. |
parameters.issueTypeMappings? | Record<string, any> | The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. |
parameters.issueTypes? | Record<string, any> | The issue types available in Jira. |
parameters.lastModified? | string | The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows. |
parameters.lastModifiedUser? | { [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; } | - |
parameters.lastModifiedUser.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.lastModifiedUser.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.lastModifiedUser.active? | boolean | Whether the user is active. |
parameters.lastModifiedUser.applicationRoles? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.lastModifiedUser.applicationRoles.callback? | { [key: string]: unknown; } | - |
parameters.lastModifiedUser.applicationRoles.items? | object[] | - |
parameters.lastModifiedUser.applicationRoles.max-results? | number | - |
parameters.lastModifiedUser.applicationRoles.pagingCallback? | { [key: string]: unknown; } | - |
parameters.lastModifiedUser.applicationRoles.size? | number | - |
parameters.lastModifiedUser.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.lastModifiedUser.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.lastModifiedUser.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.lastModifiedUser.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.lastModifiedUser.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.lastModifiedUser.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.lastModifiedUser.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.lastModifiedUser.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.lastModifiedUser.expand? | string | Expand options that include additional user details in the response. |
parameters.lastModifiedUser.groups? | { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; } | - |
parameters.lastModifiedUser.groups.callback? | { [key: string]: unknown; } | - |
parameters.lastModifiedUser.groups.items? | object[] | - |
parameters.lastModifiedUser.groups.max-results? | number | - |
parameters.lastModifiedUser.groups.pagingCallback? | { [key: string]: unknown; } | - |
parameters.lastModifiedUser.groups.size? | number | - |
parameters.lastModifiedUser.guest? | boolean | Whether the user is a guest. |
parameters.lastModifiedUser.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.lastModifiedUser.self? | string | The URL of the user. |
parameters.lastModifiedUser.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.name? | string | The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme. |
parameters.originalDefaultWorkflow? | string | For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. |
parameters.originalIssueTypeMappings? | Record<string, any> | For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. |
parameters.self? | string | - |
parameters.updateDraftIfNeeded? | boolean | Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works: - Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created. - Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated. - Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update. Defaults to false. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemes.deleteDefaultWorkflow
ts
deleteDefaultWorkflow: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; updateDraftIfNeeded?: boolean; } | - |
parameters.id | number | The ID of the workflow scheme. |
parameters.updateDraftIfNeeded? | boolean | Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemes.deleteWorkflowMapping
ts
deleteWorkflowMapping: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; updateDraftIfNeeded?: boolean; workflowName: string; } | - |
parameters.id | number | The ID of the workflow scheme. |
parameters.updateDraftIfNeeded? | boolean | Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false. |
parameters.workflowName | string | The name of the workflow. |
Returns
Promise<void>
workflowSchemes.deleteWorkflowScheme
ts
deleteWorkflowScheme: (parameters) => Promise<void>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; } | - |
parameters.id | number | The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301. |
Returns
Promise<void>
workflowSchemes.deleteWorkflowSchemeIssueType
ts
deleteWorkflowSchemeIssueType: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; issueType: string; updateDraftIfNeeded?: boolean; } | - |
parameters.id | number | The ID of the workflow scheme. |
parameters.issueType | string | The ID of the issue type. |
parameters.updateDraftIfNeeded? | boolean | Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemes.getAllWorkflowSchemes
ts
getAllWorkflowSchemes: (parameters?) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters? | { maxResults?: number; startAt?: number; } | - |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
workflowSchemes.getDefaultWorkflow
ts
getDefaultWorkflow: (parameters) => Promise<{
[key: string]: unknown;
updateDraftIfNeeded?: boolean;
workflow: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; returnDraftIfExists?: boolean; } | - |
parameters.id | number | The ID of the workflow scheme. |
parameters.returnDraftIfExists? | boolean | Set to true to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned. |
Returns
Promise<{ [key: string]: unknown; updateDraftIfNeeded?: boolean; workflow: string; }>
workflowSchemes.getProjectUsagesForWorkflowScheme
ts
getProjectUsagesForWorkflowScheme: (parameters) => Promise<{
[key: string]: unknown;
projects?: {
[key: string]: unknown;
nextPageToken?: string | null;
values?: object[];
};
workflowSchemeId?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { maxResults?: number; nextPageToken?: string; workflowSchemeId: string; } | - |
parameters.maxResults? | number | The maximum number of results to return. Must be an integer between 1 and 200. |
parameters.nextPageToken? | string | The cursor for pagination |
parameters.workflowSchemeId | string | The workflow scheme ID |
Returns
Promise<{ [key: string]: unknown; projects?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; workflowSchemeId?: string; }>
workflowSchemes.getRequiredWorkflowSchemeMappings
ts
getRequiredWorkflowSchemeMappings: (parameters) => Promise<{
[key: string]: unknown;
statuses?: object[];
statusesPerWorkflow?: object[];
statusMappingsByIssueTypes?: object[];
statusMappingsByWorkflows?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { defaultWorkflowId?: string | null; id: string; workflowsForIssueTypes: object[]; } | - |
parameters.defaultWorkflowId? | string | null | The ID of the new default workflow for this workflow scheme. Only used in global-scoped workflow schemes. If it isn't specified, is set to Jira Workflow (jira). |
parameters.id | string | The ID of the workflow scheme. |
parameters.workflowsForIssueTypes | object[] | The new workflow to issue type mappings for this workflow scheme. |
Returns
Promise<{ [key: string]: unknown; statuses?: object[]; statusesPerWorkflow?: object[]; statusMappingsByIssueTypes?: object[]; statusMappingsByWorkflows?: object[]; }>
workflowSchemes.getWorkflow
ts
getWorkflow: (parameters) => Promise<{
[key: string]: unknown;
defaultMapping?: boolean;
issueTypes?: string[];
updateDraftIfNeeded?: boolean;
workflow?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; returnDraftIfExists?: boolean; workflowName?: string; } | - |
parameters.id | number | The ID of the workflow scheme. |
parameters.returnDraftIfExists? | boolean | Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned. |
parameters.workflowName? | string | The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. |
Returns
Promise<{ [key: string]: unknown; defaultMapping?: boolean; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; }>
workflowSchemes.getWorkflowScheme
ts
getWorkflowScheme: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; returnDraftIfExists?: boolean; } | - |
parameters.id | number | The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301. |
parameters.returnDraftIfExists? | boolean | Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemes.getWorkflowSchemeIssueType
ts
getWorkflowSchemeIssueType: (parameters) => Promise<{
[key: string]: unknown;
issueType?: string;
updateDraftIfNeeded?: boolean;
workflow?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; issueType: string; returnDraftIfExists?: boolean; } | - |
parameters.id | number | The ID of the workflow scheme. |
parameters.issueType | string | The ID of the issue type. |
parameters.returnDraftIfExists? | boolean | Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned. |
Returns
Promise<{ [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }>
workflowSchemes.readWorkflowSchemes
ts
readWorkflowSchemes: (parameters) => Promise<object[]>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { projectIds?: (string | null)[] | null; workflowSchemeIds?: (string | null)[] | null; } | - |
parameters.projectIds? | (string | null)[] | null | The list of project IDs to query. |
parameters.workflowSchemeIds? | (string | null)[] | null | The list of workflow scheme IDs to query. |
Returns
Promise<object[]>
workflowSchemes.setWorkflowSchemeIssueType
ts
setWorkflowSchemeIssueType: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }; id: number; issueType: string; } | - |
parameters.body | { [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; } | - |
parameters.body.issueType? | string | The ID of the issue type. Not required if updating the issue type-workflow mapping. |
parameters.body.updateDraftIfNeeded? | boolean | Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false. Only applicable when updating the workflow-issue types mapping. |
parameters.body.workflow? | string | The name of the workflow. |
parameters.id | number | The ID of the workflow scheme. |
parameters.issueType | string | The ID of the issue type. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemes.updateDefaultWorkflow
ts
updateDefaultWorkflow: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { id: number; updateDraftIfNeeded?: boolean; workflow: string; } | - |
parameters.id | number | The ID of the workflow scheme. |
parameters.updateDraftIfNeeded? | boolean | Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to false. |
parameters.workflow | string | The name of the workflow to set as the default workflow. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemes.updateSchemes
ts
updateSchemes: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
elapsedRuntime: number;
finished?: number;
id: string;
lastUpdate: number;
message?: string;
progress: number;
result?: unknown;
self: string;
started?: number;
status: | string & object
| "ENQUEUED"
| "RUNNING"
| "COMPLETE"
| "FAILED"
| "CANCEL_REQUESTED"
| "CANCELLED"
| "DEAD";
submitted: number;
submittedBy: number;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { defaultWorkflowId?: string; description: string; id: string; name: string; statusMappingsByIssueTypeOverride?: object[]; statusMappingsByWorkflows?: object[]; version: { [key: string]: unknown; id?: string; versionNumber?: number; }; workflowsForIssueTypes?: object[]; } | - |
parameters.defaultWorkflowId? | string | The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the defaultWorkflowId isn't specified, this is set to Jira Workflow (jira). |
parameters.description | string | The new description for this workflow scheme. |
parameters.id | string | The ID of this workflow scheme. |
parameters.name | string | The new name for this workflow scheme. |
parameters.statusMappingsByIssueTypeOverride? | object[] | Overrides, for the selected issue types, any status mappings provided in statusMappingsByWorkflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of statusMappingsByWorkflows and statusMappingsByIssueTypeOverride. |
parameters.statusMappingsByWorkflows? | object[] | The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of statusMappingsByWorkflows and statusMappingsByIssueTypeOverride. |
parameters.version | { [key: string]: unknown; id?: string; versionNumber?: number; } | - |
parameters.version.id? | string | The version UUID. |
parameters.version.versionNumber? | number | The version number. |
parameters.workflowsForIssueTypes? | object[] | Mappings from workflows to issue types. |
Returns
Promise<{ [key: string]: unknown; description?: string; elapsedRuntime: number; finished?: number; id: string; lastUpdate: number; message?: string; progress: number; result?: unknown; self: string; started?: number; status: | string & object | "ENQUEUED" | "RUNNING" | "COMPLETE" | "FAILED" | "CANCEL_REQUESTED" | "CANCELLED" | "DEAD"; submitted: number; submittedBy: number; }>
workflowSchemes.updateWorkflowMapping
ts
updateWorkflowMapping: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { defaultMapping?: boolean; id: number; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; workflowName: string; } | - |
parameters.defaultMapping? | boolean | Whether the workflow is the default workflow for the workflow scheme. |
parameters.id | number | The ID of the workflow scheme. |
parameters.issueTypes? | string[] | The list of issue type IDs. |
parameters.updateDraftIfNeeded? | boolean | Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to false. |
parameters.workflow? | string | The name of the workflow. Optional if updating the workflow-issue types mapping. |
parameters.workflowName | string | The name of the workflow. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowSchemes.updateWorkflowScheme
ts
updateWorkflowScheme: (parameters) => Promise<{
[key: string]: unknown;
defaultWorkflow?: string;
description?: string;
draft?: boolean;
id?: number;
issueTypeMappings?: Record<string, any>;
issueTypes?: Record<string, any>;
lastModified?: string;
lastModifiedUser?: {
[key: string]: unknown;
accountId?: string;
accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
active?: boolean;
applicationRoles?: {
[key: string]: unknown;
callback?: {
[key: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
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: ...]: ...;
};
items?: ...[];
max-results?: number;
pagingCallback?: {
[key: ...]: ...;
};
size?: number;
};
guest?: boolean;
locale?: string;
self?: string;
timeZone?: string;
};
name?: string;
originalDefaultWorkflow?: string;
originalIssueTypeMappings?: Record<string, any>;
self?: string;
updateDraftIfNeeded?: boolean;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { body: { [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }; id: number; } | - |
parameters.body | { [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; } | - |
parameters.body.defaultWorkflow? | string | The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira). |
parameters.body.description? | string | The description of the workflow scheme. |
parameters.body.draft? | boolean | Whether the workflow scheme is a draft or not. |
parameters.body.id? | number | The ID of the workflow scheme. |
parameters.body.issueTypeMappings? | Record<string, any> | The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. |
parameters.body.issueTypes? | Record<string, any> | The issue types available in Jira. |
parameters.body.lastModified? | string | The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows. |
parameters.body.lastModifiedUser? | { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; } | - |
parameters.body.lastModifiedUser.accountId? | string | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. |
parameters.body.lastModifiedUser.accountType? | "unknown" | string & object | "atlassian" | "app" | "customer" | The user account type. Can take the following values: - atlassian regular Atlassian user account - app system account used for Connect applications and OAuth to represent external systems - customer Jira Service Desk account representing an external service desk |
parameters.body.lastModifiedUser.active? | boolean | Whether the user is active. |
parameters.body.lastModifiedUser.applicationRoles? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.lastModifiedUser.applicationRoles.callback? | { [key: ...]: ...; } | - |
parameters.body.lastModifiedUser.applicationRoles.items? | ...[] | - |
parameters.body.lastModifiedUser.applicationRoles.max-results? | number | - |
parameters.body.lastModifiedUser.applicationRoles.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.lastModifiedUser.applicationRoles.size? | number | - |
parameters.body.lastModifiedUser.appType? | string | The app type of the user account when accountType is 'app'. Can take the following values: - service Service Account - agent Rovo Agent Account - unknown Unknown app type |
parameters.body.lastModifiedUser.avatarUrls? | { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; } | - |
parameters.body.lastModifiedUser.avatarUrls.16x16? | string | The URL of the item's 16x16 pixel avatar. |
parameters.body.lastModifiedUser.avatarUrls.24x24? | string | The URL of the item's 24x24 pixel avatar. |
parameters.body.lastModifiedUser.avatarUrls.32x32? | string | The URL of the item's 32x32 pixel avatar. |
parameters.body.lastModifiedUser.avatarUrls.48x48? | string | The URL of the item's 48x48 pixel avatar. |
parameters.body.lastModifiedUser.displayName? | string | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
parameters.body.lastModifiedUser.emailAddress? | string | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.lastModifiedUser.expand? | string | Expand options that include additional user details in the response. |
parameters.body.lastModifiedUser.groups? | { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; } | - |
parameters.body.lastModifiedUser.groups.callback? | { [key: ...]: ...; } | - |
parameters.body.lastModifiedUser.groups.items? | ...[] | - |
parameters.body.lastModifiedUser.groups.max-results? | number | - |
parameters.body.lastModifiedUser.groups.pagingCallback? | { [key: ...]: ...; } | - |
parameters.body.lastModifiedUser.groups.size? | number | - |
parameters.body.lastModifiedUser.guest? | boolean | Whether the user is a guest. |
parameters.body.lastModifiedUser.locale? | string | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
parameters.body.lastModifiedUser.self? | string | The URL of the user. |
parameters.body.lastModifiedUser.timeZone? | string | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
parameters.body.name? | string | The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme. |
parameters.body.originalDefaultWorkflow? | string | For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. |
parameters.body.originalIssueTypeMappings? | Record<string, any> | For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. |
parameters.body.self? | string | - |
parameters.body.updateDraftIfNeeded? | boolean | Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works: - Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created. - Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated. - Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update. Defaults to false. |
parameters.id | number | The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301. |
Returns
Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, any>; issueTypes?: Record<string, any>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; 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: ...]: ...; }; items?: ...[]; max-results?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, any>; self?: string; updateDraftIfNeeded?: boolean; }>
workflowStatusCategories
ts
workflowStatusCategories: object;workflowStatusCategories.getStatusCategories
ts
getStatusCategories: () => Promise<object[]>;Returns
Promise<object[]>
workflowStatusCategories.getStatusCategory
ts
getStatusCategory: (parameters) => Promise<{
[key: string]: unknown;
colorName?: string;
id?: number;
key?: string;
name?: string;
self?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { idOrKey: string; } | - |
parameters.idOrKey | string | The ID or key of the status category. |
Returns
Promise<{ [key: string]: unknown; colorName?: string; id?: number; key?: string; name?: string; self?: string; }>
workflowStatuses
ts
workflowStatuses: object;workflowStatuses.getStatus
ts
getStatus: (parameters) => Promise<{
[key: string]: unknown;
description?: string;
iconUrl?: string;
id?: string;
name?: string;
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: ...]: ...;
16x16?: ...;
24x24?: ...;
32x32?: ...;
48x48?: ...;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: ...]: ...;
description?: ...;
id?: ...;
name?: ...;
self?: ...;
};
projectTypeKey?: | ... & ...
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
statusCategory?: {
[key: string]: unknown;
colorName?: string;
id?: number;
key?: string;
name?: string;
self?: string;
};
untranslatedName?: string;
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { idOrName: string; } | - |
parameters.idOrName | string | The ID or name of the status. |
Returns
Promise<{ [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: ...]: ...; 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: ...]: ...; description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: string; id?: number; key?: string; name?: string; self?: string; }; untranslatedName?: string; }>
workflowStatuses.getStatuses
ts
getStatuses: () => Promise<object[]>;Returns
Promise<object[]>
workflowTransitionRules
ts
workflowTransitionRules: object;workflowTransitionRules.deleteWorkflowTransitionRuleConfigurations
ts
deleteWorkflowTransitionRuleConfigurations: (parameters) => Promise<{
[key: string]: unknown;
updateResults: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { workflows: object[]; } | - |
parameters.workflows | object[] | The list of workflows with transition rules to delete. |
Returns
Promise<{ [key: string]: unknown; updateResults: object[]; }>
workflowTransitionRules.getWorkflowTransitionRuleConfigurations
ts
getWorkflowTransitionRuleConfigurations: (parameters) => Promise<{
[key: string]: unknown;
isLast?: boolean;
maxResults?: number;
nextPage?: string;
self?: string;
startAt?: number;
total?: number;
values?: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { draft?: boolean; expand?: | string | string[] | string & object | ("transition" | string & object)[]; keys?: string[]; maxResults?: number; startAt?: number; types: (string & object | "postfunction" | "condition" | "validator")[]; withTags?: string[]; workflowNames?: string[]; } | - |
parameters.draft? | boolean | Deprecated: Whether draft or published workflows are returned. If not provided, both workflow types are returned. The 'draft' parameter will be removed from this API on November 2, 2026. |
parameters.expand? | | string | string[] | string & object | ("transition" | string & object)[] | Use expand to include additional information in the response. This parameter accepts transition, which, for each rule, returns information about the transition the rule is assigned to. |
parameters.keys? | string[] | The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
parameters.types | (string & object | "postfunction" | "condition" | "validator")[] | The types of the transition rules to return. |
parameters.withTags? | string[] | The list of tags to filter by. |
parameters.workflowNames? | string[] | The list of workflow names to filter by. |
Returns
Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>
workflowTransitionRules.updateWorkflowTransitionRuleConfigurations
ts
updateWorkflowTransitionRuleConfigurations: (parameters) => Promise<{
[key: string]: unknown;
updateResults: object[];
}>;Parameters
| Parameter | Type | Description |
|---|---|---|
parameters | { workflows: object[]; } | - |
parameters.workflows | object[] | The list of workflows with transition rules to update. |
Returns
Promise<{ [key: string]: unknown; updateResults: object[]; }>