jira.js

English

Русский

English

Русский

Appearance

Function: createCloudClient() ​

ts
function createCloudClient(clientConfig): object;

Defined in: src/cloud/createCloudClient.ts:738

Parameters ​

ParameterType
clientConfig| ClientConfig | Client

Returns ​

object

announcementBanner ​

ts
announcementBanner: object;

announcementBanner.getBanner ​

ts
getBanner: (options?) => Promise<{
[key: string]: unknown;
  hashId?: string;
  isDismissible?: boolean;
  isEnabled?: boolean;
  message?: string;
  visibility?: "private" | "public" | string & object;
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; hashId?: string; isDismissible?: boolean; isEnabled?: boolean; message?: string; visibility?: "private" | "public" | string & object; }>

announcementBanner.setBanner ​

ts
setBanner: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ isDismissible?: boolean; isEnabled?: boolean; message?: string; visibility?: string; }-
parameters.isDismissible?booleanFlag indicating if the announcement banner can be dismissed by the user.
parameters.isEnabled?booleanFlag indicating if the announcement banner is enabled or not.
parameters.message?stringThe text on the announcement banner.
parameters.visibility?stringVisibility of the announcement banner. Can be public or private.
options?RequestOptions-
Returns ​

Promise<void>

api ​

ts
api: object;

api.getWorklogsByIssueIdAndWorklogId ​

ts
getWorklogsByIssueIdAndWorklogId: (parameters, options?) => Promise<{
[key: string]: unknown;
  worklogs?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ requests?: object[]; }-
parameters.requests?object[]A list of issue and worklog ID pairs.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; worklogs?: object[]; }>

appDataPolicies ​

ts
appDataPolicies: object;

appDataPolicies.getPolicies ​

ts
getPolicies: (parameters?, options?) => Promise<{
[key: string]: unknown;
  projectDataPolicies?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ ids?: string | string[]; }-
parameters.ids?string | string[]A list of project identifiers. This parameter accepts a comma-separated list.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; projectDataPolicies?: object[]; }>

appDataPolicies.getPolicy ​

ts
getPolicy: (options?) => Promise<{
[key: string]: unknown;
  anyContentBlocked?: boolean;
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; anyContentBlocked?: boolean; }>

applicationRoles ​

ts
applicationRoles: object;

applicationRoles.getAllApplicationRoles ​

ts
getAllApplicationRoles: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

applicationRoles.getApplicationRole ​

ts
getApplicationRole: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ key: string; }-
parameters.keystringThe key of the application role. Use the Get all application roles operation to get the key for each application role.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ Atlassian-Transfer-Id: string; body: object[]; entityType: | string & object | "IssueProperty" | "CommentProperty" | "DashboardItemProperty" | "IssueTypeProperty" | "ProjectProperty" | "UserProperty" | "WorklogProperty" | "BoardProperty" | "SprintProperty"; }-
parameters.Atlassian-Transfer-IdstringThe app migration transfer ID.
parameters.body?object[]-
parameters.entityType?| string & object | "IssueProperty" | "CommentProperty" | "DashboardItemProperty" | "IssueTypeProperty" | "ProjectProperty" | "UserProperty" | "WorklogProperty" | "BoardProperty" | "SprintProperty"The type indicating the object that contains the entity properties.
options?RequestOptions-
Returns ​

Promise<void>

appMigration.updateIssueFields ​

ts
updateIssueFields: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ Atlassian-Transfer-Id: string; updateValueList?: object[]; }-
parameters.Atlassian-Transfer-IdstringThe ID of the transfer.
parameters.updateValueList?object[]The list of custom field update details.
options?RequestOptions-
Returns ​

Promise<void>

appMigration.workflowRuleSearch ​

ts
workflowRuleSearch: (parameters, options?) => Promise<{
[key: string]: unknown;
  invalidRules?: string[];
  validRules?: object[];
  workflowEntityId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ Atlassian-Transfer-Id: string; expand?: string; ruleIds: string[]; workflowEntityId: string; }-
parameters.Atlassian-Transfer-IdstringThe app migration transfer ID.
parameters.expand?stringUse 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?stringThe workflow ID.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; invalidRules?: string[]; validRules?: object[]; workflowEntityId?: string; }>

appProperties ​

ts
appProperties: object;

appProperties.deleteAddonProperty ​

ts
deleteAddonProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ addonKey: string; propertyKey: string; }-
parameters.addonKeystringThe key of the app, as defined in its descriptor.
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-
Returns ​

Promise<void>

appProperties.deleteForgeAppProperty ​

ts
deleteForgeAppProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ propertyKey: string; }-
parameters.propertyKeystringThe key of the property.
options?RequestOptions-
Returns ​

Promise<void>

appProperties.getAddonProperties ​

ts
getAddonProperties: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ addonKey: string; }-
parameters.addonKeystringThe key of the app, as defined in its descriptor.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>

appProperties.getAddonProperty ​

ts
getAddonProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ addonKey: string; propertyKey: string; }-
parameters.addonKeystringThe key of the app, as defined in its descriptor.
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

appProperties.getForgeAppProperty ​

ts
getForgeAppProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ propertyKey: string; }-
parameters.propertyKeystringThe key of the property.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

appProperties.getForgeAppPropertyKeys ​

ts
getForgeAppPropertyKeys: (options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>

appProperties.putAddonProperty ​

ts
putAddonProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  message: string;
  statusCode: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ addonKey: string; body: Record<string, any>; propertyKey: string; }-
parameters.addonKeystringThe key of the app, as defined in its descriptor.
parameters.body?Record<string, any>-
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; message: string; statusCode: number; }>

appProperties.putForgeAppProperty ​

ts
putForgeAppProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  message: string;
  statusCode: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: Record<string, any>; propertyKey: string; }-
parameters.bodyRecord<string, any>-
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; message: string; statusCode: number; }>

auditRecords ​

ts
auditRecords: object;

auditRecords.getAuditRecords ​

ts
getAuditRecords: (parameters?, options?) => Promise<{
[key: string]: unknown;
  limit?: number;
  offset?: number;
  records?: object[];
  total?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters?{ filter?: string; from?: string; limit?: number; offset?: number; to?: string; }-
parameters.filter?stringThe strings to match with audit field content, space separated.
parameters.from?stringThe 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?numberThe maximum number of results to return.
parameters.offset?numberThe number of records to skip before returning the first result.
parameters.to?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; limit?: number; offset?: number; records?: object[]; total?: number; }>

avatars ​

ts
avatars: object;

avatars.deleteAvatar ​

ts
deleteAvatar: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; owningObjectId: string; type: "priority" | string & object | "project" | "issuetype"; }-
parameters.idnumberThe ID of the avatar.
parameters.owningObjectId?stringThe ID of the item the avatar is associated with.
parameters.type?"priority" | string & object | "project" | "issuetype"The avatar type.
options?RequestOptions-
Returns ​

Promise<void>

avatars.getAllSystemAvatars ​

ts
getAllSystemAvatars: (parameters, options?) => Promise<{
[key: string]: unknown;
  system?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ type: "priority" | "user" | string & object | "project" | "issuetype"; }-
parameters.type"priority" | "user" | string & object | "project" | "issuetype"The avatar type.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; system?: object[]; }>

avatars.getAvatarImageByID ​

ts
getAvatarImageByID: (parameters, options?) => Promise<Blob>;
Parameters ​
ParameterTypeDescription
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?numberThe 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.
options?RequestOptions-
Returns ​

Promise<Blob>

avatars.getAvatarImageByOwner ​

ts
getAvatarImageByOwner: (parameters, options?) => Promise<Blob>;
Parameters ​
ParameterTypeDescription
parameters{ entityId: string; format?: "svg" | string & object | "png"; size?: "small" | "medium" | string & object | "xsmall" | "large" | "xlarge"; type: "priority" | string & object | "project" | "issuetype"; }-
parameters.entityIdstringThe 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.
options?RequestOptions-
Returns ​

Promise<Blob>

avatars.getAvatarImageByType ​

ts
getAvatarImageByType: (parameters, options?) => Promise<Blob>;
Parameters ​
ParameterTypeDescription
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.
options?RequestOptions-
Returns ​

Promise<Blob>

avatars.getAvatars ​

ts
getAvatars: (parameters, options?) => Promise<{
[key: string]: unknown;
  custom?: object[];
  system?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ entityId: string; type: "priority" | string & object | "project" | "issuetype"; }-
parameters.entityIdstringThe ID of the item the avatar is associated with.
parameters.type?"priority" | string & object | "project" | "issuetype"The avatar type.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; custom?: object[]; system?: object[]; }>

avatars.storeAvatar ​

ts
storeAvatar: (parameters, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  urls?: Record<string, string>;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: Blob; entityId: string; size: number; type: "priority" | string & object | "project" | "issuetype"; x?: number; y?: number; }-
parameters.bodyBlob-
parameters.entityId?stringThe ID of the item the avatar is associated with.
parameters.size?numberThe length of each side of the crop region.
parameters.type?"priority" | string & object | "project" | "issuetype"The avatar type.
parameters.x?numberThe X coordinate of the top-left corner of the crop region.
parameters.y?numberThe Y coordinate of the top-left corner of the crop region.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; urls?: Record<string, string>; }>

dashboards ​

ts
dashboards: object;

dashboards.deleteDashboardItemProperty ​

ts
deleteDashboardItemProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ dashboardId: string; itemId: string; propertyKey: string; }-
parameters.dashboardIdstringThe ID of the dashboard.
parameters.itemId?stringThe ID of the dashboard item.
parameters.propertyKey?stringThe key of the dashboard item property.
options?RequestOptions-
Returns ​

Promise<void>

dashboards.getAllDashboards ​

ts
getAllDashboards: (parameters?, options?) => Promise<{
[key: string]: unknown;
  dashboards?: object[];
  maxResults?: number;
  next?: string;
  prev?: string;
  startAt?: number;
  total?: number;
}>;
Parameters ​
ParameterTypeDescription
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?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; dashboards?: object[]; maxResults?: number; next?: string; prev?: string; startAt?: number; total?: number; }>

dashboards.getDashboard ​

ts
getDashboard: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the dashboard.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ dashboardId: string; itemId: string; propertyKey: string; }-
parameters.dashboardIdstringThe ID of the dashboard.
parameters.itemId?stringThe ID of the dashboard item.
parameters.propertyKey?stringThe key of the dashboard item property.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

dashboards.getDashboardItemPropertyKeys ​

ts
getDashboardItemPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ dashboardId: string; itemId: string; }-
parameters.dashboardIdstringThe ID of the dashboard.
parameters.itemId?stringThe ID of the dashboard item.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>

dashboards.getDashboardsPaginated ​

ts
getDashboardsPaginated: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ accountId?: string; dashboardName?: string; expand?: | "description" | string & object | "viewUrl" | "owner" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "favouritedCount" | ( | "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?stringUser account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.
parameters.dashboardName?stringString used to perform a case-insensitive partial match with name.
parameters.expand?| "description" | string & object | "viewUrl" | "owner" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "favouritedCount" | ( | "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?stringGroup 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?stringAs 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?numberThe 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?numberProject ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.
parameters.startAt?numberThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

dashboards.setDashboardItemProperty ​

ts
setDashboardItemProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ body: Record<string, any>; dashboardId: string; itemId: string; propertyKey: string; }-
parameters.bodyRecord<string, any>-
parameters.dashboardId?stringThe ID of the dashboard.
parameters.itemId?stringThe ID of the dashboard item.
parameters.propertyKey?stringThe 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.
options?RequestOptions-
Returns ​

Promise<void>

dynamicModules ​

ts
dynamicModules: object;

dynamicModules.getModules ​

ts
getModules: (options?) => Promise<{
[key: string]: unknown;
  modules: object[];
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; modules: object[]; }>

dynamicModules.registerModules ​

ts
registerModules: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ modules: Record<string, never>[]; }-
parameters.modulesRecord<string, never>[]A list of app modules in the same format as the modules property in the app descriptor.
options?RequestOptions-
Returns ​

Promise<void>

dynamicModules.removeModules ​

ts
removeModules: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
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.
options?RequestOptions-
Returns ​

Promise<void>

filters ​

ts
filters: object;

filters.createFilter ​

ts
createFilter: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ approximateLastUsed?: unknown; description?: string; editPermissions?: object[]; expand?: | string & object | "sharedUsers" | "subscriptions" | (string & object | "sharedUsers" | "subscriptions")[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; overrideSharePermissions?: boolean; owner?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { 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?stringA description of the filter.
parameters.editPermissions?object[]The groups and projects that can edit the filter.
parameters.expand?| string & object | "sharedUsers" | "subscriptions" | (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?booleanWhether the filter is selected as a favorite.
parameters.favouritedCount?numberThe count of how many users have selected this filter as a favorite, including the filter owner.
parameters.id?stringThe unique identifier for the filter.
parameters.isWritable?boolean-
parameters.jql?stringThe JQL query for the filter. For example, project = SSP AND issuetype = Bug.
parameters.name?stringThe name of the filter. Must be unique.
parameters.overrideSharePermissions?booleanEXPERIMENTAL: 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?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.owner.accountId?stringThe 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?booleanWhether the user is active.
parameters.owner.applicationRoles?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.owner.applicationRoles.callback?Record<string, never>-
parameters.owner.applicationRoles.items?object[]-
parameters.owner.applicationRoles.max-results?number-
parameters.owner.applicationRoles.pagingCallback?Record<string, never>-
parameters.owner.applicationRoles.size?number-
parameters.owner.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.owner.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.owner.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.owner.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.owner.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.owner.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.owner.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.owner.expand?stringExpand options that include additional user details in the response.
parameters.owner.groups?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.owner.groups.callback?Record<string, never>-
parameters.owner.groups.items?object[]-
parameters.owner.groups.max-results?number-
parameters.owner.groups.pagingCallback?Record<string, never>-
parameters.owner.groups.size?number-
parameters.owner.guest?booleanWhether the user is a guest.
parameters.owner.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.owner.self?stringThe URL of the user.
parameters.owner.timeZone?stringThe 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?stringA 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?stringThe URL of the filter.
parameters.sharedUsers?{ end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }-
parameters.sharedUsers.end-index?numberThe index of the last item returned on the page.
parameters.sharedUsers.items?object[]The list of items.
parameters.sharedUsers.max-results?numberThe maximum number of results that could be on the page.
parameters.sharedUsers.size?numberThe number of items on the page.
parameters.sharedUsers.start-index?numberThe index of the first item returned on the page.
parameters.sharePermissions?object[]The groups and projects that the filter is shared with.
parameters.subscriptions?{ end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }-
parameters.subscriptions.end-index?numberThe index of the last item returned on the page.
parameters.subscriptions.items?object[]The list of items.
parameters.subscriptions.max-results?numberThe maximum number of results that could be on the page.
parameters.subscriptions.size?numberThe number of items on the page.
parameters.subscriptions.start-index?numberThe index of the first item returned on the page.
parameters.viewUrl?stringA URL to view the filter results in Jira, using the ID of the filter. For example, _https://your-domain.atlassian.net/issues/?filter=10100_.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | string & object | "sharedUsers" | "subscriptions" | (string & object | "sharedUsers" | "subscriptions")[]; id: number; }-
parameters.expand?| string & object | "sharedUsers" | "subscriptions" | (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?numberThe ID of the filter.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the filter to delete.
options?RequestOptions-
Returns ​

Promise<void>

filters.getColumns ​

ts
getColumns: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the filter.
options?RequestOptions-
Returns ​

Promise<object[]>

filters.getFavouriteFilters ​

ts
getFavouriteFilters: (parameters?, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | string & object | "sharedUsers" | "subscriptions" | (string & object | "sharedUsers" | "subscriptions")[]; }-
parameters.expand?| string & object | "sharedUsers" | "subscriptions" | (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].
options?RequestOptions-
Returns ​

Promise<object[]>

filters.getFilter ​

ts
getFilter: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | string & object | "sharedUsers" | "subscriptions" | (string & object | "sharedUsers" | "subscriptions")[]; id: number; overrideSharePermissions?: boolean; }-
parameters.expand?| string & object | "sharedUsers" | "subscriptions" | (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?numberThe ID of the filter to return.
parameters.overrideSharePermissions?booleanEXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission.
options?RequestOptions-
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?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ accountId?: string; expand?: | "description" | string & object | "jql" | "viewUrl" | "owner" | "searchUrl" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "approximateLastUsed" | "favouritedCount" | "subscriptions" | ( | "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?stringUser account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner.
parameters.expand?| "description" | string & object | "jql" | "viewUrl" | "owner" | "searchUrl" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "approximateLastUsed" | "favouritedCount" | "subscriptions" | ( | "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?stringString used to perform a case-insensitive partial match with name.
parameters.groupId?stringGroup 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?stringAs 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?booleanWhen 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?numberThe 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?booleanEXPERIMENTAL: 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?numberProject ID used to returns filters that are shared with a project that matches sharePermissions.project.id.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

filters.getMyFilters ​

ts
getMyFilters: (parameters?, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | string & object | "sharedUsers" | "subscriptions" | (string & object | "sharedUsers" | "subscriptions")[]; includeFavourites?: boolean; }-
parameters.expand?| string & object | "sharedUsers" | "subscriptions" | (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?booleanInclude the user's favorite filters in the response.
options?RequestOptions-
Returns ​

Promise<object[]>

filters.resetColumns ​

ts
resetColumns: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the filter.
options?RequestOptions-
Returns ​

Promise<void>

filters.setColumns ​

ts
setColumns: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ columns?: string[]; id: number; }-
parameters.columns?string[]-
parameters.id?numberThe ID of the filter.
options?RequestOptions-
Returns ​

Promise<void>

filters.setFavouriteForFilter ​

ts
setFavouriteForFilter: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | string & object | "sharedUsers" | "subscriptions" | (string & object | "sharedUsers" | "subscriptions")[]; id: number; }-
parameters.expand?| string & object | "sharedUsers" | "subscriptions" | (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?numberThe ID of the filter.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ body: { approximateLastUsed?: unknown; description?: string; editPermissions?: object[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; owner?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; viewUrl?: string; }; expand?: | string & object | "sharedUsers" | "subscriptions" | (string & object | "sharedUsers" | "subscriptions")[]; id: number; overrideSharePermissions?: boolean; }-
parameters.body{ approximateLastUsed?: unknown; description?: string; editPermissions?: object[]; favourite?: boolean; favouritedCount?: number; id?: string; isWritable?: boolean; jql?: string; name: string; owner?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; sharePermissions?: object[]; subscriptions?: { 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?stringA description of the filter.
parameters.body.editPermissions?object[]The groups and projects that can edit the filter.
parameters.body.favourite?booleanWhether the filter is selected as a favorite.
parameters.body.favouritedCount?numberThe count of how many users have selected this filter as a favorite, including the filter owner.
parameters.body.id?stringThe unique identifier for the filter.
parameters.body.isWritable?boolean-
parameters.body.jql?stringThe JQL query for the filter. For example, project = SSP AND issuetype = Bug.
parameters.body.name?stringThe name of the filter. Must be unique.
parameters.body.owner?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.body.owner.accountId?stringThe 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?booleanWhether the user is active.
parameters.body.owner.applicationRoles?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.owner.applicationRoles.callback?Record<..., ...>-
parameters.body.owner.applicationRoles.items?...[]-
parameters.body.owner.applicationRoles.max-results?number-
parameters.body.owner.applicationRoles.pagingCallback?Record<..., ...>-
parameters.body.owner.applicationRoles.size?number-
parameters.body.owner.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.owner.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.owner.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.owner.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.owner.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.owner.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.body.owner.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.owner.expand?stringExpand options that include additional user details in the response.
parameters.body.owner.groups?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.owner.groups.callback?Record<..., ...>-
parameters.body.owner.groups.items?...[]-
parameters.body.owner.groups.max-results?number-
parameters.body.owner.groups.pagingCallback?Record<..., ...>-
parameters.body.owner.groups.size?number-
parameters.body.owner.guest?booleanWhether the user is a guest.
parameters.body.owner.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.owner.self?stringThe URL of the user.
parameters.body.owner.timeZone?stringThe 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?stringA 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?stringThe URL of the filter.
parameters.body.sharedUsers?{ end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }-
parameters.body.sharedUsers.end-index?numberThe index of the last item returned on the page.
parameters.body.sharedUsers.items?object[]The list of items.
parameters.body.sharedUsers.max-results?numberThe maximum number of results that could be on the page.
parameters.body.sharedUsers.size?numberThe number of items on the page.
parameters.body.sharedUsers.start-index?numberThe 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?{ end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }-
parameters.body.subscriptions.end-index?numberThe index of the last item returned on the page.
parameters.body.subscriptions.items?object[]The list of items.
parameters.body.subscriptions.max-results?numberThe maximum number of results that could be on the page.
parameters.body.subscriptions.size?numberThe number of items on the page.
parameters.body.subscriptions.start-index?numberThe index of the first item returned on the page.
parameters.body.viewUrl?stringA 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 & object | "sharedUsers" | "subscriptions" | (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?numberThe ID of the filter to update.
parameters.overrideSharePermissions?booleanEXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with Administer Jira global permission.
options?RequestOptions-
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, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
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?stringThe user account ID that the filter is shared with. For a request, specify the accountId property for the user.
parameters.groupId?stringThe 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?stringThe 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?numberThe ID of the filter.
parameters.projectId?stringThe ID of the project to share the filter with. Set type to project.
parameters.projectRoleId?stringThe 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?numberThe 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.
options?RequestOptions-
Returns ​

Promise<object[]>

filterSharing.deleteSharePermission ​

ts
deleteSharePermission: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; permissionId: number; }-
parameters.idnumberThe ID of the filter.
parameters.permissionId?numberThe ID of the share permission.
options?RequestOptions-
Returns ​

Promise<void>

filterSharing.getDefaultShareScope ​

ts
getDefaultShareScope: (options?) => Promise<{
[key: string]: unknown;
  scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE";
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE"; }>

filterSharing.getSharePermission ​

ts
getSharePermission: (parameters, options?) => 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, string>;
     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 ​
ParameterTypeDescription
parameters{ id: number; permissionId: number; }-
parameters.idnumberThe ID of the filter.
parameters.permissionId?numberThe ID of the share permission.
options?RequestOptions-
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, string>; 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, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the filter.
options?RequestOptions-
Returns ​

Promise<object[]>

filterSharing.setDefaultShareScope ​

ts
setDefaultShareScope: (parameters, options?) => Promise<{
[key: string]: unknown;
  scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE";
}>;
Parameters ​
ParameterTypeDescription
parameters{ scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE"; }-
parameters.scopestring & 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; scope: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE"; }>

groupAndUserPicker ​

ts
groupAndUserPicker: object;

groupAndUserPicker.findUsersAndGroups ​

ts
findUsersAndGroups: (parameters, options?) => 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 ​
ParameterTypeDescription
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?booleanWhether the search for groups should be case insensitive.
parameters.excludeConnectAddons?booleanWhether 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?stringThe custom field ID of the field this request is for.
parameters.includeAiAgents?booleanWhether 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?numberThe 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?stringThe search string.
parameters.showAvatar?booleanWhether the user avatar should be returned. If an invalid value is provided, the default value is used.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ accountId?: string; groupId?: string; groupname?: string; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.groupId?stringThe ID of the group. This parameter cannot be used with the groupName parameter.
parameters.groupname?stringAs 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.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ name: string; }-
parameters.namestringThe name of the group.
options?RequestOptions-
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?, options?) => Promise<{
[key: string]: unknown;
  groups?: object[];
  header?: string;
  total?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters?{ caseInsensitive?: boolean; exclude?: string[]; excludeId?: string[]; maxResults?: number; query?: string; }-
parameters.caseInsensitive?booleanWhether 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?numberThe 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?stringThe string to find in group names.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; groups?: object[]; header?: string; total?: number; }>

groups.getUsersFromGroup ​

ts
getUsersFromGroup: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ groupId?: string; groupname?: string; includeInactiveUsers?: boolean; maxResults?: number; startAt?: number; }-
parameters.groupId?stringThe ID of the group. This parameter cannot be used with the groupName parameter.
parameters.groupname?stringAs 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?booleanInclude inactive users.
parameters.maxResults?numberThe maximum number of items to return per page (number should be between 1 and 50).
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

groups.removeGroup ​

ts
removeGroup: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ groupId?: string; groupname?: string; swapGroup?: string; swapGroupId?: string; }-
parameters.groupId?stringThe ID of the group. This parameter cannot be used with the groupname parameter.
parameters.groupname?string-
parameters.swapGroup?stringAs 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?stringThe 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.
options?RequestOptions-
Returns ​

Promise<void>

groups.removeUserFromGroup ​

ts
removeUserFromGroup: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; groupId?: string; groupname?: string; }-
parameters.accountIdstringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.groupId?stringThe ID of the group. This parameter cannot be used with the groupName parameter.
parameters.groupname?stringAs 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.
options?RequestOptions-
Returns ​

Promise<void>

issueAttachments ​

ts
issueAttachments: object;

issueAttachments.addAttachment ​

ts
addAttachment: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ attachments: | AttachmentInput | AttachmentInput[]; issueIdOrKey: string; }-
parameters.attachments| AttachmentInput | AttachmentInput[]-
parameters.issueIdOrKey?stringThe ID or key of the issue that attachments are added to.
options?RequestOptions-
Returns ​

Promise<object[]>

issueAttachments.getAttachment ​

ts
getAttachment: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the attachment.
options?RequestOptions-
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, options?) => Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; redirect?: boolean; }-
parameters.idstringThe ID of the attachment.
parameters.redirect?booleanWhether 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.
options?RequestOptions-
Returns ​

Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>

issueAttachments.getAttachmentMeta ​

ts
getAttachmentMeta: (options?) => Promise<{
[key: string]: unknown;
  enabled?: boolean;
  uploadLimit?: number;
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; enabled?: boolean; uploadLimit?: number; }>

issueAttachments.getAttachmentThumbnail ​

ts
getAttachmentThumbnail: (parameters, options?) => Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>;
Parameters ​
ParameterTypeDescription
parameters{ fallbackToDefault?: boolean; height?: number; id: string; redirect?: boolean; width?: number; }-
parameters.fallbackToDefault?booleanWhether a default thumbnail is returned when the requested thumbnail is not found.
parameters.height?numberThe maximum height to scale the thumbnail to.
parameters.id?stringThe ID of the attachment.
parameters.redirect?booleanWhether 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?numberThe maximum width to scale the thumbnail to.
options?RequestOptions-
Returns ​

Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>

issueAttachments.removeAttachment ​

ts
removeAttachment: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the attachment.
options?RequestOptions-
Returns ​

Promise<void>

issueBulkOperations ​

ts
issueBulkOperations: object;

issueBulkOperations.getAvailableTransitions ​

ts
getAvailableTransitions: (parameters, options?) => Promise<{
[key: string]: unknown;
  availableTransitions?: object[];
  endingBefore?: string;
  startingAfter?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ endingBefore?: string; issueIdsOrKeys: string; startingAfter?: string; }-
parameters.endingBefore?string(Optional)The end cursor for use in pagination.
parameters.issueIdsOrKeys?stringComma (,) separated Ids or keys of the issues to get transitions available for them.
parameters.startingAfter?string(Optional)The start cursor for use in pagination.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; availableTransitions?: object[]; endingBefore?: string; startingAfter?: string; }>

issueBulkOperations.getBulkEditableFields ​

ts
getBulkEditableFields: (parameters, options?) => Promise<{
[key: string]: unknown;
  endingBefore?: string;
  fields?: object[];
  startingAfter?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ endingBefore?: string; issueIdsOrKeys: string; searchText?: string; startingAfter?: string; }-
parameters.endingBefore?string(Optional)The end cursor for use in pagination.
parameters.issueIdsOrKeys?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; endingBefore?: string; fields?: object[]; startingAfter?: string; }>

issueBulkOperations.getBulkOperationProgress ​

ts
getBulkOperationProgress: (parameters, options?) => Promise<{
[key: string]: unknown;
  created?: Date;
  failedAccessibleIssues?: Record<string, string[]>;
  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 ​
ParameterTypeDescription
parameters{ taskId: string; }-
parameters.taskIdstringThe ID of the task.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; created?: Date; failedAccessibleIssues?: Record<string, string[]>; 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, options?) => Promise<{
[key: string]: unknown;
  taskId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ selectedIssueIdsOrKeys: string[]; sendBulkNotification?: boolean | null; }-
parameters.selectedIssueIdsOrKeysstring[]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 | nullA 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; taskId?: string; }>

issueBulkOperations.submitBulkEdit ​

ts
submitBulkEdit: (parameters, options?) => Promise<{
[key: string]: unknown;
  taskId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ editedFieldsInput: { cascadingSelectFields?: object[]; clearableNumberFields?: object[]; colorFields?: object[]; datePickerFields?: object[]; dateTimePickerFields?: object[]; issueType?: { issueTypeId: string; }; labelsFields?: object[]; multipleGroupPickerFields?: object[]; multipleSelectClearableUserPickerFields?: object[]; multipleSelectFields?: object[]; multipleVersionPickerFields?: object[]; multiselectComponents?: { bulkEditMultiSelectFieldOption: string & object | "ADD" | "REMOVE" | "REPLACE" | "REMOVE_ALL"; components: object[]; fieldId: string; }; originalEstimateField?: { originalEstimateField: string; }; priority?: { priorityId: string; }; richTextFields?: object[]; singleGroupPickerFields?: object[]; singleLineTextFields?: object[]; singleSelectClearableUserPickerFields?: object[]; singleSelectFields?: object[]; singleVersionPickerFields?: object[]; status?: { statusId: string; }; timeTrackingField?: { timeRemaining: string; }; urlFields?: object[]; }; selectedActions: string[]; selectedIssueIdsOrKeys: string[]; sendBulkNotification?: boolean | null; }-
parameters.editedFieldsInput{ cascadingSelectFields?: object[]; clearableNumberFields?: object[]; colorFields?: object[]; datePickerFields?: object[]; dateTimePickerFields?: object[]; issueType?: { issueTypeId: string; }; labelsFields?: object[]; multipleGroupPickerFields?: object[]; multipleSelectClearableUserPickerFields?: object[]; multipleSelectFields?: object[]; multipleVersionPickerFields?: object[]; multiselectComponents?: { bulkEditMultiSelectFieldOption: string & object | "ADD" | "REMOVE" | "REPLACE" | "REMOVE_ALL"; components: object[]; fieldId: string; }; originalEstimateField?: { originalEstimateField: string; }; priority?: { priorityId: string; }; richTextFields?: object[]; singleGroupPickerFields?: object[]; singleLineTextFields?: object[]; singleSelectClearableUserPickerFields?: object[]; singleSelectFields?: object[]; singleVersionPickerFields?: object[]; status?: { statusId: string; }; timeTrackingField?: { 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?{ 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?{ 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?{ originalEstimateField: string; }-
parameters.editedFieldsInput.originalEstimateField.originalEstimateField?string-
parameters.editedFieldsInput.priority?{ 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?{ statusId: string; }-
parameters.editedFieldsInput.status.statusId?string-
parameters.editedFieldsInput.timeTrackingField?{ 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 | nullA 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; taskId?: string; }>

issueBulkOperations.submitBulkMove ​

ts
submitBulkMove: (parameters, options?) => Promise<{
[key: string]: unknown;
  taskId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ sendBulkNotification?: boolean | null; targetToSourcesMapping?: Record<string, { inferClassificationDefaults: boolean; inferFieldDefaults: boolean; inferStatusDefaults: boolean; inferSubtaskTypeDefault: boolean; issueIdsOrKeys?: string[]; targetClassification?: object[] | null; targetMandatoryFields?: object[] | null; targetStatus?: object[] | null; }>; }-
parameters.sendBulkNotification?boolean | nullA 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, { inferClassificationDefaults: boolean; inferFieldDefaults: boolean; inferStatusDefaults: boolean; inferSubtaskTypeDefault: boolean; issueIdsOrKeys?: string[]; targetClassification?: object[] | null; targetMandatoryFields?: object[] | null; targetStatus?: object[] | null; }>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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; taskId?: string; }>

issueBulkOperations.submitBulkTransition ​

ts
submitBulkTransition: (parameters, options?) => Promise<{
[key: string]: unknown;
  taskId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ bulkTransitionInputs: object[]; sendBulkNotification?: boolean | null; }-
parameters.bulkTransitionInputsobject[]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 | nullA 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; taskId?: string; }>

issueBulkOperations.submitBulkUnwatch ​

ts
submitBulkUnwatch: (parameters, options?) => Promise<{
[key: string]: unknown;
  taskId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ selectedIssueIdsOrKeys: string[]; }-
parameters.selectedIssueIdsOrKeysstring[]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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; taskId?: string; }>

issueBulkOperations.submitBulkWatch ​

ts
submitBulkWatch: (parameters, options?) => Promise<{
[key: string]: unknown;
  taskId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ selectedIssueIdsOrKeys: string[]; }-
parameters.selectedIssueIdsOrKeysstring[]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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; taskId?: string; }>

issueCommentProperties ​

ts
issueCommentProperties: object;

issueCommentProperties.deleteCommentProperty ​

ts
deleteCommentProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ commentId: string; propertyKey: string; }-
parameters.commentIdstringThe ID of the comment.
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-
Returns ​

Promise<void>

issueCommentProperties.getCommentProperty ​

ts
getCommentProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ commentId: string; propertyKey: string; }-
parameters.commentIdstringThe ID of the comment.
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

issueCommentProperties.getCommentPropertyKeys ​

ts
getCommentPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ commentId: string; }-
parameters.commentIdstringThe ID of the comment.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>

issueCommentProperties.setCommentProperty ​

ts
setCommentProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ body: Record<string, any>; commentId: string; propertyKey: string; }-
parameters.bodyRecord<string, any>-
parameters.commentId?stringThe ID of the comment.
parameters.propertyKey?stringThe key of the property. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<void>

issueComments ​

ts
issueComments: object;

issueComments.addComment ​

ts
addComment: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ author?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: | string | { content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; expand?: | string & object | "renderedBody" | (string & object | "renderedBody")[]; id?: string; issueIdOrKey: string; jsdAuthorCanSeeRequest?: boolean; jsdPublic?: boolean; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }-
parameters.author?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.author.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.author.accountType?stringThe 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?booleanWhether the user is active.
parameters.author.avatarUrls?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.author.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.author.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.author.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.author.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.author.displayName?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.author.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.author.self?stringThe URL of the user.
parameters.author.timeZone?stringThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
parameters.body?| string | { 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?unknownThe date and time at which the comment was created.
parameters.expand?| string & object | "renderedBody" | (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?stringThe ID of the comment.
parameters.issueIdOrKey?stringThe ID or key of the issue.
parameters.jsdAuthorCanSeeRequest?booleanWhether 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?booleanWhether 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?stringThe rendered version of the comment.
parameters.self?stringThe URL of the comment.
parameters.updateAuthor?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.updateAuthor.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.updateAuthor.accountType?stringThe 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?booleanWhether the user is active.
parameters.updateAuthor.avatarUrls?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.updateAuthor.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.updateAuthor.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.updateAuthor.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.updateAuthor.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.updateAuthor.displayName?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.updateAuthor.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.updateAuthor.self?stringThe URL of the user.
parameters.updateAuthor.timeZone?stringThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
parameters.updated?unknownThe date and time at which the comment was updated last.
parameters.visibility?{ identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }-
parameters.visibility.identifier?string | nullThe ID of the group or the name of the role that visibility of this item is restricted to.
parameters.visibility.type?"role" | "group" | string & objectWhether visibility of this item is restricted to a group or role.
parameters.visibility.value?stringThe 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.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; issueIdOrKey: string; }-
parameters.idstringThe ID of the comment.
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<void>

issueComments.getComment ​

ts
getComment: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | string & object | "renderedBody" | (string & object | "renderedBody")[]; id: string; issueIdOrKey: string; }-
parameters.expand?| string & object | "renderedBody" | (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?stringThe ID of the comment.
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  comments?: object[];
  maxResults?: number;
  self?: string;
  startAt?: number;
  total?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | string & object | "renderedBody" | (string & object | "renderedBody")[]; issueIdOrKey: string; maxResults?: number; orderBy?: string & object | "created" | "-created" | "+created"; startAt?: number; }-
parameters.expand?| string & object | "renderedBody" | (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?stringThe ID or key of the issue.
parameters.maxResults?numberThe 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?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; comments?: object[]; maxResults?: number; self?: string; startAt?: number; total?: number; }>

issueComments.getCommentsByIds ​

ts
getCommentsByIds: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | "properties" | string & object | "renderedBody" | ("properties" | string & object | "renderedBody")[]; ids: number[]; }-
parameters.expand?| "properties" | string & object | "renderedBody" | ("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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueComments.updateComment ​

ts
updateComment: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ body: { author?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: | string | { 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?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }; expand?: | string & object | "renderedBody" | (string & object | "renderedBody")[]; id: string; issueIdOrKey: string; notifyUsers?: boolean; overrideEditableFlag?: boolean; }-
parameters.body{ author?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: | string | { 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?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }-
parameters.body.author?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.body.author.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.body.author.accountType?stringThe 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?booleanWhether the user is active.
parameters.body.author.avatarUrls?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.author.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.author.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.author.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.author.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.author.displayName?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.body.author.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.body.author.self?stringThe URL of the user.
parameters.body.author.timeZone?stringThe 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 | { 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?unknownThe date and time at which the comment was created.
parameters.body.id?stringThe ID of the comment.
parameters.body.jsdAuthorCanSeeRequest?booleanWhether 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?booleanWhether 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?stringThe rendered version of the comment.
parameters.body.self?stringThe URL of the comment.
parameters.body.updateAuthor?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.body.updateAuthor.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.body.updateAuthor.accountType?stringThe 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?booleanWhether the user is active.
parameters.body.updateAuthor.avatarUrls?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.updateAuthor.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.updateAuthor.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.updateAuthor.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.updateAuthor.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.updateAuthor.displayName?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.body.updateAuthor.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.body.updateAuthor.self?stringThe URL of the user.
parameters.body.updateAuthor.timeZone?stringThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
parameters.body.updated?unknownThe date and time at which the comment was updated last.
parameters.body.visibility?{ identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }-
parameters.body.visibility.identifier?string | nullThe 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 & objectWhether visibility of this item is restricted to a group or role.
parameters.body.visibility.value?stringThe 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 & object | "renderedBody" | (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?stringThe ID of the comment.
parameters.issueIdOrKey?stringThe ID or key of the issue.
parameters.notifyUsers?booleanWhether users are notified when a comment is updated.
parameters.overrideEditableFlag?booleanWhether 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.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ associationContexts: object[]; fields: object[]; }-
parameters.associationContextsobject[]Contexts to associate/unassociate the fields with.
parameters.fields?object[]Fields to associate/unassociate with projects.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldAssociations.removeAssociations ​

ts
removeAssociations: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ associationContexts: object[]; fields: object[]; }-
parameters.associationContextsobject[]Contexts to associate/unassociate the fields with.
parameters.fields?object[]Fields to associate/unassociate with projects.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldConfigurationApps ​

ts
issueCustomFieldConfigurationApps: object;

issueCustomFieldConfigurationApps.getCustomFieldConfiguration ​

ts
getCustomFieldConfiguration: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
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?stringThe 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?numberThe 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?stringThe ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.projectKeyOrId?stringThe ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldConfigurationApps.updateCustomFieldConfiguration ​

ts
updateCustomFieldConfiguration: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ configurations: object[]; fieldIdOrKey: string; }-
parameters.configurationsobject[]The list of custom field configuration details.
parameters.fieldIdOrKey?stringThe ID or key of the custom field, for example customfield_10000.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldContexts ​

ts
issueCustomFieldContexts: object;

issueCustomFieldContexts.addIssueTypesToContext ​

ts
addIssueTypesToContext: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; issueTypeIds: string[]; }-
parameters.contextIdnumberThe ID of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.issueTypeIds?string[]The list of issue type IDs.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldContexts.assignProjectsToCustomFieldContext ​

ts
assignProjectsToCustomFieldContext: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; projectIds: string[]; }-
parameters.contextIdnumberThe ID of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.projectIds?string[]The IDs of projects.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldContexts.createCustomFieldContext ​

ts
createCustomFieldContext: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  issueTypeIds?: string[];
  name: string;
  projectIds?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ description?: string; fieldId: string; id?: string; issueTypeIds?: string[]; name: string; projectIds?: string[]; }-
parameters.description?stringThe description of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.id?stringThe 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?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; description?: string; id?: string; issueTypeIds?: string[]; name: string; projectIds?: string[]; }>

issueCustomFieldContexts.deleteCustomFieldContext ​

ts
deleteCustomFieldContext: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; }-
parameters.contextIdnumberThe ID of the context.
parameters.fieldId?stringThe ID of the custom field.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldContexts.getContextDefaultValues ​

ts
getContextDefaultValues: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
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?stringThe 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?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldContexts.getContextsForField ​

ts
getContextsForField: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
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?stringThe ID of the custom field.
parameters.isAnyIssueType?booleanWhether to return contexts that apply to all issue types.
parameters.isGlobalContext?booleanWhether to return contexts that apply to all projects.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldContexts.getCustomFieldContextsForProjectsAndIssueTypes ​

ts
getCustomFieldContextsForProjectsAndIssueTypes: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ fieldId: string; mappings: object[]; maxResults?: number; startAt?: number; }-
parameters.fieldIdstringThe ID of the custom field.
parameters.mappings?object[]The project and issue type mappings.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldContexts.getIssueTypeMappingsForContexts ​

ts
getIssueTypeMappingsForContexts: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
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?stringThe ID of the custom field.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldContexts.getProjectContextMapping ​

ts
getProjectContextMapping: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
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?stringThe ID of the custom field, for example customfield\_10000.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldContexts.removeCustomFieldContextFromProjects ​

ts
removeCustomFieldContextFromProjects: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; projectIds: string[]; }-
parameters.contextIdnumberThe ID of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.projectIds?string[]The IDs of projects.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldContexts.removeIssueTypesFromContext ​

ts
removeIssueTypesFromContext: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; issueTypeIds: string[]; }-
parameters.contextIdnumberThe ID of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.issueTypeIds?string[]The list of issue type IDs.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldContexts.updateCustomFieldContext ​

ts
updateCustomFieldContext: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; description?: string; fieldId: string; name?: string; }-
parameters.contextIdnumberThe ID of the context.
parameters.description?stringThe description of the custom field context. The maximum length is 255 characters.
parameters.fieldId?stringThe ID of the custom field.
parameters.name?stringThe name of the custom field context. The name must be unique. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldOptions ​

ts
issueCustomFieldOptions: object;

issueCustomFieldOptions.createCustomFieldOption ​

ts
createCustomFieldOption: (parameters, options?) => Promise<{
[key: string]: unknown;
  options?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; options?: object[]; }-
parameters.contextIdnumberThe ID of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.options?object[]Details of options to create.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; options?: object[]; }>

issueCustomFieldOptions.deleteCustomFieldOption ​

ts
deleteCustomFieldOption: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; optionId: number; }-
parameters.contextIdnumberThe ID of the context from which an option should be deleted.
parameters.fieldId?stringThe ID of the custom field.
parameters.optionId?numberThe ID of the option to delete.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldOptions.getCustomFieldOption ​

ts
getCustomFieldOption: (parameters, options?) => Promise<{
[key: string]: unknown;
  self?: string;
  value?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the custom field option.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; self?: string; value?: string; }>

issueCustomFieldOptions.getOptionsForContext ​

ts
getOptionsForContext: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; maxResults?: number; onlyOptions?: boolean; optionId?: number; startAt?: number; }-
parameters.contextIdnumberThe ID of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.onlyOptions?booleanWhether only options are returned.
parameters.optionId?numberThe ID of the option.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldOptions.reorderCustomFieldOptions ​

ts
reorderCustomFieldOptions: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ after?: string; contextId: number; customFieldOptionIds: string[]; fieldId: string; position?: string & object | "First" | "Last"; }-
parameters.after?stringThe ID of the custom field option or cascading option to place the moved options after. Required if position isn't provided.
parameters.contextId?numberThe 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?stringThe 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.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldOptions.replaceCustomFieldOption ​

ts
replaceCustomFieldOption: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; jql?: string; optionId: number; replaceWith?: number; }-
parameters.contextIdnumberThe ID of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.jql?stringA JQL query that specifies the issues to be updated. For example, project=10000.
parameters.optionId?numberThe ID of the option to be deselected.
parameters.replaceWith?numberThe ID of the option that will replace the currently selected option.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  options?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ contextId: number; fieldId: string; options?: object[]; }-
parameters.contextIdnumberThe ID of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.options?object[]Details of the options to update.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; options?: object[]; }>

issueCustomFieldOptionsApps ​

ts
issueCustomFieldOptionsApps: object;

issueCustomFieldOptionsApps.createIssueFieldOption ​

ts
createIssueFieldOption: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ config?: { attributes?: (string & object | "defaultValue" | "notSelectable")[]; scope?: { global?: { attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }; }; fieldKey: string; properties?: Record<string, any>; value: string; }-
parameters.config?{ attributes?: (string & object | "defaultValue" | "notSelectable")[]; scope?: { global?: { attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }; }-
parameters.config.attributes?(string & object | "defaultValue" | "notSelectable")[]DEPRECATED
parameters.config.scope?{ global?: { attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }-
parameters.config.scope.global?{ 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?stringThe 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?stringThe option's name, which is displayed in Jira.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ fieldKey: string; optionId: number; }-
parameters.fieldKeystringThe 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?numberThe ID of the option to be deleted.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldOptionsApps.getAllIssueFieldOptions ​

ts
getAllIssueFieldOptions: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ fieldKey: string; maxResults?: number; startAt?: number; }-
parameters.fieldKeystringThe 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?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldOptionsApps.getIssueFieldOption ​

ts
getIssueFieldOption: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ fieldKey: string; optionId: number; }-
parameters.fieldKeystringThe 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?numberThe ID of the option to be returned.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ fieldKey: string; maxResults?: number; projectId?: number; startAt?: number; }-
parameters.fieldKeystringThe 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?numberThe maximum number of items to return per page.
parameters.projectId?numberFilters the results to options that are only available in the specified project.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldOptionsApps.getVisibleIssueFieldOptions ​

ts
getVisibleIssueFieldOptions: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ fieldKey: string; maxResults?: number; projectId?: number; startAt?: number; }-
parameters.fieldKeystringThe 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?numberThe maximum number of items to return per page.
parameters.projectId?numberFilters the results to options that are only available in the specified project.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueCustomFieldOptionsApps.replaceIssueFieldOption ​

ts
replaceIssueFieldOption: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ fieldKey: string; jql?: string; optionId: number; overrideEditableFlag?: boolean; overrideScreenSecurity?: boolean; replaceWith?: number; }-
parameters.fieldKeystringThe 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?stringA JQL query that specifies the issues to be updated. For example, project=10000.
parameters.optionId?numberThe ID of the option to be deselected.
parameters.overrideEditableFlag?booleanWhether 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?booleanWhether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.
parameters.replaceWith?numberThe ID of the option that will replace the currently selected option.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ config?: { attributes?: (string & object | "defaultValue" | "notSelectable")[]; scope?: { global?: { attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }; }; fieldKey: string; id: number; optionId: number; properties?: Record<string, any>; value: string; }-
parameters.config?{ attributes?: (string & object | "defaultValue" | "notSelectable")[]; scope?: { global?: { attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }; }-
parameters.config.attributes?(string & object | "defaultValue" | "notSelectable")[]DEPRECATED
parameters.config.scope?{ global?: { attributes?: ... | ...; }; projects?: number[]; projects2?: object[]; }-
parameters.config.scope.global?{ 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?stringThe 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?numberThe unique identifier for the option. This is only unique within the select field's set of options.
parameters.optionId?numberThe 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?stringThe option's name, which is displayed in Jira.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ fieldIdOrKey: string; generateAppEvents?: boolean; generateChangelog?: boolean; updates?: object[]; }-
parameters.fieldIdOrKeystringThe ID or key of the custom field. For example, customfield_10010.
parameters.generateAppEvents?booleanWhether 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?booleanWhether to generate a changelog for this update.
parameters.updates?object[]The list of custom field update details.
options?RequestOptions-
Returns ​

Promise<void>

issueCustomFieldValuesApps.updateMultipleCustomFieldValues ​

ts
updateMultipleCustomFieldValues: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ generateAppEvents?: boolean; generateChangelog?: boolean; updates?: object[]; }-
parameters.generateAppEvents?booleanWhether 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?booleanWhether to generate a changelog for this update.
parameters.updates?object[]-
options?RequestOptions-
Returns ​

Promise<void>

issueFields ​

ts
issueFields: object;

issueFields.createCustomField ​

ts
createCustomField: (parameters, options?) => 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 ​
ParameterTypeDescription
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 & object | "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect" | "com.atlassian.jira.plugin.system.customfieldtypes:datepicker" | "com.atlassian.jira.plugin.system.customfieldtypes:datetime" | "com.atlassian.jira.plugin.system.customfieldtypes:float" | "com.atlassian.jira.plugin.system.customfieldtypes:grouppicker" | "com.atlassian.jira.plugin.system.customfieldtypes:importid" | "com.atlassian.jira.plugin.system.customfieldtypes:labels" | "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes" | "com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker" | "com.atlassian.jira.plugin.system.customfieldtypes:multiselect" | "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker" | "com.atlassian.jira.plugin.system.customfieldtypes:multiversion" | "com.atlassian.jira.plugin.system.customfieldtypes:project" | "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons" | "com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield" | "com.atlassian.jira.plugin.system.customfieldtypes:select" | "com.atlassian.jira.plugin.system.customfieldtypes:textarea" | "com.atlassian.jira.plugin.system.customfieldtypes:textfield" | "com.atlassian.jira.plugin.system.customfieldtypes:url" | "com.atlassian.jira.plugin.system.customfieldtypes:userpicker" | "com.atlassian.jira.plugin.system.customfieldtypes:version"; }-
parameters.description?stringThe description of the custom field, which is displayed in Jira.
parameters.name?stringThe 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 & object | "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect" | "com.atlassian.jira.plugin.system.customfieldtypes:datepicker" | "com.atlassian.jira.plugin.system.customfieldtypes:datetime" | "com.atlassian.jira.plugin.system.customfieldtypes:float" | "com.atlassian.jira.plugin.system.customfieldtypes:grouppicker" | "com.atlassian.jira.plugin.system.customfieldtypes:importid" | "com.atlassian.jira.plugin.system.customfieldtypes:labels" | "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes" | "com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker" | "com.atlassian.jira.plugin.system.customfieldtypes:multiselect" | "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker" | "com.atlassian.jira.plugin.system.customfieldtypes:multiversion" | "com.atlassian.jira.plugin.system.customfieldtypes:project" | "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons" | "com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield" | "com.atlassian.jira.plugin.system.customfieldtypes:select" | "com.atlassian.jira.plugin.system.customfieldtypes:textarea" | "com.atlassian.jira.plugin.system.customfieldtypes:textfield" | "com.atlassian.jira.plugin.system.customfieldtypes:url" | "com.atlassian.jira.plugin.system.customfieldtypes:userpicker" | "com.atlassian.jira.plugin.system.customfieldtypes:version"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.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of a custom field.
options?RequestOptions-
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: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

issueFields.getFieldsPaginated ​

ts
getFieldsPaginated: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | "key" | string & object | "searcherKey" | "contextsCount" | "isLocked" | "lastUsed" | "screensCount" | "stableId" | ( | "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?| "key" | string & object | "searcherKey" | "contextsCount" | "isLocked" | "lastUsed" | "screensCount" | "stableId" | ( | "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?numberThe 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?stringString used to perform a case-insensitive partial match with field names or descriptions.
parameters.startAt?numberThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueFields.getTrashedFieldsPaginated ​

ts
getTrashedFieldsPaginated: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | "name" | string & object | "projectsCount" | "-name" | "+name" | "-projectsCount" | "+projectsCount" | "trashDate" | "-trashDate" | "+trashDate" | "plannedDeletionDate" | "-plannedDeletionDate" | "+plannedDeletionDate"; id?: string[]; maxResults?: number; orderBy?: | "name" | string & object | "-name" | "+name" | "trashDate" | "-trashDate" | "+trashDate" | "plannedDeletionDate" | "-plannedDeletionDate" | "+plannedDeletionDate"; 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?numberThe maximum number of items to return per page.
parameters.orderBy?| "name" | string & object | "-name" | "+name" | "trashDate" | "-trashDate" | "+trashDate" | "plannedDeletionDate" | "-plannedDeletionDate" | "+plannedDeletionDate"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?stringString used to perform a case-insensitive partial match with field names or descriptions.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueFields.restoreCustomField ​

ts
restoreCustomField: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of a custom field.
options?RequestOptions-
Returns ​

Promise<void>

issueFields.trashCustomField ​

ts
trashCustomField: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of a custom field.
options?RequestOptions-
Returns ​

Promise<void>

issueFields.updateCustomField ​

ts
updateCustomField: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
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?stringThe description of the custom field. The maximum length is 40000 characters.
parameters.fieldId?stringThe ID of the custom field.
parameters.name?stringThe 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
options?RequestOptions-
Returns ​

Promise<void>

ts
issueLinks: object;
ts
deleteIssueLink: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ linkId: string; }-
parameters.linkIdstringThe ID of the issue link.
options?RequestOptions-
Returns ​

Promise<void>

ts
getIssueLink: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ linkId: string; }-
parameters.linkIdstringThe ID of the issue link.
options?RequestOptions-
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; }; }>

ts
linkIssues: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ comment?: { author?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: { 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?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }; inwardIssue: { fields?: { assignee?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; statusCategory?: { colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }; id?: string; key?: string; self?: string; }; outwardIssue: { fields?: { assignee?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; statusCategory?: { colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }; id?: string; key?: string; self?: string; }; type: { id?: string; inward?: string; name?: string; outward?: string; self?: string; }; }-
parameters.comment?{ author?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; body?: { 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?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }-
parameters.comment.author?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.comment.author.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.comment.author.accountType?stringThe 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?booleanWhether the user is active.
parameters.comment.author.avatarUrls?{ 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?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.comment.author.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.comment.author.self?stringThe URL of the user.
parameters.comment.author.timeZone?stringThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
parameters.comment.body?{ 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?unknownThe date and time at which the comment was created.
parameters.comment.id?stringThe ID of the comment.
parameters.comment.jsdAuthorCanSeeRequest?booleanWhether 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?booleanWhether 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?stringThe rendered version of the comment.
parameters.comment.self?stringThe URL of the comment.
parameters.comment.updateAuthor?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.comment.updateAuthor.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.comment.updateAuthor.accountType?stringThe 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?booleanWhether the user is active.
parameters.comment.updateAuthor.avatarUrls?{ 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?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.comment.updateAuthor.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.comment.updateAuthor.self?stringThe URL of the user.
parameters.comment.updateAuthor.timeZone?stringThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
parameters.comment.updated?unknownThe date and time at which the comment was updated last.
parameters.comment.visibility?{ identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }-
parameters.comment.visibility.identifier?string | nullThe 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 & objectWhether visibility of this item is restricted to a group or role.
parameters.comment.visibility.value?stringThe 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?{ fields?: { assignee?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; statusCategory?: { colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }; id?: string; key?: string; self?: string; }-
parameters.inwardIssue.fields?{ assignee?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; statusCategory?: { colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }-
parameters.inwardIssue.fields.assignee?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.inwardIssue.fields.assignee.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.inwardIssue.fields.assignee.accountType?stringThe 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?booleanWhether the user is active.
parameters.inwardIssue.fields.assignee.avatarUrls?{ 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?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.inwardIssue.fields.assignee.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.inwardIssue.fields.assignee.self?stringThe URL of the user.
parameters.inwardIssue.fields.assignee.timeZone?stringThe 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?{ avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }The type of the linked issue.
parameters.inwardIssue.fields.issuetype.avatarId?numberThe ID of the issue type's avatar.
parameters.inwardIssue.fields.issuetype.description?stringThe description of the issue type.
parameters.inwardIssue.fields.issuetype.entityId?stringUnique ID for next-gen projects.
parameters.inwardIssue.fields.issuetype.hierarchyLevel?numberHierarchy level of the issue type.
parameters.inwardIssue.fields.issuetype.iconUrl?stringThe URL of the issue type's avatar.
parameters.inwardIssue.fields.issuetype.id?stringThe ID of the issue type.
parameters.inwardIssue.fields.issuetype.name?stringThe name of the issue type.
parameters.inwardIssue.fields.issuetype.scope?{ project?: ...; type?: ...; }-
parameters.inwardIssue.fields.issuetype.scope.project?...-
parameters.inwardIssue.fields.issuetype.scope.type?...The type of scope.
parameters.inwardIssue.fields.issuetype.self?stringThe URL of these issue type details.
parameters.inwardIssue.fields.issuetype.subtask?booleanWhether this issue type is used to create subtasks.
parameters.inwardIssue.fields.issuetype.untranslatedName?string-
parameters.inwardIssue.fields.issueType?{ avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }-
parameters.inwardIssue.fields.issueType.avatarId?numberThe ID of the issue type's avatar.
parameters.inwardIssue.fields.issueType.description?stringThe description of the issue type.
parameters.inwardIssue.fields.issueType.entityId?stringUnique ID for next-gen projects.
parameters.inwardIssue.fields.issueType.hierarchyLevel?numberHierarchy level of the issue type.
parameters.inwardIssue.fields.issueType.iconUrl?stringThe URL of the issue type's avatar.
parameters.inwardIssue.fields.issueType.id?stringThe ID of the issue type.
parameters.inwardIssue.fields.issueType.name?stringThe name of the issue type.
parameters.inwardIssue.fields.issueType.scope?{ project?: ...; type?: ...; }-
parameters.inwardIssue.fields.issueType.scope.project?...-
parameters.inwardIssue.fields.issueType.scope.type?...The type of scope.
parameters.inwardIssue.fields.issueType.self?stringThe URL of these issue type details.
parameters.inwardIssue.fields.issueType.subtask?booleanWhether this issue type is used to create subtasks.
parameters.inwardIssue.fields.issueType.untranslatedName?string-
parameters.inwardIssue.fields.priority?{ avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }-
parameters.inwardIssue.fields.priority.avatarId?numberThe 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?stringThe description of the issue priority.
parameters.inwardIssue.fields.priority.iconUrl?stringThe URL of the icon for the issue priority.
parameters.inwardIssue.fields.priority.id?stringThe ID of the issue priority.
parameters.inwardIssue.fields.priority.isDefault?booleanWhether this priority is the default.
parameters.inwardIssue.fields.priority.name?stringThe name of the issue priority.
parameters.inwardIssue.fields.priority.schemes?{ 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?stringThe URL of the issue priority.
parameters.inwardIssue.fields.priority.statusColor?stringThe color used to indicate the issue priority.
parameters.inwardIssue.fields.status?{ description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; statusCategory?: { colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }-
parameters.inwardIssue.fields.status.description?stringThe description of the status.
parameters.inwardIssue.fields.status.iconUrl?stringThe URL of the icon used to represent the status.
parameters.inwardIssue.fields.status.id?stringThe ID of the status.
parameters.inwardIssue.fields.status.name?stringThe name of the status.
parameters.inwardIssue.fields.status.scope?{ project?: ...; type?: ...; }-
parameters.inwardIssue.fields.status.scope.project?...-
parameters.inwardIssue.fields.status.scope.type?...The type of scope.
parameters.inwardIssue.fields.status.self?stringThe URL of the status.
parameters.inwardIssue.fields.status.statusCategory?{ 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?stringThe summary description of the linked issue.
parameters.inwardIssue.fields.timetracking?{ originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }-
parameters.inwardIssue.fields.timetracking.originalEstimate?stringThe original estimate of time needed for this issue in readable format.
parameters.inwardIssue.fields.timetracking.originalEstimateSeconds?numberThe original estimate of time needed for this issue in seconds.
parameters.inwardIssue.fields.timetracking.remainingEstimate?stringThe remaining estimate of time needed for this issue in readable format.
parameters.inwardIssue.fields.timetracking.remainingEstimateSeconds?numberThe remaining estimate of time needed for this issue in seconds.
parameters.inwardIssue.fields.timetracking.timeSpent?stringTime worked on this issue in readable format.
parameters.inwardIssue.fields.timetracking.timeSpentSeconds?numberTime worked on this issue in seconds.
parameters.inwardIssue.id?stringThe ID of an issue. Required if key isn't provided.
parameters.inwardIssue.key?stringThe key of an issue. Required if id isn't provided.
parameters.inwardIssue.self?stringThe URL of the issue.
parameters.outwardIssue?{ fields?: { assignee?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; statusCategory?: { colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }; id?: string; key?: string; self?: string; }-
parameters.outwardIssue.fields?{ assignee?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; issuetype?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; issueType?: { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }; priority?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; statusCategory?: { colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }; summary?: string; timetracking?: { originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }; }-
parameters.outwardIssue.fields.assignee?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.outwardIssue.fields.assignee.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.outwardIssue.fields.assignee.accountType?stringThe 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?booleanWhether the user is active.
parameters.outwardIssue.fields.assignee.avatarUrls?{ 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?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.outwardIssue.fields.assignee.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.outwardIssue.fields.assignee.self?stringThe URL of the user.
parameters.outwardIssue.fields.assignee.timeZone?stringThe 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?{ avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }The type of the linked issue.
parameters.outwardIssue.fields.issuetype.avatarId?numberThe ID of the issue type's avatar.
parameters.outwardIssue.fields.issuetype.description?stringThe description of the issue type.
parameters.outwardIssue.fields.issuetype.entityId?stringUnique ID for next-gen projects.
parameters.outwardIssue.fields.issuetype.hierarchyLevel?numberHierarchy level of the issue type.
parameters.outwardIssue.fields.issuetype.iconUrl?stringThe URL of the issue type's avatar.
parameters.outwardIssue.fields.issuetype.id?stringThe ID of the issue type.
parameters.outwardIssue.fields.issuetype.name?stringThe name of the issue type.
parameters.outwardIssue.fields.issuetype.scope?{ project?: ...; type?: ...; }-
parameters.outwardIssue.fields.issuetype.scope.project?...-
parameters.outwardIssue.fields.issuetype.scope.type?...The type of scope.
parameters.outwardIssue.fields.issuetype.self?stringThe URL of these issue type details.
parameters.outwardIssue.fields.issuetype.subtask?booleanWhether this issue type is used to create subtasks.
parameters.outwardIssue.fields.issuetype.untranslatedName?string-
parameters.outwardIssue.fields.issueType?{ avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }-
parameters.outwardIssue.fields.issueType.avatarId?numberThe ID of the issue type's avatar.
parameters.outwardIssue.fields.issueType.description?stringThe description of the issue type.
parameters.outwardIssue.fields.issueType.entityId?stringUnique ID for next-gen projects.
parameters.outwardIssue.fields.issueType.hierarchyLevel?numberHierarchy level of the issue type.
parameters.outwardIssue.fields.issueType.iconUrl?stringThe URL of the issue type's avatar.
parameters.outwardIssue.fields.issueType.id?stringThe ID of the issue type.
parameters.outwardIssue.fields.issueType.name?stringThe name of the issue type.
parameters.outwardIssue.fields.issueType.scope?{ project?: ...; type?: ...; }-
parameters.outwardIssue.fields.issueType.scope.project?...-
parameters.outwardIssue.fields.issueType.scope.type?...The type of scope.
parameters.outwardIssue.fields.issueType.self?stringThe URL of these issue type details.
parameters.outwardIssue.fields.issueType.subtask?booleanWhether this issue type is used to create subtasks.
parameters.outwardIssue.fields.issueType.untranslatedName?string-
parameters.outwardIssue.fields.priority?{ avatarId?: number; description?: string; iconUrl?: string; id?: string; isDefault?: boolean; name?: string; schemes?: { maxResults?: ...; startAt?: ...; total?: ...; }; self?: string; statusColor?: string; }-
parameters.outwardIssue.fields.priority.avatarId?numberThe 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?stringThe description of the issue priority.
parameters.outwardIssue.fields.priority.iconUrl?stringThe URL of the icon for the issue priority.
parameters.outwardIssue.fields.priority.id?stringThe ID of the issue priority.
parameters.outwardIssue.fields.priority.isDefault?booleanWhether this priority is the default.
parameters.outwardIssue.fields.priority.name?stringThe name of the issue priority.
parameters.outwardIssue.fields.priority.schemes?{ 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?stringThe URL of the issue priority.
parameters.outwardIssue.fields.priority.statusColor?stringThe color used to indicate the issue priority.
parameters.outwardIssue.fields.status?{ description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ...; type?: ...; }; self?: string; statusCategory?: { colorName?: ...; id?: ...; key?: ...; name?: ...; self?: ...; }; untranslatedName?: string; }-
parameters.outwardIssue.fields.status.description?stringThe description of the status.
parameters.outwardIssue.fields.status.iconUrl?stringThe URL of the icon used to represent the status.
parameters.outwardIssue.fields.status.id?stringThe ID of the status.
parameters.outwardIssue.fields.status.name?stringThe name of the status.
parameters.outwardIssue.fields.status.scope?{ project?: ...; type?: ...; }-
parameters.outwardIssue.fields.status.scope.project?...-
parameters.outwardIssue.fields.status.scope.type?...The type of scope.
parameters.outwardIssue.fields.status.self?stringThe URL of the status.
parameters.outwardIssue.fields.status.statusCategory?{ 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?stringThe summary description of the linked issue.
parameters.outwardIssue.fields.timetracking?{ originalEstimate?: string; originalEstimateSeconds?: number; remainingEstimate?: string; remainingEstimateSeconds?: number; timeSpent?: string; timeSpentSeconds?: number; }-
parameters.outwardIssue.fields.timetracking.originalEstimate?stringThe original estimate of time needed for this issue in readable format.
parameters.outwardIssue.fields.timetracking.originalEstimateSeconds?numberThe original estimate of time needed for this issue in seconds.
parameters.outwardIssue.fields.timetracking.remainingEstimate?stringThe remaining estimate of time needed for this issue in readable format.
parameters.outwardIssue.fields.timetracking.remainingEstimateSeconds?numberThe remaining estimate of time needed for this issue in seconds.
parameters.outwardIssue.fields.timetracking.timeSpent?stringTime worked on this issue in readable format.
parameters.outwardIssue.fields.timetracking.timeSpentSeconds?numberTime worked on this issue in seconds.
parameters.outwardIssue.id?stringThe ID of an issue. Required if key isn't provided.
parameters.outwardIssue.key?stringThe key of an issue. Required if id isn't provided.
parameters.outwardIssue.self?stringThe URL of the issue.
parameters.type?{ id?: string; inward?: string; name?: string; outward?: string; self?: string; }-
parameters.type.id?stringThe 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?stringThe 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?stringThe 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?stringThe 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?stringThe URL of the issue link type. Read only.
options?RequestOptions-
Returns ​

Promise<void>

issueLinkTypes ​

ts
issueLinkTypes: object;

issueLinkTypes.createIssueLinkType ​

ts
createIssueLinkType: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  inward?: string;
  name?: string;
  outward?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id?: string; inward?: string; name?: string; outward?: string; self?: string; }-
parameters.id?stringThe 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?stringThe 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?stringThe 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?stringThe 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?stringThe URL of the issue link type. Read only.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>

issueLinkTypes.deleteIssueLinkType ​

ts
deleteIssueLinkType: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueLinkTypeId: string; }-
parameters.issueLinkTypeIdstringThe ID of the issue link type.
options?RequestOptions-
Returns ​

Promise<void>

issueLinkTypes.getIssueLinkType ​

ts
getIssueLinkType: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  inward?: string;
  name?: string;
  outward?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueLinkTypeId: string; }-
parameters.issueLinkTypeIdstringThe ID of the issue link type.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>

issueLinkTypes.getIssueLinkTypes ​

ts
getIssueLinkTypes: (options?) => Promise<{
[key: string]: unknown;
  issueLinkTypes?: object[];
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; issueLinkTypes?: object[]; }>

issueLinkTypes.updateIssueLinkType ​

ts
updateIssueLinkType: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  inward?: string;
  name?: string;
  outward?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id?: string; inward?: string; issueLinkTypeId: string; name?: string; outward?: string; self?: string; }-
parameters.id?stringThe 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?stringThe 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?stringThe ID of the issue link type.
parameters.name?stringThe 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?stringThe 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?stringThe URL of the issue link type. Read only.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>

issueNavigatorSettings ​

ts
issueNavigatorSettings: object;

issueNavigatorSettings.getIssueNavigatorDefaultColumns ​

ts
getIssueNavigatorDefaultColumns: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

issueNavigatorSettings.setIssueNavigatorDefaultColumns ​

ts
setIssueNavigatorDefaultColumns: (parameters, options?) => Promise<void>;
Parameters ​
ParameterType
parameters{ columns?: string[]; }
parameters.columns?string[]
options?RequestOptions
Returns ​

Promise<void>

issueNotificationSchemes ​

ts
issueNotificationSchemes: object;

issueNotificationSchemes.addNotifications ​

ts
addNotifications: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; notificationSchemeEvents: object[]; }-
parameters.idstringThe ID of the notification scheme.
parameters.notificationSchemeEvents?object[]The list of notifications which should be added to the notification scheme.
options?RequestOptions-
Returns ​

Promise<void>

issueNotificationSchemes.getNotificationScheme ​

ts
getNotificationScheme: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[]; id: number; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole" | ( | "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?numberThe ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs.
options?RequestOptions-
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?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[]; id?: string[]; maxResults?: string; onlyDefault?: boolean; projectId?: string[]; startAt?: string; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole" | ( | "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?stringThe maximum number of items to return per page.
parameters.onlyDefault?booleanWhen 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?stringThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueNotificationSchemes.getNotificationSchemeToProjectMappings ​

ts
getNotificationSchemeToProjectMappings: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ maxResults?: string; notificationSchemeId?: string[]; projectId?: string[]; startAt?: string; }-
parameters.maxResults?stringThe 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?stringThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueNotificationSchemes.removeNotificationFromNotificationScheme ​

ts
removeNotificationFromNotificationScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ notificationId: string; notificationSchemeId: string; }-
parameters.notificationIdstringThe ID of the notification.
parameters.notificationSchemeId?stringThe ID of the notification scheme.
options?RequestOptions-
Returns ​

Promise<void>

issuePanels ​

ts
issuePanels: object;

issuePanels.bulkPinUnpinProjectsAsync ​

ts
bulkPinUnpinProjectsAsync: (parameters, options?) => Promise<{
[key: string]: unknown;
  taskId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ moduleId: string; projectList: object[]; }-
parameters.moduleIdstringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; taskId?: string; }>

issuePanels.getBulkPinStatus ​

ts
getBulkPinStatus: (parameters, options?) => Promise<{
[key: string]: unknown;
  moduleId?: string;
  statuses?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ moduleId: string; projectList: string[]; }-
parameters.moduleIdstringThe moduleId of the Forge panel in the format ari:cloud:ecosystem::extension/{app-id}/{environment-id}/static/{module-key}
parameters.projectList?string[]The IDs or keys of the projects to check the issue panel pin status for.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; moduleId?: string; statuses?: object[]; }>

issuePriorities ​

ts
issuePriorities: object;

issuePriorities.createPriority ​

ts
createPriority: (parameters, options?) => Promise<{
[key: string]: unknown;
  id: string;
}>;
Parameters ​
ParameterTypeDescription
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?numberThe 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 | nullThe 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" | nullThe 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?stringThe name of the priority. Must be unique.
parameters.statusColor?stringThe status color of the priority in 3-digit or 6-digit hexadecimal format.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id: string; }>

issuePriorities.deletePriority ​

ts
deletePriority: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the issue priority.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the issue priority.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ after?: string; ids: string[]; position?: string; }-
parameters.after?stringThe 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?stringThe position for issue priorities to be moved to. Required if after isn't provided.
options?RequestOptions-
Returns ​

Promise<void>

issuePriorities.searchPriorities ​

ts
searchPriorities: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: string; id?: string[]; maxResults?: string; onlyDefault?: boolean; priorityName?: string; projectId?: string[]; startAt?: string; }-
parameters.expand?stringUse 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?stringThe maximum number of items to return per page.
parameters.onlyDefault?booleanWhether only the default priority is returned.
parameters.priorityName?stringThe 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?stringThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issuePriorities.setDefaultPriority ​

ts
setDefaultPriority: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the new default issue priority. Must be an existing ID or null. Setting this to null erases the default priority setting.
options?RequestOptions-
Returns ​

Promise<void>

issuePriorities.updatePriority ​

ts
updatePriority: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
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?numberThe ID for the avatar for the priority. This parameter is nullable and both iconUrl and avatarId cannot be defined.
parameters.description?string | nullThe 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" | nullThe 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?stringThe ID of the issue priority.
parameters.name?string | nullThe name of the priority. Must be unique.
parameters.statusColor?string | nullThe status color of the priority in 3-digit or 6-digit hexadecimal format.
options?RequestOptions-
Returns ​

Promise<void>

issueProperties ​

ts
issueProperties: object;

issueProperties.bulkDeleteIssueProperty ​

ts
bulkDeleteIssueProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ currentValue?: unknown; entityIds?: number[]; propertyKey: string; }-
parameters.currentValue?unknownThe value of properties to perform the bulk operation on.
parameters.entityIds?number[]List of issues to perform the bulk delete operation on.
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-
Returns ​

Promise<void>

issueProperties.bulkSetIssuePropertiesByIssue ​

ts
bulkSetIssuePropertiesByIssue: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issues?: object[]; }-
parameters.issues?object[]A list of issue IDs and their respective properties.
options?RequestOptions-
Returns ​

Promise<void>

issueProperties.bulkSetIssueProperty ​

ts
bulkSetIssueProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ expression?: string; filter?: { currentValue?: unknown; entityIds?: number[]; hasProperty?: boolean; }; propertyKey: string; value?: unknown; }-
parameters.expression?stringEXPERIMENTAL. 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?{ currentValue?: unknown; entityIds?: number[]; hasProperty?: boolean; }-
parameters.filter.currentValue?unknownThe 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?booleanWhether the bulk operation occurs only when the property is present on or absent from an issue.
parameters.propertyKey?stringThe key of the property. The maximum length is 255 characters.
parameters.value?unknownThe value of the property. The value must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
options?RequestOptions-
Returns ​

Promise<void>

issueProperties.bulkSetIssuesPropertiesList ​

ts
bulkSetIssuesPropertiesList: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ entitiesIds?: number[]; properties?: Record<string, unknown>; }-
parameters.entitiesIds?number[]A list of entity property IDs.
parameters.properties?Record<string, unknown>A list of entity property keys and values.
options?RequestOptions-
Returns ​

Promise<void>

issueProperties.deleteIssueProperty ​

ts
deleteIssueProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; propertyKey: string; }-
parameters.issueIdOrKeystringThe key or ID of the issue.
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-
Returns ​

Promise<void>

issueProperties.getIssueProperty ​

ts
getIssueProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; propertyKey: string; }-
parameters.issueIdOrKeystringThe key or ID of the issue.
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

issueProperties.getIssuePropertyKeys ​

ts
getIssuePropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; }-
parameters.issueIdOrKeystringThe key or ID of the issue.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>

issueProperties.setIssueProperty ​

ts
setIssueProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ body: Record<string, any>; issueIdOrKey: string; propertyKey: string; }-
parameters.bodyRecord<string, any>-
parameters.issueIdOrKey?stringThe ID or key of the issue.
parameters.propertyKey?stringThe key of the issue property. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<void>

issueRedaction ​

ts
issueRedaction: object;

issueRedaction.getRedactionStatus ​

ts
getRedactionStatus: (parameters, options?) => Promise<{
[key: string]: unknown;
  bulkRedactionResponse?: {
   [key: string]: unknown;
     results: object[];
  };
  jobStatus?: string & object | "IN_PROGRESS" | "PENDING" | "COMPLETED";
}>;
Parameters ​
ParameterTypeDescription
parameters{ jobId: string; }-
parameters.jobIdstringRedaction job id
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; bulkRedactionResponse?: { [key: string]: unknown; results: object[]; }; jobStatus?: string & object | "IN_PROGRESS" | "PENDING" | "COMPLETED"; }>

issueRedaction.redact ​

ts
redact: (parameters, options?) => Promise<string>;
Parameters ​
ParameterType
parameters{ redactions?: object[]; }
parameters.redactions?object[]
options?RequestOptions
Returns ​

Promise<string>

ts
issueRemoteLinks: object;
ts
createOrUpdateRemoteIssueLink: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: number;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ application?: { name?: string; type?: string; }; globalId?: string; issueIdOrKey: string; object: { icon?: { link?: string; title?: string; url16x16?: string; }; status?: { icon?: { link?: string; title?: string; url16x16?: string; }; resolved?: boolean; }; summary?: string; title: string; url: string; }; relationship?: string; }-
parameters.application?{ name?: string; type?: string; }-
parameters.application.name?stringThe 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?stringThe name-spaced type of the application, used by registered rendering apps.
parameters.globalId?stringAn 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?stringThe ID or key of the issue.
parameters.object?{ icon?: { link?: string; title?: string; url16x16?: string; }; status?: { icon?: { link?: string; title?: string; url16x16?: string; }; resolved?: boolean; }; summary?: string; title: string; url: string; }-
parameters.object.icon?{ link?: string; title?: string; url16x16?: string; }-
parameters.object.icon.link?stringThe 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?stringThe 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?stringThe URL of an icon that displays at 16x16 pixel in Jira.
parameters.object.status?{ icon?: { link?: string; title?: string; url16x16?: string; }; resolved?: boolean; }-
parameters.object.status.icon?{ link?: string; title?: string; url16x16?: string; }-
parameters.object.status.icon.link?stringThe 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?stringThe 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?stringThe URL of an icon that displays at 16x16 pixel in Jira.
parameters.object.status.resolved?booleanWhether 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?stringThe summary details of the item.
parameters.object.title?stringThe title of the item.
parameters.object.url?stringThe URL of the item.
parameters.relationship?stringDescription of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id?: number; self?: string; }>

ts
deleteRemoteIssueLinkByGlobalId: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ globalId: string; issueIdOrKey: string; }-
parameters.globalIdstringThe global ID of a remote issue link.
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<void>

ts
deleteRemoteIssueLinkById: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; linkId: string; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
parameters.linkId?stringThe ID of a remote issue link.
options?RequestOptions-
Returns ​

Promise<void>

ts
getRemoteIssueLinkById: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; linkId: string; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
parameters.linkId?stringThe ID of the remote issue link.
options?RequestOptions-
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; }>

ts
getRemoteIssueLinks: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ globalId?: string; issueIdOrKey: string; }-
parameters.globalId?stringThe global ID of the remote issue link.
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-
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[]>

ts
updateRemoteIssueLink: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ application?: { name?: string; type?: string; }; globalId?: string; issueIdOrKey: string; linkId: string; object: { icon?: { link?: string; title?: string; url16x16?: string; }; status?: { icon?: { link?: string; title?: string; url16x16?: string; }; resolved?: boolean; }; summary?: string; title: string; url: string; }; relationship?: string; }-
parameters.application?{ name?: string; type?: string; }-
parameters.application.name?stringThe 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?stringThe name-spaced type of the application, used by registered rendering apps.
parameters.globalId?stringAn 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?stringThe ID or key of the issue.
parameters.linkId?stringThe ID of the remote issue link.
parameters.object?{ icon?: { link?: string; title?: string; url16x16?: string; }; status?: { icon?: { link?: string; title?: string; url16x16?: string; }; resolved?: boolean; }; summary?: string; title: string; url: string; }-
parameters.object.icon?{ link?: string; title?: string; url16x16?: string; }-
parameters.object.icon.link?stringThe 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?stringThe 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?stringThe URL of an icon that displays at 16x16 pixel in Jira.
parameters.object.status?{ icon?: { link?: string; title?: string; url16x16?: string; }; resolved?: boolean; }-
parameters.object.status.icon?{ link?: string; title?: string; url16x16?: string; }-
parameters.object.status.icon.link?stringThe 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?stringThe 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?stringThe URL of an icon that displays at 16x16 pixel in Jira.
parameters.object.status.resolved?booleanWhether 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?stringThe summary details of the item.
parameters.object.title?stringThe title of the item.
parameters.object.url?stringThe URL of the item.
parameters.relationship?stringDescription of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.
options?RequestOptions-
Returns ​

Promise<void>

issueResolutions ​

ts
issueResolutions: object;

issueResolutions.getResolution ​

ts
getResolution: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the issue resolution value.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>

issues ​

ts
issues: object;

issues.assignIssue ​

ts
assignIssue: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string | null; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; issueIdOrKey: string; locale?: string | null; self?: string; timeZone?: string; }-
parameters.accountId?string | nullThe 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?booleanWhether the user is active.
parameters.applicationRoles?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }The application roles the user is assigned to.
parameters.applicationRoles.callback?Record<string, never>-
parameters.applicationRoles.items?object[]-
parameters.applicationRoles.max-results?number-
parameters.applicationRoles.pagingCallback?Record<string, never>-
parameters.applicationRoles.size?number-
parameters.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }The avatars of the user.
parameters.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.expand?stringExpand options that include additional user details in the response.
parameters.groups?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }The groups that the user belongs to.
parameters.groups.callback?Record<string, never>-
parameters.groups.items?object[]-
parameters.groups.max-results?number-
parameters.groups.pagingCallback?Record<string, never>-
parameters.groups.size?number-
parameters.guest?booleanWhether the user is a guest.
parameters.issueIdOrKey?stringThe ID or key of the issue to be assigned.
parameters.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.self?stringThe URL of the user.
parameters.timeZone?stringThe 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.
options?RequestOptions-
Returns ​

Promise<void>

issues.bulkFetchIssues ​

ts
bulkFetchIssues: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueErrors?: object[];
  issues?: Issue[];
}>;
Parameters ​
ParameterTypeDescription
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. To request up to 1000 issues in a single call, do not include changelog, editmeta, operations, renderedFields, transitions, or versionedRepresentations in expand. Requests that include any of these can include at most 100 issues; larger requests are rejected with a 400 error.
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. To request up to 1000 issues in a single call, explicitly list the fields you need: at least one field must be a positive include (a request containing only exclusions is not eligible), the *all and *navigable wildcards and the default navigable field set are not eligible for the higher limit, no more than 100 fields may be listed, and none of the included fields returns multiple values (for example comment, worklog, or attachment). Requests that do not meet these conditions can include at most 100 issues; larger requests are rejected with a 400 error.
parameters.fieldsByKeys?booleanReference 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. You can request up to 100 issues per call. Requests can include up to 1000 issues per call when they meet all of the conditions described for the fields and expand parameters. Requests that exceed the applicable limit are rejected with a 400 error.
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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issueErrors?: object[]; issues?: Issue[]; }>

issues.createIssue ​

ts
createIssue: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ fields?: IssueFieldsInput; historyMetadata?: { activityDescription?: string; activityDescriptionKey?: string; actor?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, string>; generator?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }; properties?: object[]; transition?: { expand?: string; fields?: Record<string, { allowedValues?: ...[]; autoCompleteUrl?: string; configuration?: Record<..., ...>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { configuration?: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type: ...; }; }>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; }; update?: Record<string, object[]>; updateHistory?: boolean; }-
parameters.fields?IssueFieldsInputList 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?{ activityDescription?: string; activityDescriptionKey?: string; actor?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, string>; generator?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }-
parameters.historyMetadata.activityDescription?stringThe activity described in the history record.
parameters.historyMetadata.activityDescriptionKey?stringThe key of the activity described in the history record.
parameters.historyMetadata.actor?{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }-
parameters.historyMetadata.actor.avatarUrl?stringThe URL to an avatar for the user or system associated with a history record.
parameters.historyMetadata.actor.displayName?stringThe display name of the user or system associated with a history record.
parameters.historyMetadata.actor.displayNameKey?stringThe key of the display name of the user or system associated with a history record.
parameters.historyMetadata.actor.id?stringThe ID of the user or system associated with a history record.
parameters.historyMetadata.actor.type?stringThe type of the user or system associated with a history record.
parameters.historyMetadata.actor.url?stringThe URL of the user or system associated with a history record.
parameters.historyMetadata.cause?{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }-
parameters.historyMetadata.cause.avatarUrl?stringThe URL to an avatar for the user or system associated with a history record.
parameters.historyMetadata.cause.displayName?stringThe display name of the user or system associated with a history record.
parameters.historyMetadata.cause.displayNameKey?stringThe key of the display name of the user or system associated with a history record.
parameters.historyMetadata.cause.id?stringThe ID of the user or system associated with a history record.
parameters.historyMetadata.cause.type?stringThe type of the user or system associated with a history record.
parameters.historyMetadata.cause.url?stringThe URL of the user or system associated with a history record.
parameters.historyMetadata.description?stringThe description of the history record.
parameters.historyMetadata.descriptionKey?stringThe description key of the history record.
parameters.historyMetadata.emailDescription?stringThe description of the email address associated the history record.
parameters.historyMetadata.emailDescriptionKey?stringThe description key of the email address associated the history record.
parameters.historyMetadata.extraData?Record<string, string>Additional arbitrary information about the history record.
parameters.historyMetadata.generator?{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }-
parameters.historyMetadata.generator.avatarUrl?stringThe URL to an avatar for the user or system associated with a history record.
parameters.historyMetadata.generator.displayName?stringThe display name of the user or system associated with a history record.
parameters.historyMetadata.generator.displayNameKey?stringThe key of the display name of the user or system associated with a history record.
parameters.historyMetadata.generator.id?stringThe ID of the user or system associated with a history record.
parameters.historyMetadata.generator.type?stringThe type of the user or system associated with a history record.
parameters.historyMetadata.generator.url?stringThe URL of the user or system associated with a history record.
parameters.historyMetadata.type?stringThe type of the history record.
parameters.properties?object[]Details of issue properties to be add or update.
parameters.transition?{ expand?: string; fields?: Record<string, { allowedValues?: ...[]; autoCompleteUrl?: string; configuration?: Record<..., ...>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { configuration?: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type: ...; }; }>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; }-
parameters.transition.expand?stringExpand options that include additional transition details in the response.
parameters.transition.fields?Record<string, { allowedValues?: ...[]; autoCompleteUrl?: string; configuration?: Record<..., ...>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { configuration?: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type: ...; }; }>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?booleanWhether there is a screen associated with the issue transition.
parameters.transition.id?stringThe ID of the issue transition. Required when specifying a transition to undertake.
parameters.transition.isAvailable?booleanWhether the transition is available to be performed.
parameters.transition.isConditional?booleanWhether the issue has to meet criteria before the issue transition is applied.
parameters.transition.isGlobal?booleanWhether the issue transition is global, that is, the transition is applied to issues regardless of their status.
parameters.transition.isInitial?booleanWhether this is the initial issue transition for the workflow.
parameters.transition.looped?boolean-
parameters.transition.name?stringThe name of the issue transition.
parameters.transition.to?{ description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }-
parameters.transition.to.description?stringThe description of the status.
parameters.transition.to.iconUrl?stringThe URL of the icon used to represent the status.
parameters.transition.to.id?stringThe ID of the status.
parameters.transition.to.name?stringThe name of the status.
parameters.transition.to.scope?{ project?: ... | ...; type?: ... | ... | ... | ...; }-
parameters.transition.to.scope.project?... | ...-
parameters.transition.to.scope.type?... | ... | ... | ...The type of scope.
parameters.transition.to.self?stringThe URL of the status.
parameters.transition.to.statusCategory?{ 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, object[]>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?booleanWhether 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.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  errors?: object[];
  issues?: object[];
}>;
Parameters ​
ParameterType
parameters{ issueUpdates?: object[]; }
parameters.issueUpdates?object[]
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; errors?: object[]; issues?: object[]; }>

issues.deleteIssue ​

ts
deleteIssue: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ deleteSubtasks?: "false" | "true" | string & object; issueIdOrKey: string; }-
parameters.deleteSubtasks?"false" | "true" | string & objectWhether the issue's subtasks are deleted when the issue is deleted.
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<void>

issues.doTransition ​

ts
doTransition: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ fields?: IssueFieldsInput; historyMetadata?: { activityDescription?: string; activityDescriptionKey?: string; actor?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, string>; generator?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }; issueIdOrKey: string; properties?: object[]; transition?: { expand?: string; fields?: Record<string, { allowedValues?: ...[]; autoCompleteUrl?: string; configuration?: Record<..., ...>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { configuration?: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type: ...; }; }>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; }; update?: Record<string, object[]>; }-
parameters.fields?IssueFieldsInputList 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?{ activityDescription?: string; activityDescriptionKey?: string; actor?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, string>; generator?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }-
parameters.historyMetadata.activityDescription?stringThe activity described in the history record.
parameters.historyMetadata.activityDescriptionKey?stringThe key of the activity described in the history record.
parameters.historyMetadata.actor?{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }-
parameters.historyMetadata.actor.avatarUrl?stringThe URL to an avatar for the user or system associated with a history record.
parameters.historyMetadata.actor.displayName?stringThe display name of the user or system associated with a history record.
parameters.historyMetadata.actor.displayNameKey?stringThe key of the display name of the user or system associated with a history record.
parameters.historyMetadata.actor.id?stringThe ID of the user or system associated with a history record.
parameters.historyMetadata.actor.type?stringThe type of the user or system associated with a history record.
parameters.historyMetadata.actor.url?stringThe URL of the user or system associated with a history record.
parameters.historyMetadata.cause?{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }-
parameters.historyMetadata.cause.avatarUrl?stringThe URL to an avatar for the user or system associated with a history record.
parameters.historyMetadata.cause.displayName?stringThe display name of the user or system associated with a history record.
parameters.historyMetadata.cause.displayNameKey?stringThe key of the display name of the user or system associated with a history record.
parameters.historyMetadata.cause.id?stringThe ID of the user or system associated with a history record.
parameters.historyMetadata.cause.type?stringThe type of the user or system associated with a history record.
parameters.historyMetadata.cause.url?stringThe URL of the user or system associated with a history record.
parameters.historyMetadata.description?stringThe description of the history record.
parameters.historyMetadata.descriptionKey?stringThe description key of the history record.
parameters.historyMetadata.emailDescription?stringThe description of the email address associated the history record.
parameters.historyMetadata.emailDescriptionKey?stringThe description key of the email address associated the history record.
parameters.historyMetadata.extraData?Record<string, string>Additional arbitrary information about the history record.
parameters.historyMetadata.generator?{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }-
parameters.historyMetadata.generator.avatarUrl?stringThe URL to an avatar for the user or system associated with a history record.
parameters.historyMetadata.generator.displayName?stringThe display name of the user or system associated with a history record.
parameters.historyMetadata.generator.displayNameKey?stringThe key of the display name of the user or system associated with a history record.
parameters.historyMetadata.generator.id?stringThe ID of the user or system associated with a history record.
parameters.historyMetadata.generator.type?stringThe type of the user or system associated with a history record.
parameters.historyMetadata.generator.url?stringThe URL of the user or system associated with a history record.
parameters.historyMetadata.type?stringThe type of the history record.
parameters.issueIdOrKey?stringThe ID or key of the issue.
parameters.properties?object[]Details of issue properties to be add or update.
parameters.transition?{ expand?: string; fields?: Record<string, { allowedValues?: ...[]; autoCompleteUrl?: string; configuration?: Record<..., ...>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { configuration?: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type: ...; }; }>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; }-
parameters.transition.expand?stringExpand options that include additional transition details in the response.
parameters.transition.fields?Record<string, { allowedValues?: ...[]; autoCompleteUrl?: string; configuration?: Record<..., ...>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { configuration?: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type: ...; }; }>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?booleanWhether there is a screen associated with the issue transition.
parameters.transition.id?stringThe ID of the issue transition. Required when specifying a transition to undertake.
parameters.transition.isAvailable?booleanWhether the transition is available to be performed.
parameters.transition.isConditional?booleanWhether the issue has to meet criteria before the issue transition is applied.
parameters.transition.isGlobal?booleanWhether the issue transition is global, that is, the transition is applied to issues regardless of their status.
parameters.transition.isInitial?booleanWhether this is the initial issue transition for the workflow.
parameters.transition.looped?boolean-
parameters.transition.name?stringThe name of the issue transition.
parameters.transition.to?{ description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }-
parameters.transition.to.description?stringThe description of the status.
parameters.transition.to.iconUrl?stringThe URL of the icon used to represent the status.
parameters.transition.to.id?stringThe ID of the status.
parameters.transition.to.name?stringThe name of the status.
parameters.transition.to.scope?{ project?: ... | ...; type?: ... | ... | ... | ...; }-
parameters.transition.to.scope.project?... | ...-
parameters.transition.to.scope.type?... | ... | ... | ...The type of scope.
parameters.transition.to.self?stringThe URL of the status.
parameters.transition.to.statusCategory?{ 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, object[]>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.
options?RequestOptions-
Returns ​

Promise<void>

issues.editIssue ​

ts
editIssue: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: string; fields?: IssueFieldsInput; historyMetadata?: { activityDescription?: string; activityDescriptionKey?: string; actor?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, string>; generator?: { 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?: { expand?: string; fields?: Record<string, { allowedValues?: ...[]; autoCompleteUrl?: string; configuration?: Record<..., ...>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { configuration?: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type: ...; }; }>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; }; update?: Record<string, object[]>; }-
parameters.expand?stringThe Get issue API expand parameter to use in the response if the returnIssue parameter is true.
parameters.fields?IssueFieldsInputList 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?{ activityDescription?: string; activityDescriptionKey?: string; actor?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, string>; generator?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }-
parameters.historyMetadata.activityDescription?stringThe activity described in the history record.
parameters.historyMetadata.activityDescriptionKey?stringThe key of the activity described in the history record.
parameters.historyMetadata.actor?{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }-
parameters.historyMetadata.actor.avatarUrl?stringThe URL to an avatar for the user or system associated with a history record.
parameters.historyMetadata.actor.displayName?stringThe display name of the user or system associated with a history record.
parameters.historyMetadata.actor.displayNameKey?stringThe key of the display name of the user or system associated with a history record.
parameters.historyMetadata.actor.id?stringThe ID of the user or system associated with a history record.
parameters.historyMetadata.actor.type?stringThe type of the user or system associated with a history record.
parameters.historyMetadata.actor.url?stringThe URL of the user or system associated with a history record.
parameters.historyMetadata.cause?{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }-
parameters.historyMetadata.cause.avatarUrl?stringThe URL to an avatar for the user or system associated with a history record.
parameters.historyMetadata.cause.displayName?stringThe display name of the user or system associated with a history record.
parameters.historyMetadata.cause.displayNameKey?stringThe key of the display name of the user or system associated with a history record.
parameters.historyMetadata.cause.id?stringThe ID of the user or system associated with a history record.
parameters.historyMetadata.cause.type?stringThe type of the user or system associated with a history record.
parameters.historyMetadata.cause.url?stringThe URL of the user or system associated with a history record.
parameters.historyMetadata.description?stringThe description of the history record.
parameters.historyMetadata.descriptionKey?stringThe description key of the history record.
parameters.historyMetadata.emailDescription?stringThe description of the email address associated the history record.
parameters.historyMetadata.emailDescriptionKey?stringThe description key of the email address associated the history record.
parameters.historyMetadata.extraData?Record<string, string>Additional arbitrary information about the history record.
parameters.historyMetadata.generator?{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }-
parameters.historyMetadata.generator.avatarUrl?stringThe URL to an avatar for the user or system associated with a history record.
parameters.historyMetadata.generator.displayName?stringThe display name of the user or system associated with a history record.
parameters.historyMetadata.generator.displayNameKey?stringThe key of the display name of the user or system associated with a history record.
parameters.historyMetadata.generator.id?stringThe ID of the user or system associated with a history record.
parameters.historyMetadata.generator.type?stringThe type of the user or system associated with a history record.
parameters.historyMetadata.generator.url?stringThe URL of the user or system associated with a history record.
parameters.historyMetadata.type?stringThe type of the history record.
parameters.issueIdOrKey?stringThe ID or key of the issue.
parameters.notifyUsers?booleanWhether 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?booleanWhether 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?booleanWhether 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?booleanWhether 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?{ expand?: string; fields?: Record<string, { allowedValues?: ...[]; autoCompleteUrl?: string; configuration?: Record<..., ...>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { configuration?: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type: ...; }; }>; hasScreen?: boolean; id?: string; isAvailable?: boolean; isConditional?: boolean; isGlobal?: boolean; isInitial?: boolean; looped?: boolean; name?: string; to?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }; }-
parameters.transition.expand?stringExpand options that include additional transition details in the response.
parameters.transition.fields?Record<string, { allowedValues?: ...[]; autoCompleteUrl?: string; configuration?: Record<..., ...>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { configuration?: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type: ...; }; }>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?booleanWhether there is a screen associated with the issue transition.
parameters.transition.id?stringThe ID of the issue transition. Required when specifying a transition to undertake.
parameters.transition.isAvailable?booleanWhether the transition is available to be performed.
parameters.transition.isConditional?booleanWhether the issue has to meet criteria before the issue transition is applied.
parameters.transition.isGlobal?booleanWhether the issue transition is global, that is, the transition is applied to issues regardless of their status.
parameters.transition.isInitial?booleanWhether this is the initial issue transition for the workflow.
parameters.transition.looped?boolean-
parameters.transition.name?stringThe name of the issue transition.
parameters.transition.to?{ description?: string; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; statusCategory?: { colorName?: ... | ...; id?: ... | ...; key?: ... | ...; name?: ... | ...; self?: ... | ...; }; untranslatedName?: string; }-
parameters.transition.to.description?stringThe description of the status.
parameters.transition.to.iconUrl?stringThe URL of the icon used to represent the status.
parameters.transition.to.id?stringThe ID of the status.
parameters.transition.to.name?stringThe name of the status.
parameters.transition.to.scope?{ project?: ... | ...; type?: ... | ... | ... | ...; }-
parameters.transition.to.scope.project?... | ...-
parameters.transition.to.scope.type?... | ... | ... | ...The type of scope.
parameters.transition.to.self?stringThe URL of the status.
parameters.transition.to.statusCategory?{ 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, object[]>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.
options?RequestOptions-
Returns ​

Promise<void>

issues.getBulkChangelogs ​

ts
getBulkChangelogs: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueChangeLogs?: object[];
  nextPageToken?: string | null;
}>;
Parameters ​
ParameterTypeDescription
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?numberThe maximum number of items to return per page
parameters.nextPageToken?stringThe cursor for pagination
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issueChangeLogs?: object[]; nextPageToken?: string | null; }>

issues.getChangeLogs ​

ts
getChangeLogs: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; maxResults?: number; startAt?: number; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issues.getChangeLogsByIds ​

ts
getChangeLogsByIds: (parameters, options?) => Promise<{
[key: string]: unknown;
  histories?: object[];
  maxResults?: number;
  startAt?: number;
  total?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ changelogIds: number[]; issueIdOrKey: string; }-
parameters.changelogIdsnumber[]The list of changelog IDs.
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; histories?: object[]; maxResults?: number; startAt?: number; total?: number; }>

issues.getCreateIssueMetaIssueTypeId ​

ts
getCreateIssueMetaIssueTypeId: (parameters, options?) => Promise<{
[key: string]: unknown;
  fields?: object[];
  maxResults?: number;
  results?: object[];
  startAt?: number;
  total?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeId: string; maxResults?: number; projectIdOrKey: string; startAt?: number; }-
parameters.issueTypeIdstringThe issuetype ID.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.projectIdOrKey?stringThe ID or key of the project.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; fields?: object[]; maxResults?: number; results?: object[]; startAt?: number; total?: number; }>

issues.getCreateIssueMetaIssueTypes ​

ts
getCreateIssueMetaIssueTypes: (parameters, options?) => Promise<{
[key: string]: unknown;
  createMetaIssueType?: object[];
  issueTypes?: object[];
  maxResults?: number;
  startAt?: number;
  total?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; projectIdOrKey: string; startAt?: number; }-
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.projectIdOrKey?stringThe ID or key of the project.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; createMetaIssueType?: object[]; issueTypes?: object[]; maxResults?: number; startAt?: number; total?: number; }>

issues.getEditIssueMeta ​

ts
getEditIssueMeta: (parameters, options?) => Promise<{
[key: string]: unknown;
  fields?: Record<string, {
   [key: string]: unknown;
     allowedValues?: unknown[];
     autoCompleteUrl?: string;
     configuration?: Record<string, any>;
     defaultValue?: unknown;
     hasDefaultValue?: boolean;
     key: string;
     name: string;
     operations: string[];
     required: boolean;
     schema?: {
      [key: string]: unknown;
        configuration?: ... | ...;
        custom?: ... | ...;
        customId?: ... | ...;
        items?: ... | ...;
        system?: ... | ...;
        type: string;
     };
  }>;
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; overrideEditableFlag?: boolean; overrideScreenSecurity?: boolean; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
parameters.overrideEditableFlag?booleanWhether 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?booleanWhether 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; fields?: Record<string, { [key: string]: unknown; allowedValues?: unknown[]; autoCompleteUrl?: string; configuration?: Record<string, any>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { [key: string]: unknown; configuration?: ... | ...; custom?: ... | ...; customId?: ... | ...; items?: ... | ...; system?: ... | ...; type: string; }; }>; }>

issues.getIssue ​

ts
getIssue: (parameters, options?) => Promise<Issue>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | "schema" | string & object | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations" | ( | "schema" | string & object | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations")[]; failFast?: boolean; fields?: string[]; fieldsByKeys?: boolean; issueIdOrKey: string; properties?: string[]; updateHistory?: boolean; }-
parameters.expand?| "schema" | string & object | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations" | ( | "schema" | string & object | "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?booleanWhether 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?booleanWhether 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?stringThe 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?booleanWhether 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.
options?RequestOptions-
Returns ​

Promise<Issue>

issues.getTransitions ​

ts
getTransitions: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  transitions?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | string & object | "transitions.fields" | (string & object | "transitions.fields")[]; includeUnavailableTransitions?: boolean; issueIdOrKey: string; skipRemoteOnlyCondition?: boolean; sortByOpsBarAndStatus?: boolean; transitionId?: string; }-
parameters.expand?| string & object | "transitions.fields" | (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?booleanWhether details of transitions that fail a condition are included in the response
parameters.issueIdOrKey?stringThe ID or key of the issue.
parameters.skipRemoteOnlyCondition?booleanWhether 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?booleanWhether 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?stringThe ID of the transition.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; expand?: string; transitions?: object[]; }>

issues.notify ​

ts
notify: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ htmlBody?: string; issueIdOrKey: string; restrict?: { groupIds?: string[]; groups?: object[]; permissions?: object[]; }; subject?: string; textBody?: string; to?: { assignee?: boolean; groupIds?: string[]; groups?: object[]; reporter?: boolean; users?: object[]; voters?: boolean; watchers?: boolean; }; }-
parameters.htmlBody?stringThe HTML body of the email notification for the issue.
parameters.issueIdOrKey?stringID or key of the issue that the notification is sent for.
parameters.restrict?{ 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?stringThe 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?stringThe plain text body of the email notification for the issue.
parameters.to?{ assignee?: boolean; groupIds?: string[]; groups?: object[]; reporter?: boolean; users?: object[]; voters?: boolean; watchers?: boolean; }-
parameters.to.assignee?booleanWhether 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?booleanWhether the notification should be sent to the issue's reporter.
parameters.to.users?object[]List of users to receive the notification.
parameters.to.voters?booleanWhether the notification should be sent to the issue's voters.
parameters.to.watchers?booleanWhether the notification should be sent to the issue's watchers.
options?RequestOptions-
Returns ​

Promise<void>

issueSearch ​

ts
issueSearch: object;

issueSearch.countIssues ​

ts
countIssues: (parameters, options?) => Promise<{
[key: string]: unknown;
  count?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ jql?: string; }-
parameters.jql?stringA JQL expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; count?: number; }>

issueSearch.getIssuePickerResource ​

ts
getIssuePickerResource: (parameters?, options?) => Promise<{
[key: string]: unknown;
  sections?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ currentIssueKey?: string; currentJQL?: string; currentProjectId?: string; query?: string; showSubTaskParent?: boolean; showSubTasks?: boolean; }-
parameters.currentIssueKey?stringThe key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
parameters.currentJQL?stringA 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?stringThe ID of a project that suggested issues must belong to.
parameters.query?stringA string to match against text fields in the issue such as title, description, or comments.
parameters.showSubTaskParent?booleanWhen currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.
parameters.showSubTasks?booleanIndicate whether to include subtasks in the suggestions list.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; sections?: object[]; }>

issueSearch.matchIssues ​

ts
matchIssues: (parameters, options?) => Promise<{
[key: string]: unknown;
  matches: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIds: number[]; jqls: string[]; }-
parameters.issueIdsnumber[]A list of up to 50 issue IDs.
parameters.jqls?string[]A list of up to 10 JQL queries.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; matches: object[]; }>

issueSearch.searchAndReconsileIssuesUsingJql ​

ts
searchAndReconsileIssuesUsingJql: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  issues?: Issue[];
  names?: Record<string, string>;
  nextPageToken?: string | null;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warnings?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | "schema" | string & object | "operations" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations" | ( | "schema" | string & object | "operations" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations")[]; failFast?: boolean; fields?: string[]; fieldsByKeys?: boolean; includeArchivedProjects?: boolean; jql?: string; maxResults?: number; nextPageToken?: string; properties?: string[]; reconcileIssues?: number[]; }-
parameters.expand?| "schema" | string & object | "operations" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations" | ( | "schema" | string & object | "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?booleanFail 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?booleanReference fields by their key (rather than ID). The default is false.
parameters.includeArchivedProjects?booleanWhether to also return issues that belong to archived projects. Issues in archived projects are excluded by default. Setting this to true returns them alongside issues from active projects; the Browse projects permission is still required on the archived project. The default is false.
parameters.jql?stringA 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?numberThe 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?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast?: boolean; issues?: Issue[]; names?: Record<string, string>; nextPageToken?: string | null; schema?: Record<string, { [key: string]: unknown; configuration?: Record<string, any>; custom?: string; customId?: number; items?: string; system?: string; type: string; }>; warnings?: object[]; }>

Deprecated ​

Renamed to searchIssues, which calls the same endpoint. This alias is removed in the next major version.

issueSearch.searchAndReconsileIssuesUsingJqlPost ​

ts
searchAndReconsileIssuesUsingJqlPost: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  issues?: Issue[];
  names?: Record<string, string>;
  nextPageToken?: string | null;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warnings?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: string; fields?: string[]; fieldsByKeys?: boolean; includeArchivedProjects?: boolean; jql?: string; maxResults?: number; nextPageToken?: string; properties?: string[]; reconcileIssues?: number[]; }-
parameters.expand?stringUse 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?booleanReference fields by their key (rather than ID). The default is false.
parameters.includeArchivedProjects?booleanWhether to also return issues that belong to archived projects. Archived projects are excluded by default. Requires Browse projects permission on the archived project. The default is false.
parameters.jql?stringA 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?numberThe 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?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast?: boolean; issues?: Issue[]; names?: Record<string, string>; nextPageToken?: string | null; schema?: Record<string, { [key: string]: unknown; configuration?: Record<string, any>; custom?: string; customId?: number; items?: string; system?: string; type: string; }>; warnings?: object[]; }>

Deprecated ​

Renamed to searchIssuesPost, which calls the same endpoint. This alias is removed in the next major version.

issueSearch.searchIssues ​

ts
searchIssues: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  issues?: Issue[];
  names?: Record<string, string>;
  nextPageToken?: string | null;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warnings?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | "schema" | string & object | "operations" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations" | ( | "schema" | string & object | "operations" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations")[]; failFast?: boolean; fields?: string[]; fieldsByKeys?: boolean; includeArchivedProjects?: boolean; jql?: string; maxResults?: number; nextPageToken?: string; properties?: string[]; reconcileIssues?: number[]; }-
parameters.expand?| "schema" | string & object | "operations" | "changelog" | "editmeta" | "names" | "renderedFields" | "transitions" | "versionedRepresentations" | ( | "schema" | string & object | "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?booleanFail 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?booleanReference fields by their key (rather than ID). The default is false.
parameters.includeArchivedProjects?booleanWhether to also return issues that belong to archived projects. Issues in archived projects are excluded by default. Setting this to true returns them alongside issues from active projects; the Browse projects permission is still required on the archived project. The default is false.
parameters.jql?stringA 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?numberThe 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?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast?: boolean; issues?: Issue[]; names?: Record<string, string>; nextPageToken?: string | null; schema?: Record<string, { [key: string]: unknown; configuration?: Record<string, any>; custom?: string; customId?: number; items?: string; system?: string; type: string; }>; warnings?: object[]; }>

issueSearch.searchIssuesPost ​

ts
searchIssuesPost: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  issues?: Issue[];
  names?: Record<string, string>;
  nextPageToken?: string | null;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warnings?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: string; fields?: string[]; fieldsByKeys?: boolean; includeArchivedProjects?: boolean; jql?: string; maxResults?: number; nextPageToken?: string; properties?: string[]; reconcileIssues?: number[]; }-
parameters.expand?stringUse 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?booleanReference fields by their key (rather than ID). The default is false.
parameters.includeArchivedProjects?booleanWhether to also return issues that belong to archived projects. Archived projects are excluded by default. Requires Browse projects permission on the archived project. The default is false.
parameters.jql?stringA 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?numberThe 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?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast?: boolean; issues?: Issue[]; names?: Record<string, string>; nextPageToken?: string | null; schema?: Record<string, { [key: string]: unknown; configuration?: Record<string, any>; custom?: string; customId?: number; items?: string; system?: string; type: string; }>; warnings?: object[]; }>

issueSecurityLevel ​

ts
issueSecurityLevel: object;

issueSecurityLevel.getIssueSecurityLevel ​

ts
getIssueSecurityLevel: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  isDefault?: boolean;
  issueSecuritySchemeId?: string;
  name?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the issue security level.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; description?: string; id?: string; isDefault?: boolean; issueSecuritySchemeId?: string; name?: string; self?: string; }>

issueSecurityLevel.getIssueSecurityLevelMembers ​

ts
getIssueSecurityLevelMembers: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "projectRole" | ("all" | "user" | "group" | "field" | string & object | "projectRole")[]; issueSecurityLevelId?: string[]; issueSecuritySchemeId: number; maxResults?: number; startAt?: number; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "projectRole" | ("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?numberThe ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  defaultSecurityLevelId?: number;
  description?: string;
  id?: number;
  levels?: object[];
  name?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultSecurityLevelId?: number; description?: string; id?: number; levels?: object[]; name?: string; self?: string; }>

issueSecuritySchemes.getIssueSecuritySchemes ​

ts
getIssueSecuritySchemes: (options?) => Promise<{
[key: string]: unknown;
  issueSecuritySchemes?: object[];
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; issueSecuritySchemes?: object[]; }>

issueTypeProperties ​

ts
issueTypeProperties: object;

issueTypeProperties.deleteIssueTypeProperty ​

ts
deleteIssueTypeProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeId: string; propertyKey: string; }-
parameters.issueTypeIdstringThe ID of the issue type.
parameters.propertyKey?stringThe key of the property. Use Get issue type property keys to get a list of all issue type property keys.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeProperties.getIssueTypeProperty ​

ts
getIssueTypeProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeId: string; propertyKey: string; }-
parameters.issueTypeIdstringThe ID of the issue type.
parameters.propertyKey?stringThe key of the property. Use Get issue type property keys to get a list of all issue type property keys.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

issueTypeProperties.getIssueTypePropertyKeys ​

ts
getIssueTypePropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeId: string; }-
parameters.issueTypeIdstringThe ID of the issue type.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>

issueTypeProperties.setIssueTypeProperty ​

ts
setIssueTypeProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ body: Record<string, any>; issueTypeId: string; propertyKey: string; }-
parameters.bodyRecord<string, any>-
parameters.issueTypeId?stringThe ID of the issue type.
parameters.propertyKey?stringThe key of the issue type property. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<void>

issueTypes ​

ts
issueTypes: object;

issueTypes.createIssueType ​

ts
createIssueType: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ description?: string; hierarchyLevel?: number; name: string; }-
parameters.description?stringThe description of the issue type.
parameters.hierarchyLevel?numberThe hierarchy level of the issue type. Use: - -1 for Subtask. - 0 for Base. Defaults to 0.
parameters.name?stringThe unique name for the issue type. The maximum length is 60 characters.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  urls?: Record<string, string>;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: Blob; id: string; size: number; x?: number; y?: number; }-
parameters.bodyBlob-
parameters.id?stringThe ID of the issue type.
parameters.size?numberThe length of each side of the crop region.
parameters.x?numberThe X coordinate of the top-left corner of the crop region.
parameters.y?numberThe Y coordinate of the top-left corner of the crop region.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; urls?: Record<string, string>; }>

issueTypes.deleteIssueType ​

ts
deleteIssueType: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ alternativeIssueTypeId?: string; id: string; }-
parameters.alternativeIssueTypeId?stringThe ID of the replacement issue type.
parameters.id?stringThe ID of the issue type.
options?RequestOptions-
Returns ​

Promise<void>

issueTypes.getAlternativeIssueTypes ​

ts
getAlternativeIssueTypes: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the issue type.
options?RequestOptions-
Returns ​

Promise<object[]>

issueTypes.getIssueAllTypes ​

ts
getIssueAllTypes: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

issueTypes.getIssueType ​

ts
getIssueType: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the issue type.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ avatarId?: number; description?: string; id: string; name?: string; }-
parameters.avatarId?numberThe 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?stringThe description of the issue type.
parameters.id?stringThe ID of the issue type.
parameters.name?stringThe unique name for the issue type. The maximum length is 60 characters.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeIds: string[]; issueTypeSchemeId: number; }-
parameters.issueTypeIdsstring[]The list of issue type IDs.
parameters.issueTypeSchemeId?numberThe ID of the issue type scheme.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeSchemes.assignIssueTypeSchemeToProject ​

ts
assignIssueTypeSchemeToProject: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeSchemeId: string; projectId: string; }-
parameters.issueTypeSchemeIdstringThe ID of the issue type scheme.
parameters.projectId?stringThe ID of the project.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeSchemes.createIssueTypeScheme ​

ts
createIssueTypeScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueTypeSchemeId: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ defaultIssueTypeId?: string; description?: string; issueTypeIds: string[]; name: string; }-
parameters.defaultIssueTypeId?stringThe ID of the default issue type of the issue type scheme. This ID must be included in issueTypeIds.
parameters.description?stringThe 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?stringThe name of the issue type scheme. The name must be unique. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issueTypeSchemeId: string; }>

issueTypeSchemes.deleteIssueTypeScheme ​

ts
deleteIssueTypeScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeSchemeId: number; }-
parameters.issueTypeSchemeIdnumberThe ID of the issue type scheme.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeSchemes.getAllIssueTypeSchemes ​

ts
getAllIssueTypeSchemes: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | string & object | "issueTypes" | "projects" | (string & object | "issueTypes" | "projects")[]; id?: number[]; maxResults?: number; orderBy?: "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"; queryString?: string; startAt?: number; }-
parameters.expand?| string & object | "issueTypes" | "projects" | (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?numberThe 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?stringString used to perform a case-insensitive partial match with issue type scheme name.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueTypeSchemes.getIssueTypeSchemeForProjects ​

ts
getIssueTypeSchemeForProjects: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; projectId: number[]; startAt?: number; }-
parameters.maxResults?numberThe 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?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueTypeSchemes.getIssueTypeSchemesMapping ​

ts
getIssueTypeSchemesMapping: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
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?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueTypeSchemes.removeIssueTypeFromIssueTypeScheme ​

ts
removeIssueTypeFromIssueTypeScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeId: number; issueTypeSchemeId: number; }-
parameters.issueTypeIdnumberThe ID of the issue type.
parameters.issueTypeSchemeId?numberThe ID of the issue type scheme.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeSchemes.reorderIssueTypesInIssueTypeScheme ​

ts
reorderIssueTypesInIssueTypeScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ after?: string; issueTypeIds: string[]; issueTypeSchemeId: number; position?: string & object | "First" | "Last"; }-
parameters.after?stringThe 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?numberThe 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.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeSchemes.updateIssueTypeScheme ​

ts
updateIssueTypeScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ defaultIssueTypeId?: string; description?: string; issueTypeSchemeId: number; name?: string; }-
parameters.defaultIssueTypeId?stringThe ID of the default issue type of the issue type scheme.
parameters.description?stringThe description of the issue type scheme. The maximum length is 4000 characters.
parameters.issueTypeSchemeId?numberThe ID of the issue type scheme.
parameters.name?stringThe name of the issue type scheme. The name must be unique. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeScreenSchemes ​

ts
issueTypeScreenSchemes: object;

issueTypeScreenSchemes.appendMappingsForIssueTypeScreenScheme ​

ts
appendMappingsForIssueTypeScreenScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeMappings: object[]; issueTypeScreenSchemeId: string; }-
parameters.issueTypeMappingsobject[]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?stringThe ID of the issue type screen scheme.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeScreenSchemes.assignIssueTypeScreenSchemeToProject ​

ts
assignIssueTypeScreenSchemeToProject: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeScreenSchemeId?: string; projectId?: string; }-
parameters.issueTypeScreenSchemeId?stringThe ID of the issue type screen scheme.
parameters.projectId?stringThe ID of the project.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeScreenSchemes.createIssueTypeScreenScheme ​

ts
createIssueTypeScreenScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  id: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ description?: string; issueTypeMappings: object[]; name: string; }-
parameters.description?stringThe 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?stringThe name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id: string; }>

issueTypeScreenSchemes.deleteIssueTypeScreenScheme ​

ts
deleteIssueTypeScreenScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeScreenSchemeId: string; }-
parameters.issueTypeScreenSchemeIdstringThe ID of the issue type screen scheme.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeScreenSchemes.getIssueTypeScreenSchemeMappings ​

ts
getIssueTypeScreenSchemeMappings: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
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?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueTypeScreenSchemes.getIssueTypeScreenSchemeProjectAssociations ​

ts
getIssueTypeScreenSchemeProjectAssociations: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; projectId: number[]; startAt?: number; }-
parameters.maxResults?numberThe 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?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueTypeScreenSchemes.getIssueTypeScreenSchemes ​

ts
getIssueTypeScreenSchemes: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: string & object | "projects" | (string & object | "projects")[]; id?: number[]; maxResults?: number; orderBy?: "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"; queryString?: string; startAt?: number; }-
parameters.expand?string & object | "projects" | (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?numberThe 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?stringString used to perform a case-insensitive partial match with issue type screen scheme name.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueTypeScreenSchemes.getProjectsForIssueTypeScreenScheme ​

ts
getProjectsForIssueTypeScreenScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeScreenSchemeId: number; maxResults?: number; query?: string; startAt?: number; }-
parameters.issueTypeScreenSchemeIdnumberThe ID of the issue type screen scheme.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.query?string-
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

issueTypeScreenSchemes.removeMappingsFromIssueTypeScreenScheme ​

ts
removeMappingsFromIssueTypeScreenScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeIds: string[]; issueTypeScreenSchemeId: string; }-
parameters.issueTypeIdsstring[]The list of issue type IDs.
parameters.issueTypeScreenSchemeId?stringThe ID of the issue type screen scheme.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeScreenSchemes.updateDefaultScreenScheme ​

ts
updateDefaultScreenScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueTypeScreenSchemeId: string; screenSchemeId: string; }-
parameters.issueTypeScreenSchemeIdstringThe ID of the issue type screen scheme.
parameters.screenSchemeId?stringThe ID of the screen scheme.
options?RequestOptions-
Returns ​

Promise<void>

issueTypeScreenSchemes.updateIssueTypeScreenScheme ​

ts
updateIssueTypeScreenScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ description?: string; issueTypeScreenSchemeId: string; name?: string; }-
parameters.description?stringThe description of the issue type screen scheme. The maximum length is 255 characters.
parameters.issueTypeScreenSchemeId?stringThe ID of the issue type screen scheme.
parameters.name?stringThe name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<void>

issueVotes ​

ts
issueVotes: object;

issueVotes.addVote ​

ts
addVote: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<void>

issueVotes.getVotes ​

ts
getVotes: (parameters, options?) => Promise<{
[key: string]: unknown;
  hasVoted?: boolean;
  self?: string;
  voters?: object[];
  votes?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; hasVoted?: boolean; self?: string; voters?: object[]; votes?: number; }>

issueVotes.removeVote ​

ts
removeVote: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<void>

issueWatchers ​

ts
issueWatchers: object;

issueWatchers.addWatcher ​

ts
addWatcher: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ body: string; issueIdOrKey: string; }-
parameters.bodystring-
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<void>

issueWatchers.getIssueWatchers ​

ts
getIssueWatchers: (parameters, options?) => Promise<{
[key: string]: unknown;
  isWatching?: boolean;
  self?: string;
  watchCount?: number;
  watchers?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isWatching?: boolean; self?: string; watchCount?: number; watchers?: object[]; }>

issueWatchers.getIsWatchingIssueBulk ​

ts
getIsWatchingIssueBulk: (parameters, options?) => Promise<{
[key: string]: unknown;
  issuesIsWatching?: Record<string, boolean>;
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIds: string[]; }-
parameters.issueIdsstring[]The list of issue IDs.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issuesIsWatching?: Record<string, boolean>; }>

issueWatchers.removeWatcher ​

ts
removeWatcher: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; issueIdOrKey: string; }-
parameters.accountIdstringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required.
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-
Returns ​

Promise<void>

issueWorklogProperties ​

ts
issueWorklogProperties: object;

issueWorklogProperties.deleteWorklogProperty ​

ts
deleteWorklogProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; propertyKey: string; worklogId: string; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
parameters.propertyKey?stringThe key of the property.
parameters.worklogId?stringThe ID of the worklog.
options?RequestOptions-
Returns ​

Promise<void>

issueWorklogProperties.getWorklogProperty ​

ts
getWorklogProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; propertyKey: string; worklogId: string; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
parameters.propertyKey?stringThe key of the property.
parameters.worklogId?stringThe ID of the worklog.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

issueWorklogProperties.getWorklogPropertyKeys ​

ts
getWorklogPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ issueIdOrKey: string; worklogId: string; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
parameters.worklogId?stringThe ID of the worklog.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>

issueWorklogProperties.setWorklogProperty ​

ts
setWorklogProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ body: Record<string, any>; issueIdOrKey: string; propertyKey: string; worklogId: string; }-
parameters.bodyRecord<string, any>-
parameters.issueIdOrKey?stringThe ID or key of the issue.
parameters.propertyKey?stringThe key of the issue property. The maximum length is 255 characters.
parameters.worklogId?stringThe ID of the worklog.
options?RequestOptions-
Returns ​

Promise<void>

issueWorklogs ​

ts
issueWorklogs: object;

issueWorklogs.addWorklog ​

ts
addWorklog: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ adjustEstimate?: "auto" | "manual" | "new" | string & object | "leave"; author?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; comment?: | string | { content: Record<string, any>[]; type: string & object | "doc"; version: number; }; created?: unknown; expand?: | "properties" | 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?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }-
parameters.adjustEstimate?"auto" | "manual" | "new" | 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?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.author.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.author.accountType?stringThe 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?booleanWhether the user is active.
parameters.author.avatarUrls?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.author.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.author.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.author.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.author.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.author.displayName?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.author.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.author.self?stringThe URL of the user.
parameters.author.timeZone?stringThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
parameters.comment?| string | { 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?unknownThe datetime on which the worklog was created.
parameters.expand?| "properties" | 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?stringThe ID of the worklog record.
parameters.issueId?stringThe ID of the issue this worklog is for.
parameters.issueIdOrKey?stringThe ID or key the issue.
parameters.newEstimate?stringThe 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?booleanWhether users watching the issue are notified by email.
parameters.overrideEditableFlag?booleanWhether 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?stringThe 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?stringThe URL of the worklog item.
parameters.started?unknownThe datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
parameters.timeSpent?stringThe 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?numberThe 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?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.updateAuthor.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.updateAuthor.accountType?stringThe 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?booleanWhether the user is active.
parameters.updateAuthor.avatarUrls?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.updateAuthor.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.updateAuthor.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.updateAuthor.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.updateAuthor.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.updateAuthor.displayName?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.updateAuthor.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.updateAuthor.self?stringThe URL of the user.
parameters.updateAuthor.timeZone?stringThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
parameters.updated?unknownThe datetime on which the worklog was last updated.
parameters.visibility?{ identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }-
parameters.visibility.identifier?string | nullThe ID of the group or the name of the role that visibility of this item is restricted to.
parameters.visibility.type?"role" | "group" | string & objectWhether visibility of this item is restricted to a group or role.
parameters.visibility.value?stringThe 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.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ adjustEstimate?: "auto" | "manual" | "new" | string & object | "leave"; id: string; increaseBy?: string; issueIdOrKey: string; newEstimate?: string; notifyUsers?: boolean; overrideEditableFlag?: boolean; }-
parameters.adjustEstimate?"auto" | "manual" | "new" | 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?stringThe ID of the worklog.
parameters.increaseBy?stringThe 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?stringThe ID or key of the issue.
parameters.newEstimate?stringThe 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?booleanWhether users watching the issue are notified by email.
parameters.overrideEditableFlag?booleanWhether 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.
options?RequestOptions-
Returns ​

Promise<void>

issueWorklogs.getIdsOfWorklogsDeletedSince ​

ts
getIdsOfWorklogsDeletedSince: (parameters?, options?) => Promise<{
[key: string]: unknown;
  lastPage?: boolean;
  nextPage?: string;
  self?: string;
  since?: number;
  until?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ since?: number; }-
parameters.since?numberThe date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; lastPage?: boolean; nextPage?: string; self?: string; since?: number; until?: number; values?: object[]; }>

issueWorklogs.getIdsOfWorklogsModifiedSince ​

ts
getIdsOfWorklogsModifiedSince: (parameters?, options?) => Promise<{
[key: string]: unknown;
  lastPage?: boolean;
  nextPage?: string;
  self?: string;
  since?: number;
  until?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | "properties" | string & object | ("properties" | string & object)[]; since?: number; }-
parameters.expand?| "properties" | 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?numberThe date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; lastPage?: boolean; nextPage?: string; self?: string; since?: number; until?: number; values?: object[]; }>

issueWorklogs.getIssueWorklog ​

ts
getIssueWorklog: (parameters, options?) => Promise<{
[key: string]: unknown;
  maxResults?: number;
  startAt?: number;
  total?: number;
  worklogs?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | "properties" | string & object | ("properties" | string & object)[]; issueIdOrKey: string; maxResults?: number; startAt?: number; startedAfter?: number; startedBefore?: number; }-
parameters.expand?| "properties" | 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?stringThe ID or key of the issue.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
parameters.startedAfter?numberThe worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.
parameters.startedBefore?numberThe worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; maxResults?: number; startAt?: number; total?: number; worklogs?: object[]; }>

issueWorklogs.getWorklog ​

ts
getWorklog: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | "properties" | string & object | ("properties" | string & object)[]; id: string; issueIdOrKey: string; }-
parameters.expand?| "properties" | 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?stringThe ID of the worklog.
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-
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, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | "properties" | string & object | ("properties" | string & object)[]; ids: number[]; }-
parameters.expand?| "properties" | 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.
options?RequestOptions-
Returns ​

Promise<object[]>

issueWorklogs.updateWorklog ​

ts
updateWorklog: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ adjustEstimate?: "auto" | "manual" | "new" | string & object | "leave"; body: { author?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; comment?: | string | { 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?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }; expand?: | "properties" | string & object | ("properties" | string & object)[]; id: string; issueIdOrKey: string; newEstimate?: string; notifyUsers?: boolean; overrideEditableFlag?: boolean; }-
parameters.adjustEstimate?"auto" | "manual" | "new" | 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?{ author?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; comment?: | string | { 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?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }; updated?: unknown; visibility?: { identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }; }-
parameters.body.author?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.body.author.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.body.author.accountType?stringThe 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?booleanWhether the user is active.
parameters.body.author.avatarUrls?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.author.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.author.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.author.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.author.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.author.displayName?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.body.author.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.body.author.self?stringThe URL of the user.
parameters.body.author.timeZone?stringThe 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 | { 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?unknownThe datetime on which the worklog was created.
parameters.body.id?stringThe ID of the worklog record.
parameters.body.issueId?stringThe 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?stringThe URL of the worklog item.
parameters.body.started?unknownThe datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
parameters.body.timeSpent?stringThe 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?numberThe 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?{ accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; }-
parameters.body.updateAuthor.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.body.updateAuthor.accountType?stringThe 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?booleanWhether the user is active.
parameters.body.updateAuthor.avatarUrls?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.updateAuthor.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.updateAuthor.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.updateAuthor.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.updateAuthor.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.updateAuthor.displayName?stringThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
parameters.body.updateAuthor.emailAddress?stringThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
parameters.body.updateAuthor.self?stringThe URL of the user.
parameters.body.updateAuthor.timeZone?stringThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
parameters.body.updated?unknownThe datetime on which the worklog was last updated.
parameters.body.visibility?{ identifier?: string | null; type?: "role" | "group" | string & object; value?: string; }-
parameters.body.visibility.identifier?string | nullThe 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 & objectWhether visibility of this item is restricted to a group or role.
parameters.body.visibility.value?stringThe 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?| "properties" | 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?stringThe ID of the worklog.
parameters.issueIdOrKey?stringThe ID or key the issue.
parameters.newEstimate?stringThe 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?booleanWhether users watching the issue are notified by email.
parameters.overrideEditableFlag?booleanWhether 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.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  results: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ check?: "type" | string & object | "complexity" | "syntax"; contextVariables?: Record<string, string>; 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, string>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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; results: object[]; }>

jiraExpressions.evaluateExpression ​

ts
evaluateExpression: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ context?: { board?: number; custom?: ( | { accountId: string; type: "user"; } | { id?: ... | ...; key?: ... | ...; type: "issue"; } | { type: "json"; value?: ... | ...; })[]; customerRequest?: number; issue?: { id?: number; key?: string; }; issues?: { jql?: { maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; }; }; project?: { id?: number; key?: string; }; serviceDesk?: number; sprint?: number; }; expand?: | string & object | "meta.complexity" | (string & object | "meta.complexity")[]; expression: string; }-
parameters.context?{ board?: number; custom?: ( | { accountId: string; type: "user"; } | { id?: ... | ...; key?: ... | ...; type: "issue"; } | { type: "json"; value?: ... | ...; })[]; customerRequest?: number; issue?: { id?: number; key?: string; }; issues?: { jql?: { maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; }; }; project?: { id?: number; key?: string; }; serviceDesk?: number; sprint?: number; }-
parameters.context.board?numberThe ID of the board that is available under the board variable when evaluating the expression.
parameters.context.custom?( | { accountId: string; type: "user"; } | { id?: ... | ...; key?: ... | ...; type: "issue"; } | { 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?numberThe 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?{ id?: number; key?: string; }-
parameters.context.issue.id?numberThe ID of the referenced item.
parameters.context.issue.key?stringThe key of the referenced item.
parameters.context.issues?{ jql?: { maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; }; }-
parameters.context.issues.jql?{ 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?{ id?: number; key?: string; }-
parameters.context.project.id?numberThe ID of the referenced item.
parameters.context.project.key?stringThe key of the referenced item.
parameters.context.serviceDesk?numberThe ID of the service desk that is available under the serviceDesk variable when evaluating the expression.
parameters.context.sprint?numberThe ID of the sprint that is available under the sprint variable when evaluating the expression.
parameters.expand?| string & object | "meta.complexity" | (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?stringThe Jira expression to evaluate.
options?RequestOptions-
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; }>

jiraExpressions.evaluateJSISJiraExpression ​

ts
evaluateJSISJiraExpression: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ context?: { board?: number; custom?: ( | { accountId: string; type: "user"; } | { id?: ... | ...; key?: ... | ...; type: "issue"; } | { type: "json"; value?: ... | ...; })[]; customerRequest?: number; issue?: { id?: number; key?: string; }; issues?: { jql?: { maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; }; }; project?: { id?: number; key?: string; }; serviceDesk?: number; sprint?: number; }; expand?: | string & object | "meta.complexity" | (string & object | "meta.complexity")[]; expression: string; }-
parameters.context?{ board?: number; custom?: ( | { accountId: string; type: "user"; } | { id?: ... | ...; key?: ... | ...; type: "issue"; } | { type: "json"; value?: ... | ...; })[]; customerRequest?: number; issue?: { id?: number; key?: string; }; issues?: { jql?: { maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; }; }; project?: { id?: number; key?: string; }; serviceDesk?: number; sprint?: number; }-
parameters.context.board?numberThe ID of the board that is available under the board variable when evaluating the expression.
parameters.context.custom?( | { accountId: string; type: "user"; } | { id?: ... | ...; key?: ... | ...; type: "issue"; } | { 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?numberThe 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?{ id?: number; key?: string; }-
parameters.context.issue.id?numberThe ID of the referenced item.
parameters.context.issue.key?stringThe key of the referenced item.
parameters.context.issues?{ jql?: { maxResults?: ... | ...; nextPageToken?: ... | ...; query?: ... | ...; }; }-
parameters.context.issues.jql?{ 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?{ id?: number; key?: string; }-
parameters.context.project.id?numberThe ID of the referenced item.
parameters.context.project.key?stringThe key of the referenced item.
parameters.context.serviceDesk?numberThe ID of the service desk that is available under the serviceDesk variable when evaluating the expression.
parameters.context.sprint?numberThe ID of the sprint that is available under the sprint variable when evaluating the expression.
parameters.expand?| string & object | "meta.complexity" | (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?stringThe Jira expression to evaluate.
options?RequestOptions-
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; }>

Deprecated ​

Renamed to evaluateExpression, which calls the same endpoint. This alias is removed in the next major version.

jiraSettings ​

ts
jiraSettings: object;

jiraSettings.getAdvancedSettings ​

ts
getAdvancedSettings: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

jiraSettings.getApplicationProperty ​

ts
getApplicationProperty: (parameters?, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters?{ key?: string; keyFilter?: string; permissionLevel?: string; }-
parameters.key?stringThe key of the application property.
parameters.keyFilter?stringWhen 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?stringThe permission level of all items being returned in the list.
options?RequestOptions-
Returns ​

Promise<object[]>

jiraSettings.getConfiguration ​

ts
getConfiguration: (options?) => 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;
}>;
Parameters ​
ParameterType
options?RequestOptions
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, options?) => Promise<{
[key: string]: unknown;
  allowedValues?: string[];
  defaultValue?: string;
  desc?: string;
  example?: string;
  id?: string;
  key?: string;
  name?: string;
  type?: string;
  value?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: { id?: string; value?: string; }; id: string; }-
parameters.body{ id?: string; value?: string; }-
parameters.body.id?stringThe ID of the application property.
parameters.body.value?stringThe new value.
parameters.id?stringThe key of the application property to update.
options?RequestOptions-
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: (options?) => Promise<{
[key: string]: unknown;
  jqlReservedWords?: string[];
  visibleFieldNames?: object[];
  visibleFunctionNames?: object[];
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; jqlReservedWords?: string[]; visibleFieldNames?: object[]; visibleFunctionNames?: object[]; }>

jql.getAutoCompletePost ​

ts
getAutoCompletePost: (parameters, options?) => Promise<{
[key: string]: unknown;
  jqlReservedWords?: string[];
  visibleFieldNames?: object[];
  visibleFunctionNames?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ includeCollapsedFields?: boolean; projectIds?: number[]; }-
parameters.includeCollapsedFields?booleanInclude collapsed fields for fields that have non-unique names.
parameters.projectIds?number[]List of project IDs used to filter the visible field details returned.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; jqlReservedWords?: string[]; visibleFieldNames?: object[]; visibleFunctionNames?: object[]; }>

jql.getFieldAutoCompleteForQueryString ​

ts
getFieldAutoCompleteForQueryString: (parameters?, options?) => Promise<{
[key: string]: unknown;
  results?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ fieldName?: string; fieldValue?: string; predicateName?: string; predicateValue?: string; }-
parameters.fieldName?stringThe name of the field.
parameters.fieldValue?stringThe partial field item name entered by the user.
parameters.predicateName?stringThe name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to.
parameters.predicateValue?stringThe partial predicate item name entered by the user.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; results?: object[]; }>

jql.migrateQueries ​

ts
migrateQueries: (parameters, options?) => Promise<{
[key: string]: unknown;
  queriesWithUnknownUsers?: object[];
  queryStrings?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ queryStrings?: string[]; }-
parameters.queryStrings?string[]A list of queries with user identifiers. Maximum of 100 queries.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; queriesWithUnknownUsers?: object[]; queryStrings?: string[]; }>

jql.parseJqlQueries ​

ts
parseJqlQueries: (parameters, options?) => Promise<{
[key: string]: unknown;
  queries: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ queries: string[]; validation: "none" | "strict" | string & object | "warn"; }-
parameters.queriesstring[]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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; queries: object[]; }>

jqlFunctionsApps ​

ts
jqlFunctionsApps: object;

jqlFunctionsApps.getPrecomputations ​

ts
getPrecomputations: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ functionKey?: string[]; maxResults?: number; orderBy?: | string & object | "created" | "updated" | "functionKey" | "used" | "-created" | "+created" | "-functionKey" | "+functionKey" | "-used" | "+used" | "-updated" | "+updated"; 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?numberThe maximum number of items to return per page.
parameters.orderBy?| string & object | "created" | "updated" | "functionKey" | "used" | "-created" | "+created" | "-functionKey" | "+functionKey" | "-used" | "+used" | "-updated" | "+updated"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?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

jqlFunctionsApps.getPrecomputationsByID ​

ts
getPrecomputationsByID: (parameters, options?) => Promise<{
[key: string]: unknown;
  notFoundPrecomputationIDs?: string[];
  precomputations?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ orderBy?: | string & object | "created" | "updated" | "functionKey" | "used" | "-created" | "+created" | "-functionKey" | "+functionKey" | "-used" | "+used" | "-updated" | "+updated"; precomputationIDs?: string[]; }-
parameters.orderBy?| string & object | "created" | "updated" | "functionKey" | "used" | "-created" | "+created" | "-functionKey" | "+functionKey" | "-used" | "+used" | "-updated" | "+updated"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[]-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; notFoundPrecomputationIDs?: string[]; precomputations?: object[]; }>

jqlFunctionsApps.updatePrecomputations ​

ts
updatePrecomputations: (parameters, options?) => Promise<void>;
Parameters ​
ParameterType
parameters{ skipNotFoundPrecomputations?: boolean; values?: object[]; }
parameters.skipNotFoundPrecomputations?boolean
parameters.values?object[]
options?RequestOptions
Returns ​

Promise<void>

labels ​

ts
labels: object;

labels.getAllLabels ​

ts
getAllLabels: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextPage?: string;
  self?: string;
  startAt?: number;
  total?: number;
  values?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ maxResults?: number; startAt?: number; }-
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ connectKey: string; jiraIssueFieldsKey: string; }-
parameters.connectKeystringThe key of the Connect app that contains the Jira issue field being migrated.
parameters.jiraIssueFieldsKey?stringThe module key of the Connect issue field being migrated.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ connectKey: string; jiraIssueFieldsKey: string; retriggerCompletedMigration?: boolean; }-
parameters.connectKeystringThe key of the Connect app that contains the Jira issue field being migrated.
parameters.jiraIssueFieldsKey?stringThe module key of the Connect issue field being migrated.
parameters.retriggerCompletedMigration?booleanWhether to retrigger the migration if it has already completed.
options?RequestOptions-
Returns ​

Promise<void>

myself ​

ts
myself: object;

myself.getCurrentUser ​

ts
getCurrentUser: (parameters?, options?) => 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 ​
ParameterTypeDescription
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.
options?RequestOptions-
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: (options?) => Promise<{
[key: string]: unknown;
  locale?: string;
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; locale?: string; }>

myself.getPreference ​

ts
getPreference: (parameters, options?) => Promise<string>;
Parameters ​
ParameterTypeDescription
parameters{ key: string; }-
parameters.keystringThe key of the preference.
options?RequestOptions-
Returns ​

Promise<string>

myself.removePreference ​

ts
removePreference: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ key: string; }-
parameters.keystringThe key of the preference.
options?RequestOptions-
Returns ​

Promise<void>

myself.setPreference ​

ts
setPreference: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ body: string; key: string; }-
parameters.bodystring-
parameters.key?stringThe key of the preference. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<void>

permissions ​

ts
permissions: object;

permissions.getAllPermissions ​

ts
getAllPermissions: (options?) => Promise<{
[key: string]: unknown;
  permissions?: Record<string, {
   [key: string]: unknown;
     deprecatedKey?: boolean;
     description?: string;
     havePermission?: boolean;
     id?: string;
     key?: string;
     name?: string;
     type?: string & object | "PROJECT" | "GLOBAL";
  }>;
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; permissions?: Record<string, { [key: string]: unknown; deprecatedKey?: boolean; description?: string; havePermission?: boolean; id?: string; key?: string; name?: string; type?: string & object | "PROJECT" | "GLOBAL"; }>; }>

permissions.getBulkPermissions ​

ts
getBulkPermissions: (parameters, options?) => Promise<{
[key: string]: unknown;
  globalPermissions: string[];
  projectPermissions: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string; globalPermissions?: string[]; projectPermissions?: object[]; }-
parameters.accountId?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; globalPermissions: string[]; projectPermissions: object[]; }>

permissions.getMyPermissions ​

ts
getMyPermissions: (parameters?, options?) => Promise<{
[key: string]: unknown;
  permissions?: Record<string, {
   [key: string]: unknown;
     deprecatedKey?: boolean;
     description?: string;
     havePermission?: boolean;
     id?: string;
     key?: string;
     name?: string;
     type?: string & object | "PROJECT" | "GLOBAL";
  }>;
}>;
Parameters ​
ParameterTypeDescription
parameters?{ commentId?: string; issueId?: string; issueKey?: string; permissions?: string | string[]; projectConfigurationUuid?: string; projectId?: string; projectKey?: string; projectUuid?: string; }-
parameters.commentId?stringThe ID of the comment.
parameters.issueId?stringThe ID of the issue.
parameters.issueKey?stringThe 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?stringThe ID of project.
parameters.projectKey?stringThe key of project. Ignored if projectId is provided.
parameters.projectUuid?string-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; permissions?: Record<string, { [key: string]: unknown; deprecatedKey?: boolean; description?: string; havePermission?: boolean; id?: string; key?: string; name?: string; type?: string & object | "PROJECT" | "GLOBAL"; }>; }>

permissions.getPermittedProjects ​

ts
getPermittedProjects: (parameters, options?) => Promise<{
[key: string]: unknown;
  projects?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ permissions: string[]; }-
parameters.permissionsstring[]A list of permission keys.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; projects?: object[]; }>

permissionSchemes ​

ts
permissionSchemes: object;

permissionSchemes.createPermissionGrant ​

ts
createPermissionGrant: (parameters, options?) => Promise<{
[key: string]: unknown;
  holder?: {
   [key: string]: unknown;
     expand?: string;
     parameter?: string;
     type: string;
     value?: string;
  };
  id?: number;
  permission?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; holder?: { expand?: string; parameter?: string; type: string; value?: string; }; id?: number; permission?: string; schemeId: number; self?: string; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "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?{ expand?: string; parameter?: string; type: string; value?: string; }-
parameters.holder.expand?stringExpand options that include additional permission holder details in the response.
parameters.holder.parameter?stringAs 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?stringThe type of permission holder.
parameters.holder.value?stringThe identifier associated with the type value that defines the holder of the permission.
parameters.id?numberThe ID of the permission granted details.
parameters.permission?stringThe 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?numberThe ID of the permission scheme in which to create a new permission grant.
parameters.self?stringThe URL of the permission granted details.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ body: { description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { project?: { avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { 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?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; }-
parameters.body{ description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { project?: { avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { 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?stringA description for the permission scheme.
parameters.body.expand?stringThe expand options available for the permission scheme.
parameters.body.id?numberThe ID of the permission scheme.
parameters.body.name?stringThe 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?{ project?: { avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { 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?{ avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }-
parameters.body.scope.project.avatarUrls?{ 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?stringThe ID of the project.
parameters.body.scope.project.key?stringThe key of the project.
parameters.body.scope.project.name?stringThe name of the project.
parameters.body.scope.project.projectCategory?{ 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?stringThe URL of the project details.
parameters.body.scope.project.simplified?booleanWhether or not the project is simplified.
parameters.body.scope.type?string & object | "PROJECT" | "TEMPLATE"The type of scope.
parameters.body.self?stringThe URL of the permission scheme.
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "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.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ schemeId: number; }-
parameters.schemeIdnumberThe ID of the permission scheme being deleted.
options?RequestOptions-
Returns ​

Promise<void>

permissionSchemes.deletePermissionSchemeEntity ​

ts
deletePermissionSchemeEntity: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ permissionId: number; schemeId: number; }-
parameters.permissionIdnumberThe ID of the permission grant to delete.
parameters.schemeId?numberThe ID of the permission scheme to delete the permission grant from.
options?RequestOptions-
Returns ​

Promise<void>

permissionSchemes.getAllPermissionSchemes ​

ts
getAllPermissionSchemes: (parameters?, options?) => Promise<{
[key: string]: unknown;
  permissionSchemes?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; permissionSchemes?: object[]; }>

permissionSchemes.getPermissionScheme ​

ts
getPermissionScheme: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; schemeId: number; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "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?numberThe ID of the permission scheme to return.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  holder?: {
   [key: string]: unknown;
     expand?: string;
     parameter?: string;
     type: string;
     value?: string;
  };
  id?: number;
  permission?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; permissionId: number; schemeId: number; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "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?numberThe ID of the permission grant.
parameters.schemeId?numberThe ID of the permission scheme.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  permissions?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; schemeId: number; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "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?numberThe ID of the permission scheme.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; expand?: string; permissions?: object[]; }>

permissionSchemes.updatePermissionScheme ​

ts
updatePermissionScheme: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ body: { description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { project?: { avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { 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?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; schemeId: number; }-
parameters.body{ description?: string; expand?: string; id?: number; name: string; permissions?: object[]; scope?: { project?: { avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { 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?stringA description for the permission scheme.
parameters.body.expand?stringThe expand options available for the permission scheme.
parameters.body.id?numberThe ID of the permission scheme.
parameters.body.name?stringThe 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?{ project?: { avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { 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?{ avatarUrls?: { 16x16?: ...; 24x24?: ...; 32x32?: ...; 48x48?: ...; }; id?: string; key?: string; name?: string; projectCategory?: { description?: ...; id?: ...; name?: ...; self?: ...; }; projectTypeKey?: | ... & ... | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }-
parameters.body.scope.project.avatarUrls?{ 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?stringThe ID of the project.
parameters.body.scope.project.key?stringThe key of the project.
parameters.body.scope.project.name?stringThe name of the project.
parameters.body.scope.project.projectCategory?{ 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?stringThe URL of the project details.
parameters.body.scope.project.simplified?booleanWhether or not the project is simplified.
parameters.body.scope.type?string & object | "PROJECT" | "TEMPLATE"The type of scope.
parameters.body.self?stringThe URL of the permission scheme.
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "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?numberThe ID of the permission scheme to update.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  urls?: Record<string, string>;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: Blob; projectIdOrKey: string; size?: number; x?: number; y?: number; }-
parameters.bodyBlob-
parameters.projectIdOrKey?stringThe ID or (case-sensitive) key of the project.
parameters.size?numberThe length of each side of the crop region.
parameters.x?numberThe X coordinate of the top-left corner of the crop region.
parameters.y?numberThe Y coordinate of the top-left corner of the crop region.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; urls?: Record<string, string>; }>

projectAvatars.deleteProjectAvatar ​

ts
deleteProjectAvatar: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; projectIdOrKey: string; }-
parameters.idnumberThe ID of the avatar.
parameters.projectIdOrKey?stringThe project ID or (case-sensitive) key.
options?RequestOptions-
Returns ​

Promise<void>

projectAvatars.getAllProjectAvatars ​

ts
getAllProjectAvatars: (parameters, options?) => Promise<{
[key: string]: unknown;
  custom?: object[];
  system?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ projectIdOrKey: string; }-
parameters.projectIdOrKeystringThe ID or (case-sensitive) key of the project.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; custom?: object[]; system?: object[]; }>

projectAvatars.updateProjectAvatar ​

ts
updateProjectAvatar: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ fileName?: string; id: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; projectIdOrKey: string; urls?: Record<string, string>; }-
parameters.fileName?stringThe file name of the avatar icon. Returned for system avatars.
parameters.id?stringThe ID of the avatar.
parameters.isDeletable?booleanWhether the avatar can be deleted.
parameters.isSelected?booleanWhether the avatar is used in Jira. For example, shown as a project's avatar.
parameters.isSystemAvatar?booleanWhether the avatar is a system avatar.
parameters.owner?stringThe 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?stringThe ID or (case-sensitive) key of the project.
parameters.urls?Record<string, string>The list of avatar icon URLs.
options?RequestOptions-
Returns ​

Promise<void>

projectCategories ​

ts
projectCategories: object;

projectCategories.createProjectCategory ​

ts
createProjectCategory: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ description?: string; id?: string; name?: string; self?: string; }-
parameters.description?stringThe description of the project category.
parameters.id?stringThe ID of the project category.
parameters.name?stringThe name of the project category. Required on create, optional on update.
parameters.self?stringThe URL of the project category.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>

projectCategories.getAllProjectCategories ​

ts
getAllProjectCategories: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

projectCategories.getProjectCategoryById ​

ts
getProjectCategoryById: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the project category.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>

projectCategories.removeProjectCategory ​

ts
removeProjectCategory: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberID of the project category to delete.
options?RequestOptions-
Returns ​

Promise<void>

projectCategories.updateProjectCategory ​

ts
updateProjectCategory: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: { description?: string; id?: string; name?: string; self?: string; }; id: number; }-
parameters.body{ description?: string; id?: string; name?: string; self?: string; }-
parameters.body.description?stringThe description of the project category.
parameters.body.id?stringThe ID of the project category.
parameters.body.name?stringThe name of the project category. Required on create, optional on update.
parameters.body.self?stringThe URL of the project category.
parameters.id?number-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>

projectComponents ​

ts
projectComponents: object;

projectComponents.createComponent ​

ts
createComponent: (parameters, options?) => 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, string>;
  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 ​
ParameterTypeDescription
parameters{ ari?: string; assignee?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; description?: string; id?: string; isAssigneeTypeValid?: boolean; lead?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; leadAccountId?: string; metadata?: Record<string, string>; name?: string; project?: string; projectId?: number; realAssignee?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; realAssigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; self?: string; }-
parameters.ari?stringCompass component's ID. Can't be updated. Not required for creating a Project Component.
parameters.assignee?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.assignee.accountId?stringThe 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?booleanWhether the user is active.
parameters.assignee.applicationRoles?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.assignee.applicationRoles.callback?Record<string, never>-
parameters.assignee.applicationRoles.items?object[]-
parameters.assignee.applicationRoles.max-results?number-
parameters.assignee.applicationRoles.pagingCallback?Record<string, never>-
parameters.assignee.applicationRoles.size?number-
parameters.assignee.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.assignee.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.assignee.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.assignee.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.assignee.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.assignee.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.assignee.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.assignee.expand?stringExpand options that include additional user details in the response.
parameters.assignee.groups?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.assignee.groups.callback?Record<string, never>-
parameters.assignee.groups.items?object[]-
parameters.assignee.groups.max-results?number-
parameters.assignee.groups.pagingCallback?Record<string, never>-
parameters.assignee.groups.size?number-
parameters.assignee.guest?booleanWhether the user is a guest.
parameters.assignee.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.assignee.self?stringThe URL of the user.
parameters.assignee.timeZone?stringThe 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?stringThe description for the component. Optional when creating or updating a component.
parameters.id?stringThe unique identifier for the component.
parameters.isAssigneeTypeValid?booleanWhether 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?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.lead.accountId?stringThe 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?booleanWhether the user is active.
parameters.lead.applicationRoles?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.lead.applicationRoles.callback?Record<string, never>-
parameters.lead.applicationRoles.items?object[]-
parameters.lead.applicationRoles.max-results?number-
parameters.lead.applicationRoles.pagingCallback?Record<string, never>-
parameters.lead.applicationRoles.size?number-
parameters.lead.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.lead.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.lead.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.lead.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.lead.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.lead.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.lead.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.lead.expand?stringExpand options that include additional user details in the response.
parameters.lead.groups?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.lead.groups.callback?Record<string, never>-
parameters.lead.groups.items?object[]-
parameters.lead.groups.max-results?number-
parameters.lead.groups.pagingCallback?Record<string, never>-
parameters.lead.groups.size?number-
parameters.lead.guest?booleanWhether the user is a guest.
parameters.lead.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.lead.self?stringThe URL of the user.
parameters.lead.timeZone?stringThe 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?stringThe accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.metadata?Record<string, string>Compass component's metadata. Can't be updated. Not required for creating a Project Component.
parameters.name?stringThe 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?stringThe key of the project the component is assigned to. Required when creating a component. Can't be updated.
parameters.projectId?numberThe ID of the project the component is assigned to.
parameters.realAssignee?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.realAssignee.accountId?stringThe 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?booleanWhether the user is active.
parameters.realAssignee.applicationRoles?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.realAssignee.applicationRoles.callback?Record<string, never>-
parameters.realAssignee.applicationRoles.items?object[]-
parameters.realAssignee.applicationRoles.max-results?number-
parameters.realAssignee.applicationRoles.pagingCallback?Record<string, never>-
parameters.realAssignee.applicationRoles.size?number-
parameters.realAssignee.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.realAssignee.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.realAssignee.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.realAssignee.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.realAssignee.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.realAssignee.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.realAssignee.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.realAssignee.expand?stringExpand options that include additional user details in the response.
parameters.realAssignee.groups?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.realAssignee.groups.callback?Record<string, never>-
parameters.realAssignee.groups.items?object[]-
parameters.realAssignee.groups.max-results?number-
parameters.realAssignee.groups.pagingCallback?Record<string, never>-
parameters.realAssignee.groups.size?number-
parameters.realAssignee.guest?booleanWhether the user is a guest.
parameters.realAssignee.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.realAssignee.self?stringThe URL of the user.
parameters.realAssignee.timeZone?stringThe 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?stringThe URL of the component.
options?RequestOptions-
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, string>; 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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; moveIssuesTo?: string; }-
parameters.idstringThe ID of the component.
parameters.moveIssuesTo?stringThe ID of the component to replace the deleted component. If this value is null no replacement is made.
options?RequestOptions-
Returns ​

Promise<void>

projectComponents.findComponentsForProjects ​

ts
findComponentsForProjects: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ maxResults?: number; orderBy?: | "name" | "description" | string & object | "-description" | "+description" | "-name" | "+name"; projectIdsOrKeys?: string[]; query?: string; startAt?: number; }-
parameters.maxResults?numberThe 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?stringFilter the results using a literal string. Components with a matching name or description are returned (case insensitive).
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

projectComponents.getComponent ​

ts
getComponent: (parameters, options?) => 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, string>;
  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 ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the component.
options?RequestOptions-
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, string>; 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, options?) => Promise<{
[key: string]: unknown;
  issueCount?: number;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the component.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issueCount?: number; self?: string; }>

projectComponents.getProjectComponents ​

ts
getProjectComponents: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
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?stringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<object[]>

projectComponents.getProjectComponentsPaginated ​

ts
getProjectComponentsPaginated: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
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?numberThe 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?stringThe project ID or project key (case sensitive).
parameters.query?stringFilter the results using a literal string. Components with a matching name or description are returned (case insensitive).
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

projectComponents.updateComponent ​

ts
updateComponent: (parameters, options?) => 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, string>;
  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 ​
ParameterTypeDescription
parameters{ body: { ari?: string; assignee?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; description?: string; id?: string; isAssigneeTypeValid?: boolean; lead?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; leadAccountId?: string; metadata?: Record<string, string>; name?: string; project?: string; projectId?: number; realAssignee?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; realAssigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; self?: string; }; id: string; }-
parameters.body{ ari?: string; assignee?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; description?: string; id?: string; isAssigneeTypeValid?: boolean; lead?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; leadAccountId?: string; metadata?: Record<string, string>; name?: string; project?: string; projectId?: number; realAssignee?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; realAssigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; self?: string; }-
parameters.body.ari?stringCompass component's ID. Can't be updated. Not required for creating a Project Component.
parameters.body.assignee?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.body.assignee.accountId?stringThe 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?booleanWhether the user is active.
parameters.body.assignee.applicationRoles?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.assignee.applicationRoles.callback?Record<..., ...>-
parameters.body.assignee.applicationRoles.items?...[]-
parameters.body.assignee.applicationRoles.max-results?number-
parameters.body.assignee.applicationRoles.pagingCallback?Record<..., ...>-
parameters.body.assignee.applicationRoles.size?number-
parameters.body.assignee.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.assignee.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.assignee.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.assignee.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.assignee.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.assignee.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.body.assignee.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.assignee.expand?stringExpand options that include additional user details in the response.
parameters.body.assignee.groups?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.assignee.groups.callback?Record<..., ...>-
parameters.body.assignee.groups.items?...[]-
parameters.body.assignee.groups.max-results?number-
parameters.body.assignee.groups.pagingCallback?Record<..., ...>-
parameters.body.assignee.groups.size?number-
parameters.body.assignee.guest?booleanWhether the user is a guest.
parameters.body.assignee.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.assignee.self?stringThe URL of the user.
parameters.body.assignee.timeZone?stringThe 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?stringThe description for the component. Optional when creating or updating a component.
parameters.body.id?stringThe unique identifier for the component.
parameters.body.isAssigneeTypeValid?booleanWhether 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?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.body.lead.accountId?stringThe 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?booleanWhether the user is active.
parameters.body.lead.applicationRoles?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.lead.applicationRoles.callback?Record<..., ...>-
parameters.body.lead.applicationRoles.items?...[]-
parameters.body.lead.applicationRoles.max-results?number-
parameters.body.lead.applicationRoles.pagingCallback?Record<..., ...>-
parameters.body.lead.applicationRoles.size?number-
parameters.body.lead.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.lead.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.lead.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.lead.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.lead.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.lead.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.body.lead.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.lead.expand?stringExpand options that include additional user details in the response.
parameters.body.lead.groups?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.lead.groups.callback?Record<..., ...>-
parameters.body.lead.groups.items?...[]-
parameters.body.lead.groups.max-results?number-
parameters.body.lead.groups.pagingCallback?Record<..., ...>-
parameters.body.lead.groups.size?number-
parameters.body.lead.guest?booleanWhether the user is a guest.
parameters.body.lead.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.lead.self?stringThe URL of the user.
parameters.body.lead.timeZone?stringThe 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?stringThe 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, string>Compass component's metadata. Can't be updated. Not required for creating a Project Component.
parameters.body.name?stringThe 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?stringThe key of the project the component is assigned to. Required when creating a component. Can't be updated.
parameters.body.projectId?numberThe ID of the project the component is assigned to.
parameters.body.realAssignee?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.body.realAssignee.accountId?stringThe 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?booleanWhether the user is active.
parameters.body.realAssignee.applicationRoles?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.realAssignee.applicationRoles.callback?Record<..., ...>-
parameters.body.realAssignee.applicationRoles.items?...[]-
parameters.body.realAssignee.applicationRoles.max-results?number-
parameters.body.realAssignee.applicationRoles.pagingCallback?Record<..., ...>-
parameters.body.realAssignee.applicationRoles.size?number-
parameters.body.realAssignee.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.realAssignee.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.realAssignee.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.realAssignee.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.realAssignee.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.realAssignee.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.body.realAssignee.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.realAssignee.expand?stringExpand options that include additional user details in the response.
parameters.body.realAssignee.groups?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.realAssignee.groups.callback?Record<..., ...>-
parameters.body.realAssignee.groups.items?...[]-
parameters.body.realAssignee.groups.max-results?number-
parameters.body.realAssignee.groups.pagingCallback?Record<..., ...>-
parameters.body.realAssignee.groups.size?number-
parameters.body.realAssignee.guest?booleanWhether the user is a guest.
parameters.body.realAssignee.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.realAssignee.self?stringThe URL of the user.
parameters.body.realAssignee.timeZone?stringThe 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?stringThe URL of the component.
parameters.id?stringThe ID of the component.
options?RequestOptions-
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, string>; 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, options?) => Promise<{
[key: string]: unknown;
  emailAddress?: string;
  emailAddressStatus?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ projectId: number; }-
parameters.projectIdnumberThe project ID.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; emailAddress?: string; emailAddressStatus?: string[]; }>

projectEmail.updateProjectEmail ​

ts
updateProjectEmail: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ emailAddress?: string; emailAddressStatus?: string[]; projectId: number; }-
parameters.emailAddress?stringThe email address.
parameters.emailAddressStatus?string[]When using a custom domain, the status of the email address.
parameters.projectId?numberThe project ID.
options?RequestOptions-
Returns ​

Promise<void>

projectFeatures ​

ts
projectFeatures: object;

projectFeatures.getFeaturesForProject ​

ts
getFeaturesForProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  features?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ projectIdOrKey: string; }-
parameters.projectIdOrKeystringThe ID or (case-sensitive) key of the project.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; features?: object[]; }>

projectFeatures.toggleFeatureForProject ​

ts
toggleFeatureForProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  features?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ featureKey: string; projectIdOrKey: string; state?: string & object | "ENABLED" | "DISABLED" | "COMING_SOON"; }-
parameters.featureKeystringThe key of the feature.
parameters.projectIdOrKey?stringThe ID or (case-sensitive) key of the project.
parameters.state?string & object | "ENABLED" | "DISABLED" | "COMING_SOON"The feature state.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; features?: object[]; }>

projectKeyAndNameValidation ​

ts
projectKeyAndNameValidation: object;

projectKeyAndNameValidation.getValidProjectKey ​

ts
getValidProjectKey: (parameters?, options?) => Promise<string>;
Parameters ​
ParameterTypeDescription
parameters?{ key?: string; }-
parameters.key?stringThe project key.
options?RequestOptions-
Returns ​

Promise<string>

projectKeyAndNameValidation.getValidProjectName ​

ts
getValidProjectName: (parameters, options?) => Promise<string>;
Parameters ​
ParameterTypeDescription
parameters{ name: string; }-
parameters.namestringThe project name.
options?RequestOptions-
Returns ​

Promise<string>

projectKeyAndNameValidation.validateProjectKey ​

ts
validateProjectKey: (parameters?, options?) => Promise<{
[key: string]: unknown;
  errorMessages?: string[];
  errors?: Record<string, string>;
  status?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters?{ key?: string; }-
parameters.key?stringThe project key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; errorMessages?: string[]; errors?: Record<string, string>; status?: number; }>

projectPermissionSchemes ​

ts
projectPermissionSchemes: object;

projectPermissionSchemes.assignPermissionScheme ​

ts
assignPermissionScheme: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; id: number; projectKeyOrId: string; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "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?numberThe 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?stringThe project ID or project key (case sensitive).
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole")[]; projectKeyOrId: string; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "permissions" | "projectRole" | ( | "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?stringThe project ID or project key (case sensitive).
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  defaultSecurityLevelId?: number;
  description?: string;
  id?: number;
  levels?: object[];
  name?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ projectKeyOrId: string; }-
parameters.projectKeyOrIdstringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultSecurityLevelId?: number; description?: string; id?: number; levels?: object[]; name?: string; self?: string; }>

projectPermissionSchemes.getSecurityLevelsForProject ​

ts
getSecurityLevelsForProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  levels: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ projectKeyOrId: string; }-
parameters.projectKeyOrIdstringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; levels: object[]; }>

projectProperties ​

ts
projectProperties: object;

projectProperties.deleteProjectProperty ​

ts
deleteProjectProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ projectIdOrKey: string; propertyKey: string; }-
parameters.projectIdOrKeystringThe project ID or project key (case sensitive).
parameters.propertyKey?stringThe project property key. Use Get project property keys to get a list of all project property keys.
options?RequestOptions-
Returns ​

Promise<void>

projectProperties.getProjectProperty ​

ts
getProjectProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ projectIdOrKey: string; propertyKey: string; }-
parameters.projectIdOrKeystringThe project ID or project key (case sensitive).
parameters.propertyKey?stringThe project property key. Use Get project property keys to get a list of all project property keys.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

projectProperties.getProjectPropertyKeys ​

ts
getProjectPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ projectIdOrKey: string; }-
parameters.projectIdOrKeystringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>

projectProperties.setProjectProperty ​

ts
setProjectProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ body: Record<string, any>; projectIdOrKey: string; propertyKey: string; }-
parameters.bodyRecord<string, any>-
parameters.projectIdOrKey?stringThe project ID or project key (case sensitive).
parameters.propertyKey?stringThe key of the project property. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<void>

projectRoleActors ​

ts
projectRoleActors: object;

projectRoleActors.addActorUsers ​

ts
addActorUsers: (parameters, options?) => 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 ​
ParameterTypeDescription
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?numberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
parameters.projectIdOrKey?stringThe project ID or project key (case sensitive).
parameters.user?string[]The user account ID of the user to add.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
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?numberThe 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"].
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ group?: string; groupId?: string; id: number; projectIdOrKey: string; user?: string; }-
parameters.group?stringThe 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?stringThe ID of the group to remove from the project role. This parameter cannot be used with the group parameter.
parameters.id?numberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
parameters.projectIdOrKey?stringThe project ID or project key (case sensitive).
parameters.user?stringThe user account ID of the user to remove from the project role.
options?RequestOptions-
Returns ​

Promise<void>

projectRoleActors.deleteProjectRoleActorsFromRole ​

ts
deleteProjectRoleActorsFromRole: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ group?: string; groupId?: string; id: number; user?: string; }-
parameters.group?stringThe 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?stringThe group ID of the group to be removed as a default actor. This parameter cannot be used with the group parameter.
parameters.id?numberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
parameters.user?stringThe user account ID of the user to remove as a default actor.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ body: { categorisedActors?: Record<string, string[]>; id?: number; }; id: number; projectIdOrKey: string; }-
parameters.body{ categorisedActors?: Record<string, string[]>; id?: number; }-
parameters.body.categorisedActors?Record<string, string[]>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?numberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
parameters.id?numberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
parameters.projectIdOrKey?stringThe project ID or project key (case sensitive).
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ description?: string; name?: string; }-
parameters.description?stringA description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
parameters.name?stringThe 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.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; swap?: number; }-
parameters.idnumberThe ID of the project role to delete. Use Get all project roles to get a list of project role IDs.
parameters.swap?numberThe 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.
options?RequestOptions-
Returns ​

Promise<void>

projectRoles.fullyUpdateProjectRole ​

ts
fullyUpdateProjectRole: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ description?: string; id: number; name?: string; }-
parameters.description?stringA description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
parameters.id?numberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
parameters.name?stringThe 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.
options?RequestOptions-
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: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

projectRoles.getProjectRole ​

ts
getProjectRole: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ excludeInactiveUsers?: boolean; id: number; projectIdOrKey: string; }-
parameters.excludeInactiveUsers?booleanExclude inactive users.
parameters.id?numberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
parameters.projectIdOrKey?stringThe project ID or project key (case sensitive).
options?RequestOptions-
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, options?) => 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 ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
options?RequestOptions-
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, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ currentMember?: boolean; excludeConnectAddons?: boolean; excludeOtherServiceRoles?: boolean; projectIdOrKey: string; }-
parameters.currentMember?booleanWhether the roles should be filtered to include only those the user is assigned to.
parameters.excludeConnectAddons?boolean-
parameters.excludeOtherServiceRoles?booleanDo not return the default JSM company-managed space from CSM spaces, or the default CSM roles from JSM spaces.
parameters.projectIdOrKey?stringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<object[]>

projectRoles.getProjectRoles ​

ts
getProjectRoles: (parameters, options?) => Promise<Record<string, string>>;
Parameters ​
ParameterTypeDescription
parameters{ projectIdOrKey: string; }-
parameters.projectIdOrKeystringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<Record<string, string>>

projectRoles.partialUpdateProjectRole ​

ts
partialUpdateProjectRole: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ description?: string; id: number; name?: string; }-
parameters.description?stringA description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
parameters.id?numberThe ID of the project role. Use Get all project roles to get a list of project role IDs.
parameters.name?stringThe 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.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ projectIdOrKey: string; }-
parameters.projectIdOrKeystringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<void>

projects.createProject ​

ts
createProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  id: number;
  key: string;
  self: string;
}>;
Parameters ​
ParameterTypeDescription
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?numberAn integer value for the project's avatar.
parameters.categoryId?numberThe ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.
parameters.description?stringA brief description of the project.
parameters.fieldScheme?numberThe 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?numberThe 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?numberThe 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?numberThe 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?stringProject 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?stringThe account ID of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with lead.
parameters.name?stringThe name of the project.
parameters.notificationScheme?numberThe ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.
parameters.permissionScheme?numberThe 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?stringA link to information about this project, such as project documentation
parameters.workflowScheme?numberThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id: number; key: string; self: string; }>

projects.deleteProject ​

ts
deleteProject: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ enableUndo?: boolean; projectIdOrKey: string; }-
parameters.enableUndo?booleanWhether this project is placed in the Jira recycle bin where it will be available for restoration.
parameters.projectIdOrKey?stringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<void>

projects.getAllStatuses ​

ts
getAllStatuses: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ projectIdOrKey: string; }-
parameters.projectIdOrKeystringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<object[]>

projects.getHierarchy ​

ts
getHierarchy: (parameters, options?) => Promise<{
[key: string]: unknown;
  hierarchy?: object[];
  projectId?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ projectId: number; }-
parameters.projectIdnumberThe ID of the project.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; hierarchy?: object[]; projectId?: number; }>

projects.getNotificationSchemeForProject ​

ts
getNotificationSchemeForProject: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[]; projectKeyOrId: string; }-
parameters.expand?| "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole" | ( | "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?stringThe project ID or project key (case sensitive).
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  archivedBy?: {
   [key: string]: unknown;
     accountId?: string;
     accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        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, string>;
     boardId?: number;
     boardName?: string;
     projectKey?: string;
     projectType?: string;
     queueCategory?: string;
     queueId?: number;
     queueName?: string;
     simpleBoard?: boolean;
     simplified?: boolean;
     url?: string;
  };
  lead?: {
   [key: string]: unknown;
     accountId?: string;
     accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        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, string>;
  self?: string;
  simplified?: boolean;
  style?: "classic" | string & object | "next-gen";
  url?: string;
  uuid?: string;
  versions?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | "description" | string & object | "issueTypes" | "lead" | "issueTypeHierarchy" | "projectKeys" | ( | "description" | string & object | "issueTypes" | "lead" | "issueTypeHierarchy" | "projectKeys")[]; projectIdOrKey: string; properties?: string[]; }-
parameters.expand?| "description" | string & object | "issueTypes" | "lead" | "issueTypeHierarchy" | "projectKeys" | ( | "description" | string & object | "issueTypes" | "lead" | "issueTypeHierarchy" | "projectKeys")[]Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: - description The project description. - issueTypes The issue types associated with the project. - lead The project lead. - projectKeys All project keys associated with the project. - issueTypeHierarchy The project issue type hierarchy.
parameters.projectIdOrKey?stringThe project ID or project key (case sensitive).
parameters.properties?string[]A list of project properties to return for the project. This parameter accepts a comma-separated list. Note that only the properties named here are returned in properties in the response; that object is empty when this parameter is omitted.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; archived?: boolean; archivedBy?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; 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, string>; boardId?: number; boardName?: string; projectKey?: string; projectType?: string; queueCategory?: string; queueId?: number; queueName?: string; simpleBoard?: boolean; simplified?: boolean; url?: string; }; lead?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; 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, string>; self?: string; simplified?: boolean; style?: "classic" | string & object | "next-gen"; url?: string; uuid?: string; versions?: object[]; }>

projects.searchProjects ​

ts
searchProjects: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ action?: "view" | string & object | "edit" | "create" | "browse"; categoryId?: number; expand?: | "url" | "description" | string & object | "issueTypes" | "lead" | "insight" | "projectKeys" | ( | "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?: Record<string, never>[]; 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?numberThe ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.
parameters.expand?| "url" | "description" | string & object | "issueTypes" | "lead" | "insight" | "projectKeys" | ( | "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?numberThe 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?Record<string, never>[]EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.
parameters.propertyQuery?stringEXPERIMENTAL. 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?stringFilter the results using a literal string. Projects with a matching key or name are returned (case insensitive).
parameters.startAt?numberThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

projects.updateProject ​

ts
updateProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  archivedBy?: {
   [key: string]: unknown;
     accountId?: string;
     accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        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, string>;
     boardId?: number;
     boardName?: string;
     projectKey?: string;
     projectType?: string;
     queueCategory?: string;
     queueId?: number;
     queueName?: string;
     simpleBoard?: boolean;
     simplified?: boolean;
     url?: string;
  };
  lead?: {
   [key: string]: unknown;
     accountId?: string;
     accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        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, string>;
  self?: string;
  simplified?: boolean;
  style?: "classic" | string & object | "next-gen";
  url?: string;
  uuid?: string;
  versions?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED"; avatarId?: number; categoryId?: number; description?: string; expand?: | "description" | string & object | "issueTypes" | "lead" | "projectKeys" | ( | "description" | string & object | "issueTypes" | "lead" | "projectKeys")[]; issueSecurityScheme?: number; key?: string; leadAccountId?: string; name?: string; notificationScheme?: number; permissionScheme?: number; projectIdOrKey: string; releasedProjectKeys?: string[]; url?: string; }-
parameters.assigneeType?string & object | "PROJECT_LEAD" | "UNASSIGNED"The default assignee when creating issues for this project.
parameters.avatarId?numberAn integer value for the project's avatar.
parameters.categoryId?numberThe 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?stringA brief description of the project.
parameters.expand?| "description" | string & object | "issueTypes" | "lead" | "projectKeys" | ( | "description" | string & object | "issueTypes" | "lead" | "projectKeys")[]Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: - description The project description. - issueTypes The issue types associated with the project. - lead The project lead. - projectKeys All project keys associated with the project.
parameters.issueSecurityScheme?numberThe 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?stringProject 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?stringThe account ID of the project lead. Cannot be provided with lead.
parameters.name?stringThe name of the project.
parameters.notificationScheme?numberThe ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.
parameters.permissionScheme?numberThe 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?stringThe 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?stringA link to information about this project, such as project documentation
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; archived?: boolean; archivedBy?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; 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, string>; boardId?: number; boardName?: string; projectKey?: string; projectType?: string; queueCategory?: string; queueId?: number; queueName?: string; simpleBoard?: boolean; simplified?: boolean; url?: string; }; lead?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; 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, string>; 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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ details?: { accessLevel?: "open" | "private" | string & object | "limited" | "free"; additionalProperties?: Record<string, string>; 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?: { boardFeatures?: { boardFeatures?: Record<string, ...[]>; }; boards?: { boards?: object[]; }; field?: { customFieldDefinitions?: object[] | null; fieldLayoutScheme?: { defaultFieldLayout?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; fieldScheme?: { description?: ... | ...; items?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; issueLayouts?: object[] | null; issueTypeScreenScheme?: { defaultScreenScheme?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; screens?: object[] | null; screenScheme?: object[] | null; }; issueType?: { issueTypeHierarchy?: object[] | null; issueTypes?: object[] | null; issueTypeScheme?: { defaultIssueTypeId?: ... | ...; description?: ... | ... | ...; issueTypeIds?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; }; notification?: { description?: string; name?: string; notificationSchemeEvents?: object[]; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; permissionScheme?: { addAddonRole?: boolean; description?: string; grants?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; project?: { fieldLayoutSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueSecuritySchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeScreenSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; notificationSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; permissionSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; workflowSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; role?: { roles?: object[]; roleToProjectActors?: Record<string, ...[]>; }; scope?: { type?: string & object | "PROJECT" | "GLOBAL"; }; security?: { description?: string; name?: string; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; securityLevels?: object[]; }; workflow?: { statuses?: object[]; workflows?: object[]; workflowScheme?: { defaultWorkflow?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; }; }; }-
parameters.details?{ accessLevel?: "open" | "private" | string & object | "limited" | "free"; additionalProperties?: Record<string, string>; 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, string>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?numberThe ID of the project's avatar. Use the Get project avatars operation to list the available avatars in a project.
parameters.details.categoryId?numberThe ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.
parameters.details.description?stringBrief description of the project
parameters.details.enableComponents?booleanWhether components are enabled for the project. Only used by company-managed project
parameters.details.key?stringProject 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?stringThe default language for the project
parameters.details.leadAccountId?stringThe 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?stringName of the project
parameters.details.url?stringA link to information about this project, such as project documentation
parameters.template?{ boardFeatures?: { boardFeatures?: Record<string, ...[]>; }; boards?: { boards?: object[]; }; field?: { customFieldDefinitions?: object[] | null; fieldLayoutScheme?: { defaultFieldLayout?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; fieldScheme?: { description?: ... | ...; items?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; issueLayouts?: object[] | null; issueTypeScreenScheme?: { defaultScreenScheme?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; screens?: object[] | null; screenScheme?: object[] | null; }; issueType?: { issueTypeHierarchy?: object[] | null; issueTypes?: object[] | null; issueTypeScheme?: { defaultIssueTypeId?: ... | ...; description?: ... | ... | ...; issueTypeIds?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; }; notification?: { description?: string; name?: string; notificationSchemeEvents?: object[]; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; permissionScheme?: { addAddonRole?: boolean; description?: string; grants?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; project?: { fieldLayoutSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueSecuritySchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeScreenSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; notificationSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; permissionSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; workflowSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }; role?: { roles?: object[]; roleToProjectActors?: Record<string, ...[]>; }; scope?: { type?: string & object | "PROJECT" | "GLOBAL"; }; security?: { description?: string; name?: string; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; securityLevels?: object[]; }; workflow?: { statuses?: object[]; workflows?: object[]; workflowScheme?: { defaultWorkflow?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; }; }-
parameters.template.boardFeatures?{ boardFeatures?: Record<string, ...[]>; }-
parameters.template.boardFeatures.boardFeatures?Record<string, ...[]>A map of board PCRIs to the list of features to enable on each board.
parameters.template.boards?{ boards?: object[]; }-
parameters.template.boards.boards?object[]The boards to be associated with the project.
parameters.template.field?{ customFieldDefinitions?: object[] | null; fieldLayoutScheme?: { defaultFieldLayout?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; fieldScheme?: { description?: ... | ...; items?: ... | ...; name?: ... | ...; onConflict?: ... | ... | ... | ... | ...; pcri?: ... | ...; }; issueLayouts?: object[] | null; issueTypeScreenScheme?: { defaultScreenScheme?: ... | ...; description?: ... | ...; explicitMappings?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; screens?: object[] | null; screenScheme?: object[] | null; }-
parameters.template.field.customFieldDefinitions?object[] | nullThe 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?{ 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?{ 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[] | nullThe issue layouts configuration
parameters.template.field.issueTypeScreenScheme?{ 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[] | nullThe 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[] | nullThe 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?{ issueTypeHierarchy?: object[] | null; issueTypes?: object[] | null; issueTypeScheme?: { defaultIssueTypeId?: ... | ...; description?: ... | ... | ...; issueTypeIds?: ... | ...; name?: ... | ...; pcri?: ... | ...; }; }-
parameters.template.issueType.issueTypeHierarchy?object[] | nullDefines 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[] | nullOnly 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?{ 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?{ description?: string; name?: string; notificationSchemeEvents?: object[]; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }-
parameters.template.notification.description?stringThe description of the notification scheme
parameters.template.notification.name?stringThe 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?{ 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?{ addAddonRole?: boolean; description?: string; grants?: object[]; name?: string; onConflict?: string & object | "FAIL" | "USE" | "NEW"; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }-
parameters.template.permissionScheme.addAddonRole?booleanConfiguration to generate addon role. Default is false if null. Only applies to GLOBAL-scoped permission scheme
parameters.template.permissionScheme.description?stringThe description of the permission scheme
parameters.template.permissionScheme.grants?object[]List of permission grants
parameters.template.permissionScheme.name?stringThe 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?{ 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?{ fieldLayoutSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueSecuritySchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; issueTypeScreenSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; notificationSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; permissionSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; workflowSchemeId?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; }-
parameters.template.project.fieldLayoutSchemeId?{ 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?{ 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?{ 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?{ 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?{ 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?{ 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?{ 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?{ 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?{ roles?: object[]; roleToProjectActors?: Record<string, ...[]>; }-
parameters.template.role.roles?object[]The list of roles to create.
parameters.template.role.roleToProjectActors?Record<string, ...[]>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?{ 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?{ description?: string; name?: string; pcri?: { anID?: ... | ... | ...; areference?: ... | ... | ...; entityId?: ... | ...; entityType?: ... | ...; id?: ... | ...; type?: ... | ... | ... | ...; }; securityLevels?: object[]; }-
parameters.template.security.description?stringThe description of the security scheme
parameters.template.security.name?stringThe name of the security scheme
parameters.template.security.pcri?{ 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?{ statuses?: object[]; workflows?: object[]; workflowScheme?: { 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?{ 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?... | ...-
options?RequestOptions-
Returns ​

Promise<void>

projectTypes ​

ts
projectTypes: object;

projectTypes.getAccessibleProjectTypeByKey ​

ts
getAccessibleProjectTypeByKey: (parameters, options?) => Promise<{
[key: string]: unknown;
  color?: string;
  descriptionI18nKey?: string;
  formattedKey?: string;
  icon?: string;
  key?: string;
}>;
Parameters ​
ParameterTypeDescription
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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; color?: string; descriptionI18nKey?: string; formattedKey?: string; icon?: string; key?: string; }>

projectTypes.getAllAccessibleProjectTypes ​

ts
getAllAccessibleProjectTypes: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

projectTypes.getAllProjectTypes ​

ts
getAllProjectTypes: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

projectTypes.getProjectTypeByKey ​

ts
getProjectTypeByKey: (parameters, options?) => Promise<{
[key: string]: unknown;
  color?: string;
  descriptionI18nKey?: string;
  formattedKey?: string;
  icon?: string;
  key?: string;
}>;
Parameters ​
ParameterTypeDescription
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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; color?: string; descriptionI18nKey?: string; formattedKey?: string; icon?: string; key?: string; }>

projectVersions ​

ts
projectVersions: object;

projectVersions.createRelatedWork ​

ts
createRelatedWork: (parameters, options?) => Promise<{
[key: string]: unknown;
  category: string;
  issueId?: number;
  relatedWorkId?: string;
  title?: string;
  url?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ category: string; id: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; }-
parameters.categorystringThe category of the related work
parameters.id?string-
parameters.issueId?numberThe ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API.
parameters.relatedWorkId?stringThe 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?stringThe title of the related work
parameters.url?stringThe URL of the related work. Will be null for the native release note related work item, but is otherwise required.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; category: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; }>

projectVersions.createVersion ​

ts
createVersion: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { 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?booleanIndicates that the version is archived. Optional when creating or updating a version.
parameters.description?stringThe description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
parameters.driver?stringThe 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?stringUse 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?stringThe ID of the version.
parameters.issuesStatusForFixVersion?{ done?: number; inProgress?: number; toDo?: number; unmapped?: number; }-
parameters.issuesStatusForFixVersion.done?numberCount of issues with status done.
parameters.issuesStatusForFixVersion.inProgress?numberCount of issues with status in progress.
parameters.issuesStatusForFixVersion.toDo?numberCount of issues with status to do.
parameters.issuesStatusForFixVersion.unmapped?numberCount of issues with a status other than to do, in progress, and done.
parameters.moveUnfixedIssuesTo?stringThe 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?stringThe 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?booleanIndicates that the version is overdue.
parameters.projectId?numberThe ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.
parameters.released?booleanIndicates 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?stringThe release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
parameters.self?stringThe URL of the version.
parameters.startDate?stringThe start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
parameters.userReleaseDate?stringThe date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.
parameters.userStartDate?stringThe date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
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?stringThe ID of the version.
parameters.moveAffectedIssuesTo?numberThe ID of the version to update affectedVersion to when the field contains the deleted version.
parameters.moveFixIssuesTo?numberThe ID of the version to update fixVersion to when the field contains the deleted version.
options?RequestOptions-
Returns ​

Promise<void>

projectVersions.deleteRelatedWork ​

ts
deleteRelatedWork: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ relatedWorkId: string; versionId: string; }-
parameters.relatedWorkIdstringThe ID of the related work to delete.
parameters.versionId?stringThe ID of the version that the target related work belongs to.
options?RequestOptions-
Returns ​

Promise<void>

projectVersions.getProjectVersions ​

ts
getProjectVersions: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | string & object | "operations" | (string & object | "operations")[]; projectIdOrKey: string; }-
parameters.expand?| string & object | "operations" | (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?stringThe project ID or project key (case sensitive).
options?RequestOptions-
Returns ​

Promise<object[]>

projectVersions.getProjectVersionsPaginated ​

ts
getProjectVersionsPaginated: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | string & object | "approvers" | "driver" | "operations" | "issuesstatus" | ( | 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 & object | "approvers" | "driver" | "operations" | "issuesstatus" | ( | 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?numberThe 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?stringThe project ID or project key (case sensitive).
parameters.query?stringFilter the results using a literal string. Versions with matching name or description are returned (case insensitive).
parameters.startAt?numberThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

projectVersions.getRelatedWork ​

ts
getRelatedWork: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the version.
options?RequestOptions-
Returns ​

Promise<object[]>

projectVersions.getVersion ​

ts
getVersion: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ expand?: | string & object | "approvers" | "driver" | "operations" | "issuesstatus" | ( | string & object | "approvers" | "driver" | "operations" | "issuesstatus")[]; id: string; }-
parameters.expand?| string & object | "approvers" | "driver" | "operations" | "issuesstatus" | ( | 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?stringThe ID of the version.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  customFieldUsage?: object[];
  issueCountWithCustomFieldsShowingVersion?: number;
  issuesAffectedCount?: number;
  issuesFixedCount?: number;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the version.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; customFieldUsage?: object[]; issueCountWithCustomFieldsShowingVersion?: number; issuesAffectedCount?: number; issuesFixedCount?: number; self?: string; }>

projectVersions.getVersionUnresolvedIssues ​

ts
getVersionUnresolvedIssues: (parameters, options?) => Promise<{
[key: string]: unknown;
  issuesCount?: number;
  issuesUnresolvedCount?: number;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; }-
parameters.idstringThe ID of the version.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issuesCount?: number; issuesUnresolvedCount?: number; self?: string; }>

projectVersions.mergeVersions ​

ts
mergeVersions: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; moveIssuesTo: string; }-
parameters.idstringThe ID of the version to delete.
parameters.moveIssuesTo?stringThe ID of the version to merge into.
options?RequestOptions-
Returns ​

Promise<void>

projectVersions.moveVersion ​

ts
moveVersion: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ after?: string; id: string; position?: string & object | "Earlier" | "Later" | "First" | "Last"; }-
parameters.after?stringThe URL (self link) of the version after which to place the moved version. Cannot be used with position.
parameters.id?stringThe 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.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  category: string;
  issueId?: number;
  relatedWorkId?: string;
  title?: string;
  url?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ category: string; id: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; }-
parameters.categorystringThe category of the related work
parameters.id?stringThe ID of the version to update the related work on. For the related work id, pass it to the input JSON.
parameters.issueId?numberThe ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API.
parameters.relatedWorkId?stringThe 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?stringThe title of the related work
parameters.url?stringThe URL of the related work. Will be null for the native release note related work item, but is otherwise required.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; category: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; }>

projectVersions.updateVersion ​

ts
updateVersion: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ body: { approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { 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{ approvers?: object[]; archived?: boolean; description?: string; driver?: string; expand?: string; id?: string; issuesStatusForFixVersion?: { 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?booleanIndicates that the version is archived. Optional when creating or updating a version.
parameters.body.description?stringThe description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
parameters.body.driver?stringThe 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?stringUse 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?stringThe ID of the version.
parameters.body.issuesStatusForFixVersion?{ done?: number; inProgress?: number; toDo?: number; unmapped?: number; }-
parameters.body.issuesStatusForFixVersion.done?numberCount of issues with status done.
parameters.body.issuesStatusForFixVersion.inProgress?numberCount of issues with status in progress.
parameters.body.issuesStatusForFixVersion.toDo?numberCount of issues with status to do.
parameters.body.issuesStatusForFixVersion.unmapped?numberCount of issues with a status other than to do, in progress, and done.
parameters.body.moveUnfixedIssuesTo?stringThe 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?stringThe 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?booleanIndicates that the version is overdue.
parameters.body.projectId?numberThe ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.
parameters.body.released?booleanIndicates 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?stringThe release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
parameters.body.self?stringThe URL of the version.
parameters.body.startDate?stringThe start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
parameters.body.userReleaseDate?stringThe 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?stringThe date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.
parameters.id?stringThe ID of the version.
options?RequestOptions-
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ fieldId: string; }-
parameters.fieldIdstringThe ID of the field.
options?RequestOptions-
Returns ​

Promise<void>

screens.getAvailableScreenFields ​

ts
getAvailableScreenFields: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ screenId: number; }-
parameters.screenIdnumberThe ID of the screen.
options?RequestOptions-
Returns ​

Promise<object[]>

screens.getScreens ​

ts
getScreens: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
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?numberThe 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?stringString 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?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

screens.getScreensForField ​

ts
getScreensForField: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: string & object | "tab" | (string & object | "tab")[]; fieldId: string; maxResults?: number; startAt?: number; }-
parameters.expand?string & object | "tab" | (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?stringThe ID of the field to return screens for.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  id: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ description?: string; name: string; screens: { create?: number; default: number; edit?: number; view?: number; }; }-
parameters.description?stringThe description of the screen scheme. The maximum length is 255 characters.
parameters.name?stringThe name of the screen scheme. The name must be unique. The maximum length is 255 characters.
parameters.screens?{ create?: number; default: number; edit?: number; view?: number; }-
parameters.screens.create?numberThe ID of the create screen.
parameters.screens.default?numberThe ID of the default screen. Required when creating a screen scheme.
parameters.screens.edit?numberThe ID of the edit screen.
parameters.screens.view?numberThe ID of the view screen.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id: number; }>

screenSchemes.deleteScreenScheme ​

ts
deleteScreenScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ screenSchemeId: string; }-
parameters.screenSchemeIdstringThe ID of the screen scheme.
options?RequestOptions-
Returns ​

Promise<void>

screenSchemes.getScreenSchemes ​

ts
getScreenSchemes: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | string & object | "issueTypeScreenSchemes" | (string & object | "issueTypeScreenSchemes")[]; id?: number[]; maxResults?: number; orderBy?: "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"; queryString?: string; startAt?: number; }-
parameters.expand?| string & object | "issueTypeScreenSchemes" | (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?numberThe 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?stringString used to perform a case-insensitive partial match with screen scheme name.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

screenSchemes.updateScreenScheme ​

ts
updateScreenScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ description?: string; name?: string; screens?: { create?: string; default?: string; edit?: string; view?: string; }; screenSchemeId: string; }-
parameters.description?stringThe description of the screen scheme. The maximum length is 255 characters.
parameters.name?stringThe name of the screen scheme. The name must be unique. The maximum length is 255 characters.
parameters.screens?{ create?: string; default?: string; edit?: string; view?: string; }-
parameters.screens.create?stringThe ID of the create screen. To remove the screen association, pass a null.
parameters.screens.default?stringThe ID of the default screen. When specified, must include a screen ID as a default screen is required.
parameters.screens.edit?stringThe ID of the edit screen. To remove the screen association, pass a null.
parameters.screens.view?stringThe ID of the view screen. To remove the screen association, pass a null.
parameters.screenSchemeId?stringThe ID of the screen scheme.
options?RequestOptions-
Returns ​

Promise<void>

screenTabFields ​

ts
screenTabFields: object;

screenTabFields.addScreenTabField ​

ts
addScreenTabField: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  name?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ fieldId: string; screenId: number; skipFieldAssociation?: boolean; tabId: number; }-
parameters.fieldIdstringThe ID of the field to add.
parameters.screenId?numberThe ID of the screen.
parameters.skipFieldAssociation?boolean-
parameters.tabId?numberThe ID of the screen tab.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id?: string; name?: string; }>

screenTabFields.getAllScreenTabFields ​

ts
getAllScreenTabFields: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ projectKey?: string; screenId: number; tabId: number; }-
parameters.projectKey?stringThe key of the project.
parameters.screenId?numberThe ID of the screen.
parameters.tabId?numberThe ID of the screen tab.
options?RequestOptions-
Returns ​

Promise<object[]>

screenTabFields.moveScreenTabField ​

ts
moveScreenTabField: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ after?: string; id: string; position?: string & object | "Earlier" | "Later" | "First" | "Last"; screenId: number; tabId: number; }-
parameters.after?stringThe ID of the screen tab field after which to place the moved screen tab field. Required if position isn't provided.
parameters.id?stringThe 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?numberThe ID of the screen.
parameters.tabId?numberThe ID of the screen tab.
options?RequestOptions-
Returns ​

Promise<void>

screenTabFields.removeScreenTabField ​

ts
removeScreenTabField: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; screenId: number; tabId: number; }-
parameters.idstringThe ID of the field.
parameters.screenId?numberThe ID of the screen.
parameters.tabId?numberThe ID of the screen tab.
options?RequestOptions-
Returns ​

Promise<void>

screenTabs ​

ts
screenTabs: object;

screenTabs.addScreenTab ​

ts
addScreenTab: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: number;
  name: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id?: number; name: string; screenId: number; }-
parameters.id?numberThe ID of the screen tab.
parameters.name?stringThe name of the screen tab. The maximum length is 255 characters.
parameters.screenId?numberThe ID of the screen.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id?: number; name: string; }>

screenTabs.deleteScreenTab ​

ts
deleteScreenTab: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ screenId: number; tabId: number; }-
parameters.screenIdnumberThe ID of the screen.
parameters.tabId?numberThe ID of the screen tab.
options?RequestOptions-
Returns ​

Promise<void>

screenTabs.getAllScreenTabs ​

ts
getAllScreenTabs: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ projectKey?: string; screenId: number; }-
parameters.projectKey?stringThe key of the project.
parameters.screenId?numberThe ID of the screen.
options?RequestOptions-
Returns ​

Promise<object[]>

screenTabs.moveScreenTab ​

ts
moveScreenTab: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ pos: number; screenId: number; tabId: number; }-
parameters.posnumberThe position of tab. The base index is 0.
parameters.screenId?numberThe ID of the screen.
parameters.tabId?numberThe ID of the screen tab.
options?RequestOptions-
Returns ​

Promise<void>

screenTabs.renameScreenTab ​

ts
renameScreenTab: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: number;
  name: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id?: number; name: string; screenId: number; tabId: number; }-
parameters.id?numberThe ID of the screen tab.
parameters.name?stringThe name of the screen tab. The maximum length is 255 characters.
parameters.screenId?numberThe ID of the screen.
parameters.tabId?numberThe ID of the screen tab.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id?: number; name: string; }>

serverInfo ​

ts
serverInfo: object;

serverInfo.getServerInfo ​

ts
getServerInfo: (options?) => 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[];
}>;
Parameters ​
ParameterType
options?RequestOptions
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, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ scope: { project?: { id: string; }; type: string & object | "PROJECT" | "GLOBAL"; }; statuses: object[]; }-
parameters.scope{ project?: { id: string; }; type: string & object | "PROJECT" | "GLOBAL"; }-
parameters.scope.project?{ id: string; }-
parameters.scope.project.id?stringThe 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.
options?RequestOptions-
Returns ​

Promise<object[]>

status.deleteStatusesById ​

ts
deleteStatusesById: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: string[]; }-
parameters.idstring[]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
options?RequestOptions-
Returns ​

Promise<void>

status.getProjectIssueTypeUsagesForStatus ​

ts
getProjectIssueTypeUsagesForStatus: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueTypes?: {
   [key: string]: unknown;
     nextPageToken?: string | null;
     values?: object[];
  };
  projectId?: string;
  statusId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; nextPageToken?: string; projectId: string; statusId: string; }-
parameters.maxResults?numberThe maximum number of results to return. Must be an integer between 1 and 200.
parameters.nextPageToken?stringThe cursor for pagination
parameters.projectId?stringThe projectId to fetch issue type usages for
parameters.statusId?stringThe statusId to fetch issue type usages for
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issueTypes?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; projectId?: string; statusId?: string; }>

status.getProjectUsagesForStatus ​

ts
getProjectUsagesForStatus: (parameters, options?) => Promise<{
[key: string]: unknown;
  projects?: {
   [key: string]: unknown;
     nextPageToken?: string | null;
     values?: object[];
  };
  statusId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; nextPageToken?: string; statusId: string; }-
parameters.maxResults?numberThe maximum number of results to return. Must be an integer between 1 and 200.
parameters.nextPageToken?stringThe cursor for pagination
parameters.statusId?stringThe statusId to fetch project usages for
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; projects?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; statusId?: string; }>

status.getStatusesById ​

ts
getStatusesById: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ id: string[]; }-
parameters.idstring[]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
options?RequestOptions-
Returns ​

Promise<object[]>

status.getStatusesByName ​

ts
getStatusesByName: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ name: string[]; projectId?: string; }-
parameters.namestring[]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?stringThe project the status is part of or null for global statuses.
options?RequestOptions-
Returns ​

Promise<object[]>

status.getWorkflowUsagesForStatus ​

ts
getWorkflowUsagesForStatus: (parameters, options?) => Promise<{
[key: string]: unknown;
  statusId?: string;
  workflows?: {
   [key: string]: unknown;
     nextPageToken?: string | null;
     values?: object[];
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; nextPageToken?: string; statusId: string; }-
parameters.maxResults?numberThe maximum number of results to return. Must be an integer between 1 and 200.
parameters.nextPageToken?stringThe cursor for pagination
parameters.statusId?stringThe statusId to fetch workflow usages for
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; statusId?: string; workflows?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; }>

ts
search: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextPage?: string;
  self?: string;
  startAt?: number;
  total?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ includeGlobalStatuses?: boolean; maxResults?: number; projectId?: string; searchString?: string; startAt?: number; statusCategory?: string; }-
parameters.includeGlobalStatuses?booleanWhether 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?numberThe maximum number of items to return per page.
parameters.projectId?stringThe project the status is part of or null for global statuses.
parameters.searchString?stringTerm to match status names against or null to search for all statuses in the search scope.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
parameters.statusCategory?stringCategory of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>

Deprecated ​

Renamed to searchStatuses, which calls the same endpoint. This alias is removed in the next major version.

status.searchStatuses ​

ts
searchStatuses: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextPage?: string;
  self?: string;
  startAt?: number;
  total?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ includeGlobalStatuses?: boolean; maxResults?: number; projectId?: string; searchString?: string; startAt?: number; statusCategory?: string; }-
parameters.includeGlobalStatuses?booleanWhether 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?numberThe maximum number of items to return per page.
parameters.projectId?stringThe project the status is part of or null for global statuses.
parameters.searchString?stringTerm to match status names against or null to search for all statuses in the search scope.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
parameters.statusCategory?stringCategory of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: object[]; }>

status.updateStatuses ​

ts
updateStatuses: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ statuses: object[]; }-
parameters.statusesobject[]The list of statuses that will be updated.
options?RequestOptions-
Returns ​

Promise<void>

tasks ​

ts
tasks: object;

tasks.getTask ​

ts
getTask: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ taskId: string; }-
parameters.taskIdstringThe ID of the task.
options?RequestOptions-
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: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

timeTracking.getSelectedTimeTrackingImplementation ​

ts
getSelectedTimeTrackingImplementation: (options?) => Promise<void>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<void>

timeTracking.getSharedTimeTrackingConfiguration ​

ts
getSharedTimeTrackingConfiguration: (options?) => Promise<{
[key: string]: unknown;
  defaultUnit: "day" | "hour" | "minute" | "week" | string & object;
  timeFormat: "days" | "hours" | string & object | "pretty";
  workingDaysPerWeek: number;
  workingHoursPerDay: number;
}>;
Parameters ​
ParameterType
options?RequestOptions
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, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ key: string; name?: string; url?: string; }-
parameters.keystringThe key for the time tracking provider. For example, JIRA.
parameters.name?stringThe name of the time tracking provider. For example, JIRA provided time tracking.
parameters.url?stringThe 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.
options?RequestOptions-
Returns ​

Promise<void>

timeTracking.setSharedTimeTrackingConfiguration ​

ts
setSharedTimeTrackingConfiguration: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultUnit: "day" | "hour" | "minute" | "week" | string & object;
  timeFormat: "days" | "hours" | string & object | "pretty";
  workingDaysPerWeek: number;
  workingHoursPerDay: number;
}>;
Parameters ​
ParameterTypeDescription
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 & objectThe 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?numberThe number of days in a working week.
parameters.workingHoursPerDay?numberThe number of hours in a working day.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  id: string;
  self: string;
}>;
Parameters ​
ParameterTypeDescription
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?stringThe data of the UI modification. The maximum size of the data is 50000 characters.
parameters.description?stringThe description of the UI modification. The maximum length is 255 characters.
parameters.name?stringThe name of the UI modification. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; id: string; self: string; }>

uiModificationsApps.deleteUiModification ​

ts
deleteUiModification: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ uiModificationId: string; }-
parameters.uiModificationIdstringThe ID of the UI modification.
options?RequestOptions-
Returns ​

Promise<void>

uiModificationsApps.getUiModifications ​

ts
getUiModifications: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | "data" | string & object | "contexts" | ("data" | string & object | "contexts")[]; maxResults?: number; startAt?: number; }-
parameters.expand?| "data" | string & object | "contexts" | ("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?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

uiModificationsApps.updateUiModification ​

ts
updateUiModification: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
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?stringThe data of the UI modification. The maximum size of the data is 50000 characters.
parameters.description?stringThe description of the UI modification. The maximum length is 255 characters.
parameters.name?stringThe name of the UI modification. The maximum length is 255 characters.
parameters.uiModificationId?stringThe ID of the UI modification.
options?RequestOptions-
Returns ​

Promise<void>

userProperties ​

ts
userProperties: object;

userProperties.deleteUserProperty ​

ts
deleteUserProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string; propertyKey: string; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.propertyKey?stringThe key of the user's property.
options?RequestOptions-
Returns ​

Promise<void>

userProperties.getUserProperty ​

ts
getUserProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string; propertyKey: string; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.propertyKey?stringThe key of the user's property.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

userProperties.getUserPropertyKeys ​

ts
getUserPropertyKeys: (parameters?, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ accountId?: string; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>

userProperties.setUserProperty ​

ts
setUserProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string; body: Record<string, any>; propertyKey: string; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.body?Record<string, any>-
parameters.propertyKey?stringThe key of the user's property. The maximum length is 255 characters.
options?RequestOptions-
Returns ​

Promise<void>

users ​

ts
users: object;

users.createUser ​

ts
createUser: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ emailAddress: string; products: string[]; self?: string; }-
parameters.emailAddressstringThe 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?stringThe URL of the user.
options?RequestOptions-
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?, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: string; maxResults?: number; startAt?: number; }-
parameters.expand?string-
parameters.maxResults?numberThe maximum number of items to return (limited to 1000).
parameters.startAt?numberThe index of the first item to return.
options?RequestOptions-
Returns ​

Promise<object[]>

users.getAllUsersDefault ​

ts
getAllUsersDefault: (parameters?, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: string; maxResults?: number; startAt?: number; }-
parameters.expand?string-
parameters.maxResults?numberThe maximum number of items to return (limited to 1000).
parameters.startAt?numberThe index of the first item to return.
options?RequestOptions-
Returns ​

Promise<object[]>

users.getUser ​

ts
getUser: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ accountId: string; expand?: | "groups" | string & object | "applicationRoles" | ("groups" | string & object | "applicationRoles")[]; }-
parameters.accountIdstringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required.
parameters.expand?| "groups" | string & object | "applicationRoles" | ("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.
options?RequestOptions-
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?, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters?{ accountId?: string; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
options?RequestOptions-
Returns ​

Promise<object[]>

users.getUserEmail ​

ts
getUserEmail: (parameters, options?) => Promise<{
[key: string]: unknown;
  accountId?: string;
  email?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; }-
parameters.accountIdstringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; accountId?: string; email?: string; }>

users.getUserEmailBulk ​

ts
getUserEmailBulk: (parameters, options?) => Promise<{
[key: string]: unknown;
  accountId?: string;
  email?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string[]; }-
parameters.accountIdstring[]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).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; accountId?: string; email?: string; }>

users.getUserGroups ​

ts
getUserGroups: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; }-
parameters.accountIdstringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
options?RequestOptions-
Returns ​

Promise<object[]>

users.removeUser ​

ts
removeUser: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; }-
parameters.accountIdstringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
options?RequestOptions-
Returns ​

Promise<void>

users.resetUserColumns ​

ts
resetUserColumns: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
options?RequestOptions-
Returns ​

Promise<void>

users.setUserColumns ​

ts
setUserColumns: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string; columns?: string[]; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.columns?string[]-
options?RequestOptions-
Returns ​

Promise<void>

userSearch ​

ts
userSearch: object;

userSearch.findAssignableUsers ​

ts
findAssignableUsers: (parameters?, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
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?stringA query string that is matched exactly against user accountId. Required, unless query is specified.
parameters.accountType?string[]-
parameters.actionDescriptorId?numberThe ID of the transition.
parameters.appType?string[]-
parameters.issueId?stringThe ID of the issue. Required, unless issueKey or project is specified.
parameters.issueKey?stringThe key of the issue. Required, unless issueId or project is specified.
parameters.maxResults?numberThe 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?stringThe project ID or project key (case sensitive). Required, unless issueKey or issueId is specified.
parameters.query?stringA 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?stringThe sessionId of this request. SessionId is the same until the assignee is set.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<object[]>

userSearch.findBulkAssignableUsers ​

ts
findBulkAssignableUsers: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string; maxResults?: number; projectKeys: string | string[]; query?: string; startAt?: number; }-
parameters.accountId?stringA query string that is matched exactly against user accountId. Required, unless query is specified.
parameters.maxResults?numberThe 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?stringA 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?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<object[]>

userSearch.findUserKeysByQuery ​

ts
findUserKeysByQuery: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResult?: number; query: string; startAt?: number; }-
parameters.maxResult?numberThe maximum number of items to return per page.
parameters.query?stringThe search query.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

userSearch.findUsers ​

ts
findUsers: (parameters?, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters?{ accountId?: string; maxResults?: number; property?: string; query?: string; startAt?: number; username?: string; }-
parameters.accountId?stringA query string that is matched exactly against a user accountId. Required, unless query or property is specified.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.property?stringA 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?stringA 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?numberThe index of the first item to return in a page of filtered results (page offset).
parameters.username?string-
options?RequestOptions-
Returns ​

Promise<object[]>

userSearch.findUsersByQuery ​

ts
findUsersByQuery: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; query: string; startAt?: number; }-
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.query?stringThe search query.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

userSearch.findUsersForPicker ​

ts
findUsersForPicker: (parameters, options?) => Promise<{
[key: string]: unknown;
  header?: string;
  total?: number;
  users?: object[];
}>;
Parameters ​
ParameterTypeDescription
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?numberThe maximum number of items to return. The total number of matched users is returned in total.
parameters.query?stringA 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?booleanInclude the URI to the user's avatar.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; header?: string; total?: number; users?: object[]; }>

userSearch.findUsersWithAllPermissions ​

ts
findUsersWithAllPermissions: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string; issueKey?: string; maxResults?: number; permissions: string; projectKey?: string; query?: string; startAt?: number; }-
parameters.accountId?stringA query string that is matched exactly against user accountId. Required, unless query is specified.
parameters.issueKey?stringThe issue key for the issue.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.permissions?stringA 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?stringThe project key for the project (case sensitive).
parameters.query?stringA 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?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<object[]>

userSearch.findUsersWithBrowsePermission ​

ts
findUsersWithBrowsePermission: (parameters?, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters?{ accountId?: string; issueKey?: string; maxResults?: number; projectKey?: string; query?: string; startAt?: number; }-
parameters.accountId?stringA query string that is matched exactly against user accountId. Required, unless query is specified.
parameters.issueKey?stringThe issue key for the issue. Required, unless projectKey is specified.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.projectKey?stringThe project key for the project (case sensitive). Required, unless issueKey is specified.
parameters.query?stringA 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?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<object[]>

webhooks ​

ts
webhooks: object;

webhooks.deleteWebhookById ​

ts
deleteWebhookById: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ webhookIds: number[]; }-
parameters.webhookIdsnumber[]A list of webhook IDs.
options?RequestOptions-
Returns ​

Promise<void>

webhooks.getDynamicWebhooksForApp ​

ts
getDynamicWebhooksForApp: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ maxResults?: number; startAt?: number; }-
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

webhooks.refreshWebhooks ​

ts
refreshWebhooks: (parameters, options?) => Promise<{
[key: string]: unknown;
  expirationDate: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ webhookIds: number[]; }-
parameters.webhookIdsnumber[]A list of webhook IDs.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; expirationDate: number; }>

webhooks.registerDynamicWebhooks ​

ts
registerDynamicWebhooks: (parameters, options?) => Promise<{
[key: string]: unknown;
  webhookRegistrationResult?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ url: string; webhooks: object[]; }-
parameters.urlstringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; webhookRegistrationResult?: object[]; }>

workflows ​

ts
workflows: object;

workflows.copyWorkflow ​

ts
copyWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  statuses?: object[];
  workflows?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ description?: string; workflowId: string; workflowName: string; }-
parameters.description?stringThe description of the new workflow to create. Defaults to an empty description.
parameters.workflowId?stringThe ID of the workflow to copy.
parameters.workflowName?stringThe name of the new workflow to create.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>

workflows.createWorkflows ​

ts
createWorkflows: (parameters, options?) => Promise<{
[key: string]: unknown;
  statuses?: object[];
  workflows?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ scope?: { project?: { id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }; statuses?: object[]; workflows?: object[]; }-
parameters.scope?{ project?: { id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }-
parameters.scope.project?{ id: string; }-
parameters.scope.project.id?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>

workflows.deleteInactiveWorkflow ​

ts
deleteInactiveWorkflow: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ entityId: string; }-
parameters.entityIdstringThe entity ID of the workflow.
options?RequestOptions-
Returns ​

Promise<void>

workflows.getDefaultEditor ​

ts
getDefaultEditor: (options?) => Promise<{
[key: string]: unknown;
  value?: string & object | "NEW" | "LEGACY";
}>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; value?: string & object | "NEW" | "LEGACY"; }>

workflows.getProjectUsagesForWorkflow ​

ts
getProjectUsagesForWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  projects?: {
   [key: string]: unknown;
     nextPageToken?: string | null;
     values?: object[];
  };
  workflowId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; nextPageToken?: string; workflowId: string; }-
parameters.maxResults?numberThe maximum number of results to return. Must be an integer between 1 and 200.
parameters.nextPageToken?stringThe cursor for pagination
parameters.workflowId?stringThe workflow ID
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; projects?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; workflowId?: string; }>

workflows.getWorkflowProjectIssueTypeUsages ​

ts
getWorkflowProjectIssueTypeUsages: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueTypes?: {
   [key: string]: unknown;
     nextPageToken?: string | null;
     values?: object[];
  };
  projectId?: string;
  workflowId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; nextPageToken?: string; projectId: number; workflowId: string; }-
parameters.maxResults?numberThe maximum number of results to return. Must be an integer between 1 and 200.
parameters.nextPageToken?stringThe cursor for pagination
parameters.projectId?numberThe project ID
parameters.workflowId?stringThe workflow ID
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issueTypes?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; projectId?: string; workflowId?: string; }>

workflows.getWorkflowSchemeUsagesForWorkflow ​

ts
getWorkflowSchemeUsagesForWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  workflowId?: string;
  workflowSchemes?: {
   [key: string]: unknown;
     nextPageToken?: string | null;
     values?: object[];
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; nextPageToken?: string; workflowId: string; }-
parameters.maxResults?numberThe maximum number of results to return. Must be an integer between 1 and 200.
parameters.nextPageToken?stringThe cursor for pagination
parameters.workflowId?stringThe workflow ID
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; workflowId?: string; workflowSchemes?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; }>

workflows.listWorkflowHistory ​

ts
listWorkflowHistory: (parameters, options?) => Promise<{
[key: string]: unknown;
  entries?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: | string & object | "includeIntermediateWorkflows" | (string & object | "includeIntermediateWorkflows")[]; workflowId?: string; }-
parameters.expand?| string & object | "includeIntermediateWorkflows" | (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?stringThe id of the workflow to read the history for.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; entries?: object[]; }>

workflows.readWorkflowFromHistory ​

ts
readWorkflowFromHistory: (parameters, options?) => Promise<{
[key: string]: unknown;
  statuses?: object[];
  workflows?: object[];
}>;
Parameters ​
ParameterType
parameters{ version?: number; workflowId?: string; }
parameters.version?number
parameters.workflowId?string
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>

workflows.readWorkflowPreviews ​

ts
readWorkflowPreviews: (parameters, options?) => Promise<{
[key: string]: unknown;
  statuses?: object[];
  workflows?: object[];
}>;
Parameters ​
ParameterTypeDescription
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?stringThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>

workflows.readWorkflows ​

ts
readWorkflows: (parameters, options?) => Promise<{
[key: string]: unknown;
  statuses?: object[];
  workflows?: object[];
}>;
Parameters ​
ParameterTypeDescription
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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>

workflows.searchWorkflows ​

ts
searchWorkflows: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextPage?: string;
  self?: string;
  startAt?: number;
  statuses?: object[];
  total?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: | string & object | "values.transitions" | (string & object | "values.transitions")[]; isActive?: boolean; maxResults?: number; orderBy?: | "name" | string & object | "created" | "updated" | "-created" | "+created" | "-name" | "+name" | "-updated" | "+updated"; projectId?: number; queryString?: string; scope?: string; startAt?: number; }-
parameters.expand?| string & object | "values.transitions" | (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?booleanFilters active and inactive workflows.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.orderBy?| "name" | string & object | "created" | "updated" | "-created" | "+created" | "-name" | "+name" | "-updated" | "+updated"Order the results by a field: - name Sorts by workflow name. - created Sorts by create time. - updated Sorts by update time.
parameters.projectId?numberThe ID of the project to filter the workflows by. Only workflows associated with the given project are returned.
parameters.queryString?stringString used to perform a case-insensitive partial match with workflow name.
parameters.scope?stringThe scope of the workflow. Global for company-managed projects and Project for team-managed projects.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  statuses?: object[];
  taskId?: string | null;
  workflows?: object[];
}>;
Parameters ​
ParameterTypeDescription
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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; statuses?: object[]; taskId?: string | null; workflows?: object[]; }>

workflows.validateCreateWorkflows ​

ts
validateCreateWorkflows: (parameters, options?) => Promise<{
[key: string]: unknown;
  errors?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ payload: { scope?: { project?: { id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }; statuses?: object[]; workflows?: object[]; }; validationOptions?: { levels?: (string & object | "WARNING" | "ERROR")[]; }; }-
parameters.payload{ scope?: { project?: { id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }; statuses?: object[]; workflows?: object[]; }-
parameters.payload.scope?{ project?: { id: string; }; type?: string & object | "PROJECT" | "GLOBAL"; }-
parameters.payload.scope.project?{ id: string; }-
parameters.payload.scope.project.id?stringThe 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?{ levels?: (string & object | "WARNING" | "ERROR")[]; }-
parameters.validationOptions.levels?(string & object | "WARNING" | "ERROR")[]-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; errors?: object[]; }>

workflows.validateUpdateWorkflows ​

ts
validateUpdateWorkflows: (parameters, options?) => Promise<{
[key: string]: unknown;
  errors?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ payload: { statuses?: object[]; workflows?: object[]; }; validationOptions?: { levels?: (string & object | "WARNING" | "ERROR")[]; }; }-
parameters.payload{ 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?{ levels?: (string & object | "WARNING" | "ERROR")[]; }-
parameters.validationOptions.levels?(string & object | "WARNING" | "ERROR")[]-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; errors?: object[]; }>

workflows.workflowCapabilities ​

ts
workflowCapabilities: (parameters?, options?) => 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 ​
ParameterType
parameters?{ issueTypeId?: string; projectId?: string; workflowId?: string; }
parameters.issueTypeId?string
parameters.projectId?string
parameters.workflowId?string
options?RequestOptions
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, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the active workflow scheme that the draft is created from.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemeDrafts.deleteDraftDefaultWorkflow ​

ts
deleteDraftDefaultWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the workflow scheme that the draft belongs to.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemeDrafts.deleteDraftWorkflowMapping ​

ts
deleteDraftWorkflowMapping: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; workflowName: string; }-
parameters.idnumberThe ID of the workflow scheme that the draft belongs to.
parameters.workflowName?stringThe name of the workflow.
options?RequestOptions-
Returns ​

Promise<void>

workflowSchemeDrafts.deleteWorkflowSchemeDraft ​

ts
deleteWorkflowSchemeDraft: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the active workflow scheme that the draft was created from.
options?RequestOptions-
Returns ​

Promise<void>

workflowSchemeDrafts.deleteWorkflowSchemeDraftIssueType ​

ts
deleteWorkflowSchemeDraftIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; issueType: string; }-
parameters.idnumberThe ID of the workflow scheme that the draft belongs to.
parameters.issueType?stringThe ID of the issue type.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemeDrafts.getDraftDefaultWorkflow ​

ts
getDraftDefaultWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  updateDraftIfNeeded?: boolean;
  workflow: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the workflow scheme that the draft belongs to.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; updateDraftIfNeeded?: boolean; workflow: string; }>

workflowSchemeDrafts.getDraftWorkflow ​

ts
getDraftWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultMapping?: boolean;
  issueTypes?: string[];
  updateDraftIfNeeded?: boolean;
  workflow?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; workflowName?: string; }-
parameters.idnumberThe ID of the workflow scheme that the draft belongs to.
parameters.workflowName?stringThe name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultMapping?: boolean; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; }>

workflowSchemeDrafts.getWorkflowSchemeDraft ​

ts
getWorkflowSchemeDraft: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe ID of the active workflow scheme that the draft was created from.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemeDrafts.getWorkflowSchemeDraftIssueType ​

ts
getWorkflowSchemeDraftIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueType?: string;
  updateDraftIfNeeded?: boolean;
  workflow?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; issueType: string; }-
parameters.idnumberThe ID of the workflow scheme that the draft belongs to.
parameters.issueType?stringThe ID of the issue type.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }>

workflowSchemeDrafts.publishDraftWorkflowScheme ​

ts
publishDraftWorkflowScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; statusMappings?: object[]; validateOnly?: boolean; }-
parameters.idnumberThe ID of the workflow scheme that the draft belongs to.
parameters.statusMappings?object[]Mappings of statuses to new statuses for issue types.
parameters.validateOnly?booleanWhether the request only performs a validation.
options?RequestOptions-
Returns ​

Promise<void>

workflowSchemeDrafts.setWorkflowSchemeDraftIssueType ​

ts
setWorkflowSchemeDraftIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: { issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }; id: number; issueType: string; }-
parameters.body{ issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }-
parameters.body.issueType?stringThe ID of the issue type. Not required if updating the issue type-workflow mapping.
parameters.body.updateDraftIfNeeded?booleanSet 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?stringThe name of the workflow.
parameters.id?numberThe ID of the workflow scheme that the draft belongs to.
parameters.issueType?stringThe ID of the issue type.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemeDrafts.updateDraftDefaultWorkflow ​

ts
updateDraftDefaultWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; updateDraftIfNeeded?: boolean; workflow: string; }-
parameters.idnumberThe ID of the workflow scheme that the draft belongs to.
parameters.updateDraftIfNeeded?booleanWhether 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?stringThe name of the workflow to set as the default workflow.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemeDrafts.updateDraftWorkflowMapping ​

ts
updateDraftWorkflowMapping: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ defaultMapping?: boolean; id: number; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; workflowName: string; }-
parameters.defaultMapping?booleanWhether the workflow is the default workflow for the workflow scheme.
parameters.id?numberThe ID of the workflow scheme that the draft belongs to.
parameters.issueTypes?string[]The list of issue type IDs.
parameters.updateDraftIfNeeded?booleanWhether 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?stringThe name of the workflow. Optional if updating the workflow-issue types mapping.
parameters.workflowName?stringThe name of the workflow.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemeDrafts.updateWorkflowSchemeDraft ​

ts
updateWorkflowSchemeDraft: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: { defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; lastModified?: string; lastModifiedUser?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, string>; self?: string; updateDraftIfNeeded?: boolean; }; id: number; }-
parameters.body{ defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; lastModified?: string; lastModifiedUser?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, string>; self?: string; updateDraftIfNeeded?: boolean; }-
parameters.body.defaultWorkflow?stringThe 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?stringThe description of the workflow scheme.
parameters.body.draft?booleanWhether the workflow scheme is a draft or not.
parameters.body.id?numberThe ID of the workflow scheme.
parameters.body.issueTypeMappings?Record<string, string>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, { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>The issue types available in Jira.
parameters.body.lastModified?stringThe 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?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.body.lastModifiedUser.accountId?stringThe 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?booleanWhether the user is active.
parameters.body.lastModifiedUser.applicationRoles?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.lastModifiedUser.applicationRoles.callback?Record<..., ...>-
parameters.body.lastModifiedUser.applicationRoles.items?...[]-
parameters.body.lastModifiedUser.applicationRoles.max-results?number-
parameters.body.lastModifiedUser.applicationRoles.pagingCallback?Record<..., ...>-
parameters.body.lastModifiedUser.applicationRoles.size?number-
parameters.body.lastModifiedUser.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.lastModifiedUser.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.lastModifiedUser.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.lastModifiedUser.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.lastModifiedUser.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.lastModifiedUser.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.body.lastModifiedUser.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.lastModifiedUser.expand?stringExpand options that include additional user details in the response.
parameters.body.lastModifiedUser.groups?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.lastModifiedUser.groups.callback?Record<..., ...>-
parameters.body.lastModifiedUser.groups.items?...[]-
parameters.body.lastModifiedUser.groups.max-results?number-
parameters.body.lastModifiedUser.groups.pagingCallback?Record<..., ...>-
parameters.body.lastModifiedUser.groups.size?number-
parameters.body.lastModifiedUser.guest?booleanWhether the user is a guest.
parameters.body.lastModifiedUser.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.lastModifiedUser.self?stringThe URL of the user.
parameters.body.lastModifiedUser.timeZone?stringThe 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?stringThe 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?stringFor 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, string>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?booleanWhether 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?numberThe ID of the active workflow scheme that the draft was created from.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemeProjectAssociations ​

ts
workflowSchemeProjectAssociations: object;

workflowSchemeProjectAssociations.assignSchemeToProject ​

ts
assignSchemeToProject: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ projectId: string; workflowSchemeId?: string; }-
parameters.projectIdstringThe ID of the project.
parameters.workflowSchemeId?stringThe ID of the workflow scheme. If the workflow scheme ID is null, the operation assigns the default workflow scheme.
options?RequestOptions-
Returns ​

Promise<void>

workflowSchemeProjectAssociations.getWorkflowSchemeProjectAssociations ​

ts
getWorkflowSchemeProjectAssociations: (parameters, options?) => Promise<{
[key: string]: unknown;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ projectId: number[]; }-
parameters.projectIdnumber[]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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; values: object[]; }>

workflowSchemes ​

ts
workflowSchemes: object;

workflowSchemes.createWorkflowScheme ​

ts
createWorkflowScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: { avatarUrls?: ...; id?: ...; key?: ...; name?: ...; projectCategory?: ...; projectTypeKey?: ...; self?: ...; simplified?: ...; }; type?: ... & ... | "PROJECT" | "TEMPLATE"; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; lastModified?: string; lastModifiedUser?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, string>; self?: string; updateDraftIfNeeded?: boolean; }-
parameters.defaultWorkflow?stringThe 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?stringThe description of the workflow scheme.
parameters.draft?booleanWhether the workflow scheme is a draft or not.
parameters.id?numberThe ID of the workflow scheme.
parameters.issueTypeMappings?Record<string, string>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, { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: { avatarUrls?: ...; id?: ...; key?: ...; name?: ...; projectCategory?: ...; projectTypeKey?: ...; self?: ...; simplified?: ...; }; type?: ... & ... | "PROJECT" | "TEMPLATE"; }; self?: string; subtask?: boolean; untranslatedName?: string; }>The issue types available in Jira.
parameters.lastModified?stringThe 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?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.lastModifiedUser.accountId?stringThe 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?booleanWhether the user is active.
parameters.lastModifiedUser.applicationRoles?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.lastModifiedUser.applicationRoles.callback?Record<string, never>-
parameters.lastModifiedUser.applicationRoles.items?object[]-
parameters.lastModifiedUser.applicationRoles.max-results?number-
parameters.lastModifiedUser.applicationRoles.pagingCallback?Record<string, never>-
parameters.lastModifiedUser.applicationRoles.size?number-
parameters.lastModifiedUser.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.lastModifiedUser.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.lastModifiedUser.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.lastModifiedUser.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.lastModifiedUser.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.lastModifiedUser.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.lastModifiedUser.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.lastModifiedUser.expand?stringExpand options that include additional user details in the response.
parameters.lastModifiedUser.groups?{ callback?: Record<string, never>; items?: object[]; max-results?: number; pagingCallback?: Record<string, never>; size?: number; }-
parameters.lastModifiedUser.groups.callback?Record<string, never>-
parameters.lastModifiedUser.groups.items?object[]-
parameters.lastModifiedUser.groups.max-results?number-
parameters.lastModifiedUser.groups.pagingCallback?Record<string, never>-
parameters.lastModifiedUser.groups.size?number-
parameters.lastModifiedUser.guest?booleanWhether the user is a guest.
parameters.lastModifiedUser.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.lastModifiedUser.self?stringThe URL of the user.
parameters.lastModifiedUser.timeZone?stringThe 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?stringThe name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.
parameters.originalDefaultWorkflow?stringFor 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, string>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?booleanWhether 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemes.deleteDefaultWorkflow ​

ts
deleteDefaultWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; updateDraftIfNeeded?: boolean; }-
parameters.idnumberThe ID of the workflow scheme.
parameters.updateDraftIfNeeded?booleanSet 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemes.deleteWorkflowMapping ​

ts
deleteWorkflowMapping: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; updateDraftIfNeeded?: boolean; workflowName: string; }-
parameters.idnumberThe ID of the workflow scheme.
parameters.updateDraftIfNeeded?booleanSet 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?stringThe name of the workflow.
options?RequestOptions-
Returns ​

Promise<void>

workflowSchemes.deleteWorkflowScheme ​

ts
deleteWorkflowScheme: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; }-
parameters.idnumberThe 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.
options?RequestOptions-
Returns ​

Promise<void>

workflowSchemes.deleteWorkflowSchemeIssueType ​

ts
deleteWorkflowSchemeIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; issueType: string; updateDraftIfNeeded?: boolean; }-
parameters.idnumberThe ID of the workflow scheme.
parameters.issueType?stringThe ID of the issue type.
parameters.updateDraftIfNeeded?booleanSet 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemes.getAllWorkflowSchemes ​

ts
getAllWorkflowSchemes: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ maxResults?: number; startAt?: number; }-
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

workflowSchemes.getDefaultWorkflow ​

ts
getDefaultWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  updateDraftIfNeeded?: boolean;
  workflow: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; returnDraftIfExists?: boolean; }-
parameters.idnumberThe ID of the workflow scheme.
parameters.returnDraftIfExists?booleanSet 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; updateDraftIfNeeded?: boolean; workflow: string; }>

workflowSchemes.getProjectUsagesForWorkflowScheme ​

ts
getProjectUsagesForWorkflowScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  projects?: {
   [key: string]: unknown;
     nextPageToken?: string | null;
     values?: object[];
  };
  workflowSchemeId?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ maxResults?: number; nextPageToken?: string; workflowSchemeId: string; }-
parameters.maxResults?numberThe maximum number of results to return. Must be an integer between 1 and 200.
parameters.nextPageToken?stringThe cursor for pagination
parameters.workflowSchemeId?stringThe workflow scheme ID
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; projects?: { [key: string]: unknown; nextPageToken?: string | null; values?: object[]; }; workflowSchemeId?: string; }>

workflowSchemes.getRequiredWorkflowSchemeMappings ​

ts
getRequiredWorkflowSchemeMappings: (parameters, options?) => Promise<{
[key: string]: unknown;
  statuses?: object[];
  statusesPerWorkflow?: object[];
  statusMappingsByIssueTypes?: object[];
  statusMappingsByWorkflows?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ defaultWorkflowId?: string | null; id: string; workflowsForIssueTypes: object[]; }-
parameters.defaultWorkflowId?string | nullThe 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?stringThe ID of the workflow scheme.
parameters.workflowsForIssueTypes?object[]The new workflow to issue type mappings for this workflow scheme.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; statuses?: object[]; statusesPerWorkflow?: object[]; statusMappingsByIssueTypes?: object[]; statusMappingsByWorkflows?: object[]; }>

workflowSchemes.getWorkflow ​

ts
getWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultMapping?: boolean;
  issueTypes?: string[];
  updateDraftIfNeeded?: boolean;
  workflow?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; returnDraftIfExists?: boolean; workflowName?: string; }-
parameters.idnumberThe ID of the workflow scheme.
parameters.returnDraftIfExists?booleanReturns 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?stringThe name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultMapping?: boolean; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; }>

workflowSchemes.getWorkflowScheme ​

ts
getWorkflowScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; returnDraftIfExists?: boolean; }-
parameters.idnumberThe 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?booleanReturns 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemes.getWorkflowSchemeIssueType ​

ts
getWorkflowSchemeIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueType?: string;
  updateDraftIfNeeded?: boolean;
  workflow?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; issueType: string; returnDraftIfExists?: boolean; }-
parameters.idnumberThe ID of the workflow scheme.
parameters.issueType?stringThe ID of the issue type.
parameters.returnDraftIfExists?booleanReturns 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }>

workflowSchemes.readWorkflowSchemes ​

ts
readWorkflowSchemes: (parameters, options?) => Promise<object[]>;
Parameters ​
ParameterTypeDescription
parameters{ projectIds?: (string | null)[] | null; workflowSchemeIds?: (string | null)[] | null; }-
parameters.projectIds?(string | null)[] | nullThe list of project IDs to query.
parameters.workflowSchemeIds?(string | null)[] | nullThe list of workflow scheme IDs to query.
options?RequestOptions-
Returns ​

Promise<object[]>

workflowSchemes.setWorkflowSchemeIssueType ​

ts
setWorkflowSchemeIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: { issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }; id: number; issueType: string; }-
parameters.body{ issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }-
parameters.body.issueType?stringThe ID of the issue type. Not required if updating the issue type-workflow mapping.
parameters.body.updateDraftIfNeeded?booleanSet 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?stringThe name of the workflow.
parameters.id?numberThe ID of the workflow scheme.
parameters.issueType?stringThe ID of the issue type.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemes.updateDefaultWorkflow ​

ts
updateDefaultWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: number; updateDraftIfNeeded?: boolean; workflow: string; }-
parameters.idnumberThe ID of the workflow scheme.
parameters.updateDraftIfNeeded?booleanWhether 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?stringThe name of the workflow to set as the default workflow.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemes.updateSchemes ​

ts
updateSchemes: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ defaultWorkflowId?: string; description: string; id: string; name: string; statusMappingsByIssueTypeOverride?: object[]; statusMappingsByWorkflows?: object[]; version: { id?: string; versionNumber?: number; }; workflowsForIssueTypes?: object[]; }-
parameters.defaultWorkflowId?stringThe 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?stringThe new description for this workflow scheme.
parameters.id?stringThe ID of this workflow scheme.
parameters.name?stringThe 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?{ id?: string; versionNumber?: number; }-
parameters.version.id?stringThe version UUID.
parameters.version.versionNumber?numberThe version number.
parameters.workflowsForIssueTypes?object[]Mappings from workflows to issue types.
options?RequestOptions-
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, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ defaultMapping?: boolean; id: number; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; workflowName: string; }-
parameters.defaultMapping?booleanWhether the workflow is the default workflow for the workflow scheme.
parameters.id?numberThe ID of the workflow scheme.
parameters.issueTypes?string[]The list of issue type IDs.
parameters.updateDraftIfNeeded?booleanWhether 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?stringThe name of the workflow. Optional if updating the workflow-issue types mapping.
parameters.workflowName?stringThe name of the workflow.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowSchemes.updateWorkflowScheme ​

ts
updateWorkflowScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     entityId?: string;
     hierarchyLevel?: number;
     iconUrl?: string;
     id?: string;
     name?: string;
     scope?: {
      [key: string]: unknown;
        project?: ... | ...;
        type?: ... | ... | ... | ...;
     };
     self?: string;
     subtask?: boolean;
     untranslatedName?: string;
  }>;
  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, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters{ body: { defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; lastModified?: string; lastModifiedUser?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, string>; self?: string; updateDraftIfNeeded?: boolean; }; id: number; }-
parameters.body{ defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; lastModified?: string; lastModifiedUser?: { accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, string>; self?: string; updateDraftIfNeeded?: boolean; }-
parameters.body.defaultWorkflow?stringThe 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?stringThe description of the workflow scheme.
parameters.body.draft?booleanWhether the workflow scheme is a draft or not.
parameters.body.id?numberThe ID of the workflow scheme.
parameters.body.issueTypeMappings?Record<string, string>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, { avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>The issue types available in Jira.
parameters.body.lastModified?stringThe 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?{ accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; appType?: string; avatarUrls?: { 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string | null; expand?: string; groups?: { callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }; guest?: boolean; locale?: string | null; self?: string; timeZone?: string; }-
parameters.body.lastModifiedUser.accountId?stringThe 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?booleanWhether the user is active.
parameters.body.lastModifiedUser.applicationRoles?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.lastModifiedUser.applicationRoles.callback?Record<..., ...>-
parameters.body.lastModifiedUser.applicationRoles.items?...[]-
parameters.body.lastModifiedUser.applicationRoles.max-results?number-
parameters.body.lastModifiedUser.applicationRoles.pagingCallback?Record<..., ...>-
parameters.body.lastModifiedUser.applicationRoles.size?number-
parameters.body.lastModifiedUser.appType?stringThe 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?{ 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }-
parameters.body.lastModifiedUser.avatarUrls.16x16?stringThe URL of the item's 16x16 pixel avatar.
parameters.body.lastModifiedUser.avatarUrls.24x24?stringThe URL of the item's 24x24 pixel avatar.
parameters.body.lastModifiedUser.avatarUrls.32x32?stringThe URL of the item's 32x32 pixel avatar.
parameters.body.lastModifiedUser.avatarUrls.48x48?stringThe URL of the item's 48x48 pixel avatar.
parameters.body.lastModifiedUser.displayName?stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
parameters.body.lastModifiedUser.emailAddress?string | nullThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.lastModifiedUser.expand?stringExpand options that include additional user details in the response.
parameters.body.lastModifiedUser.groups?{ callback?: Record<..., ...>; items?: ...[]; max-results?: number; pagingCallback?: Record<..., ...>; size?: number; }-
parameters.body.lastModifiedUser.groups.callback?Record<..., ...>-
parameters.body.lastModifiedUser.groups.items?...[]-
parameters.body.lastModifiedUser.groups.max-results?number-
parameters.body.lastModifiedUser.groups.pagingCallback?Record<..., ...>-
parameters.body.lastModifiedUser.groups.size?number-
parameters.body.lastModifiedUser.guest?booleanWhether the user is a guest.
parameters.body.lastModifiedUser.locale?string | nullThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
parameters.body.lastModifiedUser.self?stringThe URL of the user.
parameters.body.lastModifiedUser.timeZone?stringThe 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?stringThe 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?stringFor 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, string>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?booleanWhether 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?numberThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; entityId?: string; hierarchyLevel?: number; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: ... | ...; type?: ... | ... | ... | ...; }; self?: string; subtask?: boolean; untranslatedName?: string; }>; 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, string>; self?: string; updateDraftIfNeeded?: boolean; }>

workflowStatusCategories ​

ts
workflowStatusCategories: object;

workflowStatusCategories.getStatusCategories ​

ts
getStatusCategories: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

workflowStatusCategories.getStatusCategory ​

ts
getStatusCategory: (parameters, options?) => Promise<{
[key: string]: unknown;
  colorName?: string;
  id?: number;
  key?: string;
  name?: string;
  self?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ idOrKey: string; }-
parameters.idOrKeystringThe ID or key of the status category.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; colorName?: string; id?: number; key?: string; name?: string; self?: string; }>

workflowStatuses ​

ts
workflowStatuses: object;

workflowStatuses.getStatus ​

ts
getStatus: (parameters, options?) => 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 ​
ParameterTypeDescription
parameters{ idOrName: string; }-
parameters.idOrNamestringThe ID or name of the status.
options?RequestOptions-
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: (options?) => Promise<object[]>;
Parameters ​
ParameterType
options?RequestOptions
Returns ​

Promise<object[]>

workflowTransitionRules ​

ts
workflowTransitionRules: object;

workflowTransitionRules.deleteWorkflowTransitionRuleConfigurations ​

ts
deleteWorkflowTransitionRuleConfigurations: (parameters, options?) => Promise<{
[key: string]: unknown;
  updateResults: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ workflows: object[]; }-
parameters.workflowsobject[]The list of workflows with transition rules to delete.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; updateResults: object[]; }>

workflowTransitionRules.getWorkflowTransitionRuleConfigurations ​

ts
getWorkflowTransitionRuleConfigurations: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ draft?: boolean; expand?: | "transition" | string & object | ("transition" | string & object)[]; keys?: string[]; maxResults?: number; startAt?: number; types: (string & object | "postfunction" | "condition" | "validator")[]; withTags?: string[]; workflowNames?: string[]; }-
parameters.draft?booleanDeprecated: 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?| "transition" | 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?numberThe maximum number of items to return per page.
parameters.startAt?numberThe 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.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>

workflowTransitionRules.updateWorkflowTransitionRuleConfigurations ​

ts
updateWorkflowTransitionRuleConfigurations: (parameters, options?) => Promise<{
[key: string]: unknown;
  updateResults: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ workflows: object[]; }-
parameters.workflowsobject[]The list of workflows with transition rules to update.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; updateResults: object[]; }>