jira.js

English

Русский

English

Русский

Appearance

Function: createAgileClient() ​

ts
function createAgileClient(clientConfig): object;

Defined in: src/agile/createAgileClient.ts:161

Parameters ​

ParameterType
clientConfig| ClientConfig | Client

Returns ​

object

backlog ​

ts
backlog: object;

backlog.moveIssuesToBacklog ​

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

Promise<void>

backlog.moveIssuesToBacklogForBoard ​

ts
moveIssuesToBacklogForBoard: (parameters, options?) => Promise<void>;
Parameters ​
ParameterType
parameters{ boardId: number; issues: string[]; rankAfterIssue?: string; rankBeforeIssue?: string; rankCustomFieldId?: number; }
parameters.boardIdnumber
parameters.issues?string[]
parameters.rankAfterIssue?string
parameters.rankBeforeIssue?string
parameters.rankCustomFieldId?number
options?RequestOptions
Returns ​

Promise<void>

board ​

ts
board: object;

board.createBoard ​

ts
createBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  admins?: {
   [key: string]: unknown;
     groups?: object[];
     users?: object[];
  };
  canEdit?: boolean;
  favourite?: boolean;
  id?: number;
  isPrivate?: boolean;
  location?: {
   [key: string]: unknown;
     avatarURI?: string;
     displayName?: string;
     name?: string;
     projectId?: number;
     projectKey?: string;
     projectName?: string;
     projectTypeKey?: string;
     userAccountId?: string;
     userId?: number;
  };
  name?: string;
  self?: string;
  type?: string & object | "simple" | "scrum" | "kanban";
}>;
Parameters ​
ParameterType
parameters{ filterId?: number; location?: { projectKeyOrId?: string; type?: "user" | string & object | "project"; }; name?: string; type?: string & object | "scrum" | "kanban" | "agility"; }
parameters.filterId?number
parameters.location?{ projectKeyOrId?: string; type?: "user" | string & object | "project"; }
parameters.location.projectKeyOrId?string
parameters.location.type?"user" | string & object | "project"
parameters.name?string
parameters.type?string & object | "scrum" | "kanban" | "agility"
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; admins?: { [key: string]: unknown; groups?: object[]; users?: object[]; }; canEdit?: boolean; favourite?: boolean; id?: number; isPrivate?: boolean; location?: { [key: string]: unknown; avatarURI?: string; displayName?: string; name?: string; projectId?: number; projectKey?: string; projectName?: string; projectTypeKey?: string; userAccountId?: string; userId?: number; }; name?: string; self?: string; type?: string & object | "simple" | "scrum" | "kanban"; }>

board.deleteBoard ​

ts
deleteBoard: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; }-
parameters.boardIdnumberID of the board to be deleted
options?RequestOptions-
Returns ​

Promise<void>

board.deleteBoardProperty ​

ts
deleteBoardProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: string; propertyKey: string; }-
parameters.boardIdstringThe id of the board from which the property will be removed.
parameters.propertyKey?stringThe key of the property to remove.
options?RequestOptions-
Returns ​

Promise<void>

board.getAllBoards ​

ts
getAllBoards: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ accountIdLocation?: string; expand?: | string & object | "permissions" | "admins" | (string & object | "permissions" | "admins")[]; filterId?: number; includePrivate?: boolean; maxResults?: number; name?: string; negateLocationFiltering?: boolean; orderBy?: "name" | string & object | "-name" | "+name"; projectKeyOrId?: string; projectLocation?: string; projectTypeLocation?: string[]; startAt?: number; type?: string & object | "simple" | "scrum" | "kanban"; }-
parameters.accountIdLocation?string-
parameters.expand?| string & object | "permissions" | "admins" | (string & object | "permissions" | "admins")[]List of fields to expand for each board. Valid values: admins, permissions.
parameters.filterId?numberFilters results to boards that are relevant to a filter. Not supported for next-gen boards.
parameters.includePrivate?booleanAppends private boards to the end of the list. The name and type fields are excluded for security reasons.
parameters.maxResults?numberThe maximum number of boards to return per page. See the 'Pagination' section at the top of this page for more details.
parameters.name?stringFilters results to boards that match or partially match the specified name.
parameters.negateLocationFiltering?booleanIf set to true, negate filters used for querying by location. By default false.
parameters.orderBy?"name" | string & object | "-name" | "+name"Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name.
parameters.projectKeyOrId?stringFilters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project.
parameters.projectLocation?string-
parameters.projectTypeLocation?string[]Filters results to boards that are relevant to a project types. Support Jira Software, Jira Service Management. Valid values: software, service_desk. By default software.
parameters.startAt?numberThe starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details.
parameters.type?string & object | "simple" | "scrum" | "kanban"Filters results to boards of the specified types. Valid values: scrum, kanban, simple.
options?RequestOptions-
Returns ​

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

board.getAllQuickFilters ​

ts
getAllQuickFilters: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; maxResults?: number; startAt?: number; }-
parameters.boardIdnumberThe ID of the board that contains the requested quick filters.
parameters.maxResults?numberThe maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details.
parameters.startAt?numberThe starting index of the returned quick filters. Base index: 0. See the 'Pagination' section at the top of this page for more details.
options?RequestOptions-
Returns ​

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

board.getAllSprints ​

ts
getAllSprints: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  startAt?: number;
  total?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; maxResults?: number; startAt?: number; state?: "active" | "closed" | string & object | "future"; }-
parameters.boardIdnumberThe ID of the board that contains the requested sprints.
parameters.maxResults?numberThe maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details.
parameters.startAt?numberThe starting index of the returned sprints. Base index: 0. See the 'Pagination' section at the top of this page for more details.
parameters.state?"active" | "closed" | string & object | "future"Filters results to sprints in specified states. Valid values: future, active, closed. You can define multiple states separated by commas, e.g. state=active,closed
options?RequestOptions-
Returns ​

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

board.getAllVersions ​

ts
getAllVersions: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  startAt?: number;
  total?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; maxResults?: number; released?: string; startAt?: number; }-
parameters.boardIdnumberThe ID of the board that contains the requested versions.
parameters.maxResults?numberThe maximum number of versions to return per page. See the 'Pagination' section at the top of this page for more details.
parameters.released?stringFilters results to versions that are either released or unreleased. Valid values: true, false.
parameters.startAt?numberThe starting index of the returned versions. Base index: 0. See the 'Pagination' section at the top of this page for more details.
options?RequestOptions-
Returns ​

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

board.getApproximateIssueCountForBacklog ​

ts
getApproximateIssueCountForBacklog: (parameters, options?) => Promise<{
[key: string]: unknown;
  count?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; jql?: string; }-
parameters.boardIdnumberThe ID of the board that has the backlog containing the requested issues.
parameters.jql?stringFilters results using a JQL query. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
options?RequestOptions-
Returns ​

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

board.getApproximateIssueCountForBoard ​

ts
getApproximateIssueCountForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  count?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; jql?: string; }-
parameters.boardIdnumberThe ID of the board that contains the requested issues.
parameters.jql?stringFilters results using a JQL query. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
options?RequestOptions-
Returns ​

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

board.getBoard ​

ts
getBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  admins?: {
   [key: string]: unknown;
     groups?: object[];
     users?: object[];
  };
  canEdit?: boolean;
  favourite?: boolean;
  id?: number;
  isPrivate?: boolean;
  location?: {
   [key: string]: unknown;
     avatarURI?: string;
     displayName?: string;
     name?: string;
     projectId?: number;
     projectKey?: string;
     projectName?: string;
     projectTypeKey?: string;
     userAccountId?: string;
     userId?: number;
  };
  name?: string;
  self?: string;
  type?: string & object | "simple" | "scrum" | "kanban";
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; }-
parameters.boardIdnumberThe ID of the requested board.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; admins?: { [key: string]: unknown; groups?: object[]; users?: object[]; }; canEdit?: boolean; favourite?: boolean; id?: number; isPrivate?: boolean; location?: { [key: string]: unknown; avatarURI?: string; displayName?: string; name?: string; projectId?: number; projectKey?: string; projectName?: string; projectTypeKey?: string; userAccountId?: string; userId?: number; }; name?: string; self?: string; type?: string & object | "simple" | "scrum" | "kanban"; }>

board.getBoardByFilterId ​

ts
getBoardByFilterId: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total: number;
  values: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ filterId: number; maxResults?: number; startAt?: number; }-
parameters.filterIdnumberFilters results to boards that are relevant to a filter. Not supported for next-gen boards.
parameters.maxResults?numberThe maximum number of boards to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details.
parameters.startAt?numberThe starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details.
options?RequestOptions-
Returns ​

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

board.getBoardIssuesForEpic ​

ts
getBoardIssuesForEpic: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  isLast: boolean;
  issues: object[];
  names?: Record<string, string>;
  nextPageToken?: string;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warningMessages?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; epicId: number; expand?: string | string[]; fields?: Record<string, any>[]; jql?: string; maxResults?: number; nextPageToken?: string; reconcileIssues?: number[]; validateQuery?: boolean; }-
parameters.boardIdnumberThe ID of the board that contains the requested issues.
parameters.epicId?numberThe ID of the epic that contains the requested issues.
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Software project fields are returned.
parameters.jql?stringFilters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
parameters.maxResults?numberThe maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. 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.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.
parameters.validateQuery?booleanSpecifies whether to validate the JQL query or not. Default: true.
options?RequestOptions-
Returns ​

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

board.getBoardIssuesForSprint ​

ts
getBoardIssuesForSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  isLast: boolean;
  issues: object[];
  names?: Record<string, string>;
  nextPageToken?: string;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warningMessages?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; expand?: string | string[]; fields?: Record<string, any>[]; jql?: string; maxResults?: number; nextPageToken?: string; reconcileIssues?: number[]; sprintId: number; validateQuery?: boolean; }-
parameters.boardIdnumberThe ID of the board that contains the requested issues.
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Software project fields are returned.
parameters.jql?stringFilters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
parameters.maxResults?numberThe maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. 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.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.
parameters.sprintId?numberThe ID of the sprint that contains the requested issues.
parameters.validateQuery?booleanSpecifies whether to validate the JQL query or not. Default: true.
options?RequestOptions-
Returns ​

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

board.getBoardProperty ​

ts
getBoardProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key: string;
  value: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: string; propertyKey: string; }-
parameters.boardIdstringThe ID of the board from which the property will be returned.
parameters.propertyKey?stringThe key of the property to return.
options?RequestOptions-
Returns ​

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

board.getBoardPropertyKeys ​

ts
getBoardPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: string; }-
parameters.boardIdstringThe ID of the board from which property keys will be returned.
options?RequestOptions-
Returns ​

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

board.getConfiguration ​

ts
getConfiguration: (parameters, options?) => Promise<{
[key: string]: unknown;
  columnConfig?: {
   [key: string]: unknown;
     columns?: object[];
     constraintType?: string;
  };
  estimation?: {
   [key: string]: unknown;
     field?: {
      [key: string]: unknown;
        displayName?: string;
        fieldId?: string;
     };
     type?: string;
  };
  filter?: {
   [key: string]: unknown;
     id?: string;
     self?: string;
  };
  id?: number;
  location?: {
   [key: string]: unknown;
     id?: string;
     key?: string;
     name?: string;
     projectKeyOrId?: string;
     self?: string;
     type?: "user" | string & object | "project";
  };
  name?: string;
  ranking?: {
   [key: string]: unknown;
     rankCustomFieldId?: number;
  };
  self?: string;
  subQuery?: {
   [key: string]: unknown;
     query?: string;
  };
  type?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; }-
parameters.boardIdnumberThe ID of the board for which configuration is requested.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; columnConfig?: { [key: string]: unknown; columns?: object[]; constraintType?: string; }; estimation?: { [key: string]: unknown; field?: { [key: string]: unknown; displayName?: string; fieldId?: string; }; type?: string; }; filter?: { [key: string]: unknown; id?: string; self?: string; }; id?: number; location?: { [key: string]: unknown; id?: string; key?: string; name?: string; projectKeyOrId?: string; self?: string; type?: "user" | string & object | "project"; }; name?: string; ranking?: { [key: string]: unknown; rankCustomFieldId?: number; }; self?: string; subQuery?: { [key: string]: unknown; query?: string; }; type?: string; }>

board.getEpics ​

ts
getEpics: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  startAt?: number;
  total?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; done?: string; maxResults?: number; startAt?: number; }-
parameters.boardIdnumberThe ID of the board that contains the requested epics.
parameters.done?stringFilters results to epics that are either done or not done. Valid values: true, false.
parameters.maxResults?numberThe maximum number of epics to return per page. See the 'Pagination' section at the top of this page for more details.
parameters.startAt?numberThe starting index of the returned epics. Base index: 0. See the 'Pagination' section at the top of this page for more details.
options?RequestOptions-
Returns ​

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

board.getFeaturesForBoard ​

ts
getFeaturesForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  features?: object[];
}>;
Parameters ​
ParameterType
parameters{ boardId: number; }
parameters.boardIdnumber
options?RequestOptions
Returns ​

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

board.getIssuesForBacklog ​

ts
getIssuesForBacklog: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  isLast: boolean;
  issues: object[];
  names?: Record<string, string>;
  nextPageToken?: string;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warningMessages?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; expand?: string | string[]; fields?: Record<string, any>[]; jql?: string; maxResults?: number; nextPageToken?: string; reconcileIssues?: number[]; validateQuery?: boolean; }-
parameters.boardIdnumberThe ID of the board that has the backlog containing the requested issues.
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Software project fields are returned.
parameters.jql?stringFilters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
parameters.maxResults?numberThe maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. 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.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.
parameters.validateQuery?booleanSpecifies whether to validate the JQL query or not. Default: true.
options?RequestOptions-
Returns ​

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

board.getIssuesForBoard ​

ts
getIssuesForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  isLast: boolean;
  issues: object[];
  names?: Record<string, string>;
  nextPageToken?: string;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warningMessages?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; expand?: string | string[]; fields?: Record<string, any>[]; jql?: string; maxResults?: number; nextPageToken?: string; reconcileIssues?: number[]; validateQuery?: boolean; }-
parameters.boardIdnumberThe ID of the board that contains the requested issues.
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Software project fields are returned.
parameters.jql?stringFilters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
parameters.maxResults?numberThe maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. 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.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.
parameters.validateQuery?booleanSpecifies whether to validate the JQL query or not. Default: true.
options?RequestOptions-
Returns ​

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

board.getIssuesWithoutEpicForBoard ​

ts
getIssuesWithoutEpicForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  isLast: boolean;
  issues: object[];
  names?: Record<string, string>;
  nextPageToken?: string;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warningMessages?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; expand?: string | string[]; fields?: Record<string, any>[]; jql?: string; maxResults?: number; nextPageToken?: string; reconcileIssues?: number[]; validateQuery?: boolean; }-
parameters.boardIdnumberThe ID of the board that contains the requested issues.
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Software project fields are returned.
parameters.jql?stringFilters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
parameters.maxResults?numberThe maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. 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.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.
parameters.validateQuery?booleanSpecifies whether to validate the JQL query or not. Default: true.
options?RequestOptions-
Returns ​

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

board.getProjects ​

ts
getProjects: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  startAt?: number;
  total?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; maxResults?: number; startAt?: number; }-
parameters.boardIdnumberThe ID of the board that contains returned projects.
parameters.maxResults?numberThe maximum number of projects to return per page. See the 'Pagination' section at the top of this page for more details.
parameters.startAt?numberThe starting index of the returned projects. Base index: 0. See the 'Pagination' section at the top of this page for more details.
options?RequestOptions-
Returns ​

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

board.getProjectsFull ​

ts
getProjectsFull: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  startAt?: number;
  total?: number;
  values?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; }-
parameters.boardIdnumberThe ID of the board that contains returned projects.
options?RequestOptions-
Returns ​

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

board.getQuickFilter ​

ts
getQuickFilter: (parameters, options?) => Promise<{
[key: string]: unknown;
  boardId?: number;
  description?: string;
  id?: number;
  jql?: string;
  name?: string;
  position?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: number; quickFilterId: number; }-
parameters.boardIdnumber-
parameters.quickFilterId?numberThe ID of the requested quick filter.
options?RequestOptions-
Returns ​

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

board.getReportsForBoard ​

ts
getReportsForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  reports?: Record<string, any>[];
}>;
Parameters ​
ParameterType
parameters{ boardId: number; }
parameters.boardIdnumber
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; reports?: Record<string, any>[]; }>

board.moveIssuesToBoard ​

ts
moveIssuesToBoard: (parameters, options?) => Promise<void>;
Parameters ​
ParameterType
parameters{ boardId: number; issues?: string[]; rankAfterIssue?: string; rankBeforeIssue?: string; rankCustomFieldId?: number; }
parameters.boardIdnumber
parameters.issues?string[]
parameters.rankAfterIssue?string
parameters.rankBeforeIssue?string
parameters.rankCustomFieldId?number
options?RequestOptions
Returns ​

Promise<void>

board.setBoardProperty ​

ts
setBoardProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ boardId: string; propertyKey: string; propertyValue: Record<string, any>; }-
parameters.boardIdstringThe ID of the board on which the property will be set.
parameters.propertyKey?stringThe key of the board's property. The maximum length of the key is 255 bytes.
parameters.propertyValue?Record<string, any>-
options?RequestOptions-
Returns ​

Promise<void>

board.toggleFeatures ​

ts
toggleFeatures: (parameters, options?) => Promise<{
[key: string]: unknown;
  features?: object[];
}>;
Parameters ​
ParameterType
parameters{ boardId: number; body: { boardId?: number; enabling?: boolean; feature?: string; }; }
parameters.boardIdnumber
parameters.body?{ boardId?: number; enabling?: boolean; feature?: string; }
parameters.body.boardId?number
parameters.body.enabling?boolean
parameters.body.feature?string
options?RequestOptions
Returns ​

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

builds ​

ts
builds: object;

builds.deleteBuildByKey ​

ts
deleteBuildByKey: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ buildNumber: number; pipelineId: string; }-
parameters.buildNumbernumberThe buildNumber of the build to delete.
parameters.pipelineId?stringThe pipelineId of the build to delete.
options?RequestOptions-
Returns ​

Promise<void>

builds.deleteBuildsByProperty ​

ts
deleteBuildsByProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; repoId?: string; }-
parameters.accountIdstringProperty key used as a query parameter to select which submitted builds to delete. Must match a key you previously sent in submitBuilds properties (same rules: string values, max 5 properties on submit, keys must not contain ':' or start with '_'). Official docs and OpenAPI description example: accountId=account-123.
parameters.repoId?stringOptional additional property filter combined with accountId (AND). Official example: repoId=repo-345 alongside accountId. Must match a key previously supplied in submitBuilds properties.
options?RequestOptions-
Returns ​

Promise<void>

builds.getBuildByKey ​

ts
getBuildByKey: (parameters, options?) => Promise<{
[key: string]: unknown;
  associations?: object[];
  buildNumber: number;
  description?: string;
  displayName: string;
  label?: string;
  lastUpdated: Date;
  pipelineId: string;
  references?: object[];
  schemaVersion?: string & object | "1.0";
  state:   | "failed"
     | "unknown"
     | "pending"
     | string & object
     | "successful"
     | "in_progress"
     | "cancelled";
  testInfo?: {
   [key: string]: unknown;
     numberFailed: number;
     numberPassed: number;
     numberSkipped?: number;
     totalNumber: number;
  };
  updateSequenceNumber: number;
  url: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ buildNumber: number; pipelineId: string; }-
parameters.buildNumbernumberThe buildNumber of the build.
parameters.pipelineId?stringThe pipelineId of the build.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; associations?: object[]; buildNumber: number; description?: string; displayName: string; label?: string; lastUpdated: Date; pipelineId: string; references?: object[]; schemaVersion?: string & object | "1.0"; state: | "failed" | "unknown" | "pending" | string & object | "successful" | "in_progress" | "cancelled"; testInfo?: { [key: string]: unknown; numberFailed: number; numberPassed: number; numberSkipped?: number; totalNumber: number; }; updateSequenceNumber: number; url: string; }>

builds.submitBuilds ​

ts
submitBuilds: (parameters, options?) => Promise<{
[key: string]: unknown;
  acceptedBuilds?: object[];
  rejectedBuilds?: object[];
  unknownAssociations?: object[];
  unknownIssueKeys?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ builds: object[]; properties?: Record<string, string>; providerMetadata?: { product?: string; }; }-
parameters.buildsobject[]A list of builds to submit to Jira. Each build may be associated with one or more Jira issue keys, and will be associated with any properties included in this request.
parameters.properties?Record<string, string>Properties assigned to build data that can then be used for delete / query operations. Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system. Note that these properties will never be returned with build data. They are not intended for use as metadata to associate with a build. Internally they are stored as a hash so that personal information etc. is never stored within Jira. Properties are supplied as key/value pairs, a maximum of 5 properties can be supplied, and keys must not contain ':' or start with '_'.
parameters.providerMetadata?{ product?: string; }Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.
parameters.providerMetadata.product?stringAn optional name of the source of the builds data.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; acceptedBuilds?: object[]; rejectedBuilds?: object[]; unknownAssociations?: object[]; unknownIssueKeys?: string[]; }>

deployments ​

ts
deployments: object;

deployments.deleteDeploymentByKey ​

ts
deleteDeploymentByKey: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ deploymentSequenceNumber: number; environmentId: string; pipelineId: string; }-
parameters.deploymentSequenceNumbernumberThe deployment's deploymentSequenceNumber.
parameters.environmentId?stringThe ID of the deployment's environment.
parameters.pipelineId?stringThe ID of the deployment's pipeline.
options?RequestOptions-
Returns ​

Promise<void>

deployments.deleteDeploymentsByProperty ​

ts
deleteDeploymentsByProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; createdBy?: string; }-
parameters.accountIdstringProperty key used to select which submitted deployments to delete. Must match a key previously sent in submitDeployments properties (string values, max 5 properties, keys cannot contain ':' or start with '_'). Example: accountId=account-123.
parameters.createdBy?stringOptional additional property filter combined with accountId (AND). Must match a key previously supplied in submitDeployments properties. Example: createdBy=user-456.
options?RequestOptions-
Returns ​

Promise<void>

deployments.getDeploymentByKey ​

ts
getDeploymentByKey: (parameters, options?) => Promise<{
[key: string]: unknown;
  associations?: (
     | {
   [key: string]: unknown;
     associationType: ... & ... | "commit" | "repository";
     values: (... | ...)[];
   }
     | {
   [key: string]: unknown;
     associationType: ... & ... | "issueKeys" | "issueIdOrKeys";
     values: string[];
   }
     | {
   [key: string]: unknown;
     associationType: ... & ... | "serviceIdOrKeys";
     values: string[];
  })[];
  commands?: object[];
  deploymentSequenceNumber: number;
  description: string;
  displayName: string;
  duration?: number;
  environment: {
   [key: string]: unknown;
     displayName: string;
     id: string;
     type:   | "unmapped"
        | string & object
        | "development"
        | "testing"
        | "staging"
        | "production";
  };
  label?: string;
  lastUpdated: Date;
  pipeline: {
   [key: string]: unknown;
     displayName: string;
     id: string;
     url: string;
  };
  schemaVersion?: string & object | "1.0";
  state:   | "failed"
     | "unknown"
     | "pending"
     | string & object
     | "successful"
     | "in_progress"
     | "cancelled"
     | "rolled_back";
  updateSequenceNumber: number;
  url: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ deploymentSequenceNumber: number; environmentId: string; pipelineId: string; }-
parameters.deploymentSequenceNumbernumberThe deployment's deploymentSequenceNumber.
parameters.environmentId?stringThe ID of the deployment's environment.
parameters.pipelineId?stringThe ID of the deployment's pipeline.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; associations?: ( | { [key: string]: unknown; associationType: ... & ... | "commit" | "repository"; values: (... | ...)[]; } | { [key: string]: unknown; associationType: ... & ... | "issueKeys" | "issueIdOrKeys"; values: string[]; } | { [key: string]: unknown; associationType: ... & ... | "serviceIdOrKeys"; values: string[]; })[]; commands?: object[]; deploymentSequenceNumber: number; description: string; displayName: string; duration?: number; environment: { [key: string]: unknown; displayName: string; id: string; type: | "unmapped" | string & object | "development" | "testing" | "staging" | "production"; }; label?: string; lastUpdated: Date; pipeline: { [key: string]: unknown; displayName: string; id: string; url: string; }; schemaVersion?: string & object | "1.0"; state: | "failed" | "unknown" | "pending" | string & object | "successful" | "in_progress" | "cancelled" | "rolled_back"; updateSequenceNumber: number; url: string; }>

deployments.getDeploymentGatingStatusByKey ​

ts
getDeploymentGatingStatusByKey: (parameters, options?) => Promise<{
[key: string]: unknown;
  deploymentSequenceNumber?: number;
  details?: object[];
  environmentId?: string;
  gatingStatus?: "invalid" | string & object | "allowed" | "prevented" | "awaiting";
  pipelineId?: string;
  updatedTimestamp?: Date;
}>;
Parameters ​
ParameterTypeDescription
parameters{ deploymentSequenceNumber: number; environmentId: string; pipelineId: string; }-
parameters.deploymentSequenceNumbernumberThe Deployment's deploymentSequenceNumber.
parameters.environmentId?stringThe ID of the Deployment's environment.
parameters.pipelineId?stringThe ID of the Deployment's pipeline.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; deploymentSequenceNumber?: number; details?: object[]; environmentId?: string; gatingStatus?: "invalid" | string & object | "allowed" | "prevented" | "awaiting"; pipelineId?: string; updatedTimestamp?: Date; }>

deployments.submitDeployments ​

ts
submitDeployments: (parameters, options?) => Promise<{
[key: string]: unknown;
  acceptedDeployments?: object[];
  rejectedDeployments?: object[];
  unknownAssociations?: (
     | {
   [key: string]: unknown;
     associationType: ... & ... | "commit" | "repository";
     values: (... | ...)[];
   }
     | {
   [key: string]: unknown;
     associationType: ... & ... | "issueKeys" | "issueIdOrKeys";
     values: string[];
   }
     | {
   [key: string]: unknown;
     associationType: ... & ... | "serviceIdOrKeys";
     values: string[];
  })[];
  unknownIssueKeys?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ deployments: object[]; properties?: Record<string, string>; providerMetadata?: { product?: string; }; }-
parameters.deploymentsobject[]A list of deployments to submit to Jira. Each deployment may be associated with one or more Jira issue keys, and will be associated with any properties included in this request.
parameters.properties?Record<string, string>Properties assigned to deployment data that can then be used for delete / query operations. Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system. Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.
parameters.providerMetadata?{ product?: string; }Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.
parameters.providerMetadata.product?stringAn optional name of the source of the deployments data.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; acceptedDeployments?: object[]; rejectedDeployments?: object[]; unknownAssociations?: ( | { [key: string]: unknown; associationType: ... & ... | "commit" | "repository"; values: (... | ...)[]; } | { [key: string]: unknown; associationType: ... & ... | "issueKeys" | "issueIdOrKeys"; values: string[]; } | { [key: string]: unknown; associationType: ... & ... | "serviceIdOrKeys"; values: string[]; })[]; unknownIssueKeys?: string[]; }>

developmentInformation ​

ts
developmentInformation: object;

developmentInformation.deleteByProperties ​

ts
deleteByProperties: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ updateSequenceId: number; }-
parameters.updateSequenceIdnumberAn optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they are issued close together.
options?RequestOptions-
Returns ​

Promise<void>

developmentInformation.deleteEntity ​

ts
deleteEntity: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ entityId: string; entityType: string & object | "commit" | "branch" | "pull_request"; repositoryId: string; updateSequenceId: number; }-
parameters.entityIdstring-
parameters.entityType?string & object | "commit" | "branch" | "pull_request"-
parameters.repositoryId?string-
parameters.updateSequenceId?numberAn optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they are issued close together.
options?RequestOptions-
Returns ​

Promise<void>

developmentInformation.deleteRepository ​

ts
deleteRepository: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ repositoryId: string; updateSequenceId: number; }-
parameters.repositoryIdstringThe ID of repository to delete
parameters.updateSequenceId?numberAn optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they are issued close together.
options?RequestOptions-
Returns ​

Promise<void>

developmentInformation.existsByProperties ​

ts
existsByProperties: (parameters?, options?) => Promise<{
[key: string]: unknown;
  hasDataMatchingProperties?: boolean;
}>;
Parameters ​
ParameterTypeDescription
parameters?{ updateSequenceId?: number; }-
parameters.updateSequenceId?numberAn optional property. Filters out entities and repositories which have updateSequenceId greater than specified.
options?RequestOptions-
Returns ​

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

developmentInformation.getRepository ​

ts
getRepository: (parameters, options?) => Promise<{
[key: string]: unknown;
  avatar?: string;
  avatarDescription?: string;
  branches?: object[];
  commits?: object[];
  description?: string;
  forkOf?: string;
  id: string;
  name: string;
  pullRequests?: object[];
  updateSequenceId: number;
  url: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ repositoryId: string; }-
parameters.repositoryIdstringThe ID of repository to fetch
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; avatar?: string; avatarDescription?: string; branches?: object[]; commits?: object[]; description?: string; forkOf?: string; id: string; name: string; pullRequests?: object[]; updateSequenceId: number; url: string; }>

developmentInformation.storeDevelopmentInformation ​

ts
storeDevelopmentInformation: (parameters, options?) => Promise<{
[key: string]: unknown;
  acceptedDevinfoEntities?: Record<string, {
   [key: string]: unknown;
     branches?: string[];
     commits?: string[];
     pullRequests?: string[];
  }>;
  failedDevinfoEntities?: Record<string, {
   [key: string]: unknown;
     branches?: object[];
     commits?: object[];
     errorMessages?: object[];
     pullRequests?: object[];
  }>;
  unknownAssociations?: object[];
  unknownIssueKeys?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ operationType?: string & object | "NORMAL" | "BACKFILL"; preventTransitions?: boolean; properties?: Record<string, string>; providerMetadata?: { product?: string; }; repositories: object[]; }-
parameters.operationType?string & object | "NORMAL" | "BACKFILL"Indicates the operation being performed by the provider system when sending this data. "NORMAL" - Data received during normal operation (e.g. a user pushing a branch). "BACKFILL" - Data received while backfilling existing data (e.g. indexing a newly connected account). Default is "NORMAL". Please note that "BACKFILL" operations have a much higher rate-limiting threshold but are also processed slower in comparison to "NORMAL" operations.
parameters.preventTransitions?booleanFlag to prevent automatic issue transitions and smart commits being fired, default is false.
parameters.properties?Record<string, string>Arbitrary properties to tag the submitted repositories with. These properties can be used for delete operations to e.g. clean up all development information associated with an account in the event that the account is removed from the provider system. Note that these properties will never be returned with repository or entity data. They are not intended for use as metadata to associate with a repository. Maximum length of each key or value is 255 characters. Maximum allowed number of properties key/value pairs is 5. Properties keys cannot start with '_' character. Properties keys cannot contain ':' character.
parameters.providerMetadata?{ product?: string; }Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.
parameters.providerMetadata.product?stringAn optional name of the source of the development information data.
parameters.repositories?object[]List of repositories containing development information. Must not contain duplicates. Maximum number of entities across all repositories is 1000.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; acceptedDevinfoEntities?: Record<string, { [key: string]: unknown; branches?: string[]; commits?: string[]; pullRequests?: string[]; }>; failedDevinfoEntities?: Record<string, { [key: string]: unknown; branches?: object[]; commits?: object[]; errorMessages?: object[]; pullRequests?: object[]; }>; unknownAssociations?: object[]; unknownIssueKeys?: string[]; }>

devopsComponents ​

ts
devopsComponents: object;

devopsComponents.deleteComponentById ​

ts
deleteComponentById: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ componentId: string; }-
parameters.componentIdstringThe ID of the Component to delete.
options?RequestOptions-
Returns ​

Promise<void>

devopsComponents.deleteComponentsByProperty ​

ts
deleteComponentsByProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; createdBy?: string; }-
parameters.accountIdstringProperty key used to select which submitted DevOps components to delete. Must match a key previously sent in submitComponents properties (string values, max 5 properties, keys cannot contain ':' or start with '_'). Example: accountId=account-123.
parameters.createdBy?stringOptional additional property filter combined with accountId (AND). Must match a key previously supplied in submitComponents properties. Example: createdBy=user-456.
options?RequestOptions-
Returns ​

Promise<void>

devopsComponents.getComponentById ​

ts
getComponentById: (parameters, options?) => Promise<{
[key: string]: unknown;
  avatarUrl: string;
  componentType:   | string & object
     | "Service"
     | "Application"
     | "Library"
     | "Capability"
     | "Cloud resource"
     | "Data pipeline"
     | "Machine learning model"
     | "UI element"
     | "Website"
     | "Other";
  description: string;
  id: string;
  lastUpdated: Date;
  name: string;
  providerName?: string;
  schemaVersion: string & object | "1.0";
  tier: string & object | "Tier 1" | "Tier 2" | "Tier 3" | "Tier 4";
  updateSequenceNumber: number;
  url: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ componentId: string; }-
parameters.componentIdstringThe ID of the Component to fetch.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; avatarUrl: string; componentType: | string & object | "Service" | "Application" | "Library" | "Capability" | "Cloud resource" | "Data pipeline" | "Machine learning model" | "UI element" | "Website" | "Other"; description: string; id: string; lastUpdated: Date; name: string; providerName?: string; schemaVersion: string & object | "1.0"; tier: string & object | "Tier 1" | "Tier 2" | "Tier 3" | "Tier 4"; updateSequenceNumber: number; url: string; }>

devopsComponents.submitComponents ​

ts
submitComponents: (parameters, options?) => Promise<{
[key: string]: unknown;
  acceptedComponents?: string[];
  failedComponents?: Record<string, object[]>;
  unknownProjectKeys?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ devopsComponents: object[]; properties?: Record<string, string>; providerMetadata?: { product?: string; }; }-
parameters.devopsComponentsobject[]-
parameters.properties?Record<string, string>Properties assigned to incidents/components/review data that can then be used for delete / query operations. Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system. Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.
parameters.providerMetadata?{ product?: string; }Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.
parameters.providerMetadata.product?stringAn optional name of the source of the incidents.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; acceptedComponents?: string[]; failedComponents?: Record<string, object[]>; unknownProjectKeys?: string[]; }>

epic ​

ts
epic: object;

epic.getEpic ​

ts
getEpic: (parameters, options?) => Promise<{
[key: string]: unknown;
  color?: {
   [key: string]: unknown;
     key?: string;
  };
  done?: boolean;
  id?: number;
  key?: string;
  name?: string;
  self?: string;
  summary?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ epicIdOrKey: string; }-
parameters.epicIdOrKeystringThe id or key of the requested epic.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; color?: { [key: string]: unknown; key?: string; }; done?: boolean; id?: number; key?: string; name?: string; self?: string; summary?: string; }>

epic.getIssuesForEpic ​

ts
getIssuesForEpic: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  isLast: boolean;
  issues: object[];
  names?: Record<string, string>;
  nextPageToken?: string;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warningMessages?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ epicIdOrKey: string; expand?: string | string[]; fields?: Record<string, any>[]; jql?: string; maxResults?: number; nextPageToken?: string; reconcileIssues?: number[]; validateQuery?: boolean; }-
parameters.epicIdOrKeystringThe ID or key of the epic that contains the requested issues.
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Software project fields are returned.
parameters.jql?stringFilters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
parameters.maxResults?numberThe maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. 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.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.
parameters.validateQuery?booleanSpecifies whether to validate the JQL query or not. Default: true.
options?RequestOptions-
Returns ​

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

epic.getIssuesWithoutEpic ​

ts
getIssuesWithoutEpic: (parameters?, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  isLast: boolean;
  issues: object[];
  names?: Record<string, string>;
  nextPageToken?: string;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warningMessages?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ expand?: string | string[]; fields?: Record<string, any>[]; jql?: string; maxResults?: number; nextPageToken?: string; reconcileIssues?: number[]; validateQuery?: boolean; }-
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Software project fields are returned.
parameters.jql?stringFilters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
parameters.maxResults?numberThe maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. 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.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.
parameters.validateQuery?booleanSpecifies whether to validate the JQL query or not. Default: true.
options?RequestOptions-
Returns ​

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

epic.moveIssuesToEpic ​

ts
moveIssuesToEpic: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ epicIdOrKey: string; issues?: string[]; }-
parameters.epicIdOrKeystringThe id or key of the epic that you want to assign issues to.
parameters.issues?string[]-
options?RequestOptions-
Returns ​

Promise<void>

epic.partiallyUpdateEpic ​

ts
partiallyUpdateEpic: (parameters, options?) => Promise<{
[key: string]: unknown;
  color?: {
   [key: string]: unknown;
     key?: string;
  };
  done?: boolean;
  id?: number;
  key?: string;
  name?: string;
  self?: string;
  summary?: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ color?: { key?: | string & object | "color_1" | "color_2" | "color_3" | "color_4" | "color_5" | "color_6" | "color_7" | "color_8" | "color_9" | "color_10" | "color_11" | "color_12" | "color_13" | "color_14"; }; done?: boolean; epicIdOrKey: string; name?: string; summary?: string; }-
parameters.color?{ key?: | string & object | "color_1" | "color_2" | "color_3" | "color_4" | "color_5" | "color_6" | "color_7" | "color_8" | "color_9" | "color_10" | "color_11" | "color_12" | "color_13" | "color_14"; }-
parameters.color.key?| string & object | "color_1" | "color_2" | "color_3" | "color_4" | "color_5" | "color_6" | "color_7" | "color_8" | "color_9" | "color_10" | "color_11" | "color_12" | "color_13" | "color_14"-
parameters.done?boolean-
parameters.epicIdOrKey?stringThe id or key of the epic to update.
parameters.name?string-
parameters.summary?string-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; color?: { [key: string]: unknown; key?: string; }; done?: boolean; id?: number; key?: string; name?: string; self?: string; summary?: string; }>

epic.rankEpics ​

ts
rankEpics: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ epicIdOrKey: string; rankAfterEpic?: string; rankBeforeEpic?: string; rankCustomFieldId?: number; }-
parameters.epicIdOrKeystringThe id or key of the epic to rank.
parameters.rankAfterEpic?string-
parameters.rankBeforeEpic?string-
parameters.rankCustomFieldId?number-
options?RequestOptions-
Returns ​

Promise<void>

epic.removeIssuesFromEpic ​

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

Promise<void>

featureFlags ​

ts
featureFlags: object;

featureFlags.deleteFeatureFlagById ​

ts
deleteFeatureFlagById: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ featureFlagId: string; }-
parameters.featureFlagIdstringThe ID of the Feature Flag to delete.
options?RequestOptions-
Returns ​

Promise<void>

featureFlags.deleteFeatureFlagsByProperty ​

ts
deleteFeatureFlagsByProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; createdBy?: string; }-
parameters.accountIdstringProperty key used to select which submitted feature flags to delete. Must match a key previously sent in submitFeatureFlags properties (string values, max 5 properties, keys cannot contain ':' or start with '_'). Example: accountId=account-123.
parameters.createdBy?stringOptional additional property filter combined with accountId (AND). Must match a key previously supplied in submitFeatureFlags properties. Example: createdBy=user-456.
options?RequestOptions-
Returns ​

Promise<void>

featureFlags.getFeatureFlagById ​

ts
getFeatureFlagById: (parameters, options?) => Promise<{
[key: string]: unknown;
  associations?: object[];
  details: object[];
  displayName?: string;
  id: string;
  key: string;
  schemaVersion?: string & object | "1.0";
  summary: {
   [key: string]: unknown;
     lastUpdated: Date;
     status: {
      [key: string]: unknown;
        defaultValue?: string;
        enabled: boolean;
        rollout?: {
         [key: string]: unknown;
           percentage?: number;
           rules?: number;
           text?: string;
        };
     };
     url?: string;
  };
  updateSequenceId: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ featureFlagId: string; }-
parameters.featureFlagIdstringThe ID of the Feature Flag to fetch.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; associations?: object[]; details: object[]; displayName?: string; id: string; key: string; schemaVersion?: string & object | "1.0"; summary: { [key: string]: unknown; lastUpdated: Date; status: { [key: string]: unknown; defaultValue?: string; enabled: boolean; rollout?: { [key: string]: unknown; percentage?: number; rules?: number; text?: string; }; }; url?: string; }; updateSequenceId: number; }>

featureFlags.submitFeatureFlags ​

ts
submitFeatureFlags: (parameters, options?) => Promise<{
[key: string]: unknown;
  acceptedFeatureFlags?: string[];
  failedFeatureFlags?: Record<string, object[]>;
  unknownAssociations?: object[];
  unknownIssueKeys?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ flags: object[]; properties?: Record<string, string>; providerMetadata?: { product?: string; }; }-
parameters.flagsobject[]A list of Feature Flags to submit to Jira. Each Feature Flag may be associated with 1 or more Jira issue keys, and will be associated with any properties included in this request.
parameters.properties?Record<string, string>Properties assigned to Feature Flag data that can then be used for delete / query operations. Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system. Note that these properties will never be returned with Feature Flag data. They are not intended for use as metadata to associate with a Feature Flag. Internally they are stored as a hash so that personal information etc. is never stored within Jira. Properties are supplied as key/value pairs, a maximum of 5 properties can be supplied, and keys must not contain ':' or start with '_'.
parameters.providerMetadata?{ product?: string; }Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.
parameters.providerMetadata.product?stringAn optional name of the source of the feature flags.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; acceptedFeatureFlags?: string[]; failedFeatureFlags?: Record<string, object[]>; unknownAssociations?: object[]; unknownIssueKeys?: string[]; }>

issue ​

ts
issue: object;

issue.estimateIssueForBoard ​

ts
estimateIssueForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  fieldId?: string;
  value?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId?: number; issueIdOrKey: string; value?: string; }-
parameters.boardId?numberThe ID of the board required to determine which field is used for estimation.
parameters.issueIdOrKey?stringThe ID or key of the requested issue.
parameters.value?string-
options?RequestOptions-
Returns ​

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

issue.getIssue ​

ts
getIssue: (parameters, options?) => Promise<{
[key: string]: unknown;
  changelog?: {
   [key: string]: unknown;
     histories?: object[];
     maxResults?: number;
     startAt?: number;
     total?: number;
  };
  editmeta?: {
   [key: string]: unknown;
     fields?: Record<string, {
      [key: string]: unknown;
        allowedValues?: ... | ...;
        autoCompleteUrl?: ... | ...;
        configuration?: ... | ...;
        defaultValue?: unknown;
        hasDefaultValue?: ... | ... | ...;
        key: string;
        name: string;
        operations: ...[];
        required: boolean;
        schema?: ... | ...;
     }>;
  };
  expand?: string;
  fields?: Record<string, any>;
  fieldsToInclude?: {
   [key: string]: unknown;
     actuallyIncluded?: string[];
     excluded?: string[];
     included?: string[];
  };
  id: string;
  key: string;
  names?: Record<string, string>;
  operations?: {
   [key: string]: unknown;
     linkGroups?: LinkGroup[];
  };
  properties?: Record<string, any>;
  renderedFields?: Record<string, any>;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  self: string;
  transitions?: object[];
  versionedRepresentations?: Record<string, any>;
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: string | string[]; fields?: Record<string, any>[]; issueIdOrKey: string; updateHistory?: boolean; }-
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
parameters.issueIdOrKey?stringThe ID or key of the requested issue.
parameters.updateHistory?booleanA boolean indicating whether the issue retrieved by this method should be added to the current user's issue history
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; changelog?: { [key: string]: unknown; histories?: object[]; maxResults?: number; startAt?: number; total?: number; }; editmeta?: { [key: string]: unknown; fields?: Record<string, { [key: string]: unknown; allowedValues?: ... | ...; autoCompleteUrl?: ... | ...; configuration?: ... | ...; defaultValue?: unknown; hasDefaultValue?: ... | ... | ...; key: string; name: string; operations: ...[]; required: boolean; schema?: ... | ...; }>; }; expand?: string; fields?: Record<string, any>; fieldsToInclude?: { [key: string]: unknown; actuallyIncluded?: string[]; excluded?: string[]; included?: string[]; }; id: string; key: string; names?: Record<string, string>; operations?: { [key: string]: unknown; linkGroups?: LinkGroup[]; }; properties?: Record<string, any>; renderedFields?: Record<string, any>; schema?: Record<string, { [key: string]: unknown; configuration?: Record<string, any>; custom?: string; customId?: number; items?: string; system?: string; type: string; }>; self: string; transitions?: object[]; versionedRepresentations?: Record<string, any>; }>

issue.getIssueEstimationForBoard ​

ts
getIssueEstimationForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  fieldId?: string;
  value?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ boardId?: number; issueIdOrKey: string; }-
parameters.boardId?numberThe ID of the board required to determine which field is used for estimation.
parameters.issueIdOrKey?stringThe ID or key of the requested issue.
options?RequestOptions-
Returns ​

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

issue.rankIssues ​

ts
rankIssues: (parameters, options?) => Promise<void>;
Parameters ​
ParameterType
parameters{ issues?: string[]; rankAfterIssue?: string; rankBeforeIssue?: string; rankCustomFieldId?: number; }
parameters.issues?string[]
parameters.rankAfterIssue?string
parameters.rankBeforeIssue?string
parameters.rankCustomFieldId?number
options?RequestOptions
Returns ​

Promise<void>

operations ​

ts
operations: object;

operations.deleteEntityByProperty ​

ts
deleteEntityByProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; createdBy?: string; }-
parameters.accountIdstringProperty key used to select which submitted incidents or reviews to delete. Must match a key previously sent in submitEntity properties (string values, max 5 properties, keys cannot contain ':' or start with '_'). Example: accountId=account-123.
parameters.createdBy?stringOptional additional property filter combined with accountId (AND). Must match a key previously supplied in submitEntity properties. Example: createdBy=user-456.
options?RequestOptions-
Returns ​

Promise<void>

operations.deleteIncidentById ​

ts
deleteIncidentById: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ incidentId: string; }-
parameters.incidentIdstringThe ID of the Incident to delete.
options?RequestOptions-
Returns ​

Promise<void>

operations.deleteReviewById ​

ts
deleteReviewById: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ reviewId: string; }-
parameters.reviewIdstringThe ID of the Review to delete.
options?RequestOptions-
Returns ​

Promise<void>

operations.deleteWorkspaces ​

ts
deleteWorkspaces: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ workspaceIds: string | string[]; }-
parameters.workspaceIdsstring | string[]Comma-separated list of Operations Workspace IDs to delete. All data associated with the given workspaces will eventually be removed from Jira. Example: workspaceIds=111-222-333,444-555-666.
options?RequestOptions-
Returns ​

Promise<void>

operations.getIncidentById ​

ts
getIncidentById: (parameters, options?) => Promise<{
[key: string]: unknown;
  affectedComponents: string[];
  associations?: object[];
  createdDate: Date;
  description: string;
  id: string;
  lastUpdated: Date;
  schemaVersion: string & object | "1.0";
  severity?: {
   [key: string]: unknown;
     level: "unknown" | string & object | "P1" | "P2" | "P3" | "P4" | "P5";
  };
  status: "unknown" | "open" | string & object | "resolved";
  summary: string;
  updateSequenceNumber: number;
  url: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ incidentId: string; }-
parameters.incidentIdstringThe ID of the Incident to fetch.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; affectedComponents: string[]; associations?: object[]; createdDate: Date; description: string; id: string; lastUpdated: Date; schemaVersion: string & object | "1.0"; severity?: { [key: string]: unknown; level: "unknown" | string & object | "P1" | "P2" | "P3" | "P4" | "P5"; }; status: "unknown" | "open" | string & object | "resolved"; summary: string; updateSequenceNumber: number; url: string; }>

operations.getReviewById ​

ts
getReviewById: (parameters, options?) => Promise<{
[key: string]: unknown;
  associations?: object[];
  createdDate: Date;
  description: string;
  id: string;
  lastUpdated: Date;
  reviews: string[];
  schemaVersion: string & object | "1.0";
  status:   | "unknown"
     | "completed"
     | string & object
     | "in progress"
     | "outstanding actions";
  summary: string;
  updateSequenceNumber: number;
  url: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ reviewId: string; }-
parameters.reviewIdstringThe ID of the Review to fetch.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; associations?: object[]; createdDate: Date; description: string; id: string; lastUpdated: Date; reviews: string[]; schemaVersion: string & object | "1.0"; status: | "unknown" | "completed" | string & object | "in progress" | "outstanding actions"; summary: string; updateSequenceNumber: number; url: string; }>

operations.getWorkspaces ​

ts
getWorkspaces: (parameters?, options?) => Promise<{
[key: string]: unknown;
  workspaceIds: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters?{ workspaceId?: string; }-
parameters.workspaceId?stringOptional Operations Workspace ID to retrieve a specific workspace. If omitted, all workspace IDs linked to the Jira site are returned. Example: workspaceId=111-222-333.
options?RequestOptions-
Returns ​

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

operations.submitEntity ​

ts
submitEntity: (parameters, options?) => Promise<{
[key: string]: unknown;
  acceptedIncidents?: string[];
  failedIncidents?: Record<string, object[]>;
  unknownProjectKeys?: string[];
}>;
Parameters ​
ParameterType
parameters{ body: | { incidents?: object[]; } | { reviews?: object[]; }; }
parameters.body| { incidents?: object[]; } | { reviews?: object[]; }
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; acceptedIncidents?: string[]; failedIncidents?: Record<string, object[]>; unknownProjectKeys?: string[]; }>

operations.submitOperationsWorkspaces ​

ts
submitOperationsWorkspaces: (parameters, options?) => Promise<{
[key: string]: unknown;
  acceptedWorkspaceIds?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ workspaceIds: string[]; }-
parameters.workspaceIdsstring[]The IDs of Operations Workspaces that are available to this Jira site.
options?RequestOptions-
Returns ​

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

ts
remoteLinks: object;
ts
deleteRemoteLinkById: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ remoteLinkId: string; }-
parameters.remoteLinkIdstringThe ID of the Remote Link to fetch.
options?RequestOptions-
Returns ​

Promise<void>

ts
deleteRemoteLinksByProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ params?: Record<string, any>; }-
parameters.params?Record<string, any>Free-form query parameters to specify which properties to delete by. Properties refer to the arbitrary information the provider tagged Remote Links with previously. For example, if the provider previously tagged a remote link with accountId: "properties": { "accountId": "account-123" } And now they want to delete Remote Links in bulk by that specific accountId as follows: e.g. DELETE /bulkByProperties?accountId=account-123
options?RequestOptions-
Returns ​

Promise<void>

ts
getRemoteLinkById: (parameters, options?) => Promise<{
[key: string]: unknown;
  actionIds?: string[];
  associations?: (
     | {
   [key: string]: unknown;
     associationType: ... & ... | "issueKeys" | "issueIdOrKeys";
     values: string[];
   }
     | {
   [key: string]: unknown;
     associationType: ... & ... | "serviceIdOrKeys";
     values: string[];
  })[];
  attributeMap?: Record<string, string>;
  description?: string;
  displayName: string;
  id: string;
  lastUpdated: Date;
  schemaVersion?: string & object | "1.0";
  status?: {
   [key: string]: unknown;
     appearance:   | "default"
        | "new"
        | "removed"
        | "success"
        | string & object
        | "prototype"
        | "inprogress"
        | "moved";
     label: string;
  };
  type:   | "other"
     | "document"
     | "alert"
     | string & object
     | "test"
     | "security"
     | "logFile"
     | "prototype"
     | "coverage"
     | "bugReport";
  updateSequenceNumber: number;
  url: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ remoteLinkId: string; }-
parameters.remoteLinkIdstringThe ID of the Remote Link to fetch.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; actionIds?: string[]; associations?: ( | { [key: string]: unknown; associationType: ... & ... | "issueKeys" | "issueIdOrKeys"; values: string[]; } | { [key: string]: unknown; associationType: ... & ... | "serviceIdOrKeys"; values: string[]; })[]; attributeMap?: Record<string, string>; description?: string; displayName: string; id: string; lastUpdated: Date; schemaVersion?: string & object | "1.0"; status?: { [key: string]: unknown; appearance: | "default" | "new" | "removed" | "success" | string & object | "prototype" | "inprogress" | "moved"; label: string; }; type: | "other" | "document" | "alert" | string & object | "test" | "security" | "logFile" | "prototype" | "coverage" | "bugReport"; updateSequenceNumber: number; url: string; }>

ts
submitRemoteLinks: (parameters, options?) => Promise<{
[key: string]: unknown;
  acceptedRemoteLinks?: string[];
  rejectedRemoteLinks?: Record<string, object[]>;
  unknownAssociations?: (
     | {
   [key: string]: unknown;
     associationType: ... & ... | "issueKeys" | "issueIdOrKeys";
     values: string[];
   }
     | {
   [key: string]: unknown;
     associationType: ... & ... | "serviceIdOrKeys";
     values: string[];
  })[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ properties?: Record<string, string>; providerMetadata?: { product?: string; }; remoteLinks: object[]; }-
parameters.properties?Record<string, string>Properties assigned to Remote Link data that can then be used for delete / query operations. Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system. Properties are supplied as key/value pairs, a maximum of 5 properties can be supplied, and keys must not contain ':' or start with '_'.
parameters.providerMetadata?{ product?: string; }Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.
parameters.providerMetadata.product?stringAn optional name of the source of the Remote Links data.
parameters.remoteLinks?object[]A list of Remote Links to submit to Jira. Each Remote Link may be associated with one or more Jira issue keys, and will be associated with any properties included in this request.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; acceptedRemoteLinks?: string[]; rejectedRemoteLinks?: Record<string, object[]>; unknownAssociations?: ( | { [key: string]: unknown; associationType: ... & ... | "issueKeys" | "issueIdOrKeys"; values: string[]; } | { [key: string]: unknown; associationType: ... & ... | "serviceIdOrKeys"; values: string[]; })[]; }>

securityInformation ​

ts
securityInformation: object;

securityInformation.deleteLinkedWorkspaces ​

ts
deleteLinkedWorkspaces: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ workspaceIds: string | string[]; }-
parameters.workspaceIdsstring | string[]Comma-separated list of Security Workspace IDs to delete. All data associated with the given workspaces will eventually be removed from Jira. Example: workspaceIds=111-222-333,444-555-666.
options?RequestOptions-
Returns ​

Promise<void>

securityInformation.deleteVulnerabilitiesByProperty ​

ts
deleteVulnerabilitiesByProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; createdBy?: string; }-
parameters.accountIdstringProperty key used to select which submitted vulnerabilities to delete. Must match a key previously sent in submitVulnerabilities properties (string values, max 5 properties, keys cannot contain ':' or start with '_'). Example: accountId=account-123.
parameters.createdBy?stringOptional additional property filter combined with accountId (AND). Must match a key previously supplied in submitVulnerabilities properties. Example: createdBy=user-456.
options?RequestOptions-
Returns ​

Promise<void>

securityInformation.deleteVulnerabilityById ​

ts
deleteVulnerabilityById: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ vulnerabilityId: string; }-
parameters.vulnerabilityIdstringThe ID of the Vulnerability to delete.
options?RequestOptions-
Returns ​

Promise<void>

securityInformation.getLinkedWorkspaceById ​

ts
getLinkedWorkspaceById: (parameters, options?) => Promise<{
[key: string]: unknown;
  updatedAt: Date;
  workspaceId: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ workspaceId: string; }-
parameters.workspaceIdstringThe ID of the workspace to fetch.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; updatedAt: Date; workspaceId: string; }>

securityInformation.getLinkedWorkspaces ​

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

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

securityInformation.getVulnerabilityById ​

ts
getVulnerabilityById: (parameters, options?) => Promise<{
[key: string]: unknown;
  addAssociations?: object[];
  additionalInfo?: {
   [key: string]: unknown;
     content: string;
     url?: string;
  };
  associationsLastUpdated?: Date;
  associationsUpdateSequenceNumber?: number;
  containerId: string;
  description: string;
  displayName: string;
  id: string;
  identifiers?: object[];
  introducedDate: Date;
  lastUpdated: Date;
  removeAssociations?: object[];
  schemaVersion: string & object | "1.0";
  severity: {
   [key: string]: unknown;
     level: "high" | "low" | "medium" | "unknown" | string & object | "critical";
  };
  status: "unknown" | "closed" | "open" | string & object | "ignored";
  type: "unknown" | string & object | "sca" | "sast" | "dast";
  updateSequenceNumber: number;
  url: string;
}>;
Parameters ​
ParameterTypeDescription
parameters{ vulnerabilityId: string; }-
parameters.vulnerabilityIdstringThe ID of the Vulnerability to fetch.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; addAssociations?: object[]; additionalInfo?: { [key: string]: unknown; content: string; url?: string; }; associationsLastUpdated?: Date; associationsUpdateSequenceNumber?: number; containerId: string; description: string; displayName: string; id: string; identifiers?: object[]; introducedDate: Date; lastUpdated: Date; removeAssociations?: object[]; schemaVersion: string & object | "1.0"; severity: { [key: string]: unknown; level: "high" | "low" | "medium" | "unknown" | string & object | "critical"; }; status: "unknown" | "closed" | "open" | string & object | "ignored"; type: "unknown" | string & object | "sca" | "sast" | "dast"; updateSequenceNumber: number; url: string; }>

securityInformation.submitVulnerabilities ​

ts
submitVulnerabilities: (parameters, options?) => Promise<{
[key: string]: unknown;
  acceptedVulnerabilities?: string[];
  failedVulnerabilities?: Record<string, object[]>;
  unknownAssociations?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ operationType?: string & object | "NORMAL" | "BACKFILL" | "SCAN"; properties?: Record<string, string>; providerMetadata?: { product?: string; }; vulnerabilities: object[]; }-
parameters.operationType?string & object | "NORMAL" | "BACKFILL" | "SCAN"Indicates the operation being performed by the provider system when sending this data. "NORMAL" - Data received during real-time, user-triggered actions (e.g. user closed or updated a vulnerability). "SCAN" - Data sent through some automated process (e.g. some periodically scheduled repository scan). "BACKFILL" - Data received while backfilling existing data (e.g. pushing historical vulnerabilities when re-connect a workspace). Default is "NORMAL". "NORMAL" traffic has higher priority but tighter rate limits, "SCAN" traffic has medium priority and looser limits, "BACKFILL" has lower priority and much looser limits
parameters.properties?Record<string, string>Properties assigned to vulnerability data that can then be used for delete / query operations. Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system. Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.
parameters.providerMetadata?{ product?: string; }Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. Information in this property is not considered private, so it should not contain personally identifiable information
parameters.providerMetadata.product?stringAn optional name of the source of the vulnerabilities.
parameters.vulnerabilities?object[]-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; acceptedVulnerabilities?: string[]; failedVulnerabilities?: Record<string, object[]>; unknownAssociations?: object[]; }>

securityInformation.submitWorkspaces ​

ts
submitWorkspaces: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ workspaceIds: string[]; }-
parameters.workspaceIdsstring[]The IDs of Security Workspaces to link to this Jira site. These must follow this regex pattern: [a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*
options?RequestOptions-
Returns ​

Promise<void>

sprint ​

ts
sprint: object;

sprint.createSprint ​

ts
createSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  completeDate?: Date;
  createdDate?: Date;
  endDate?: Date;
  goal?: string;
  id?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: Date;
  state: "active" | "closed" | string & object | "future";
}>;
Parameters ​
ParameterType
parameters{ endDate?: string | Date; goal?: string; name: string; originBoardId?: number; startDate?: string | Date; }
parameters.endDate?string | Date
parameters.goal?string
parameters.name?string
parameters.originBoardId?number
parameters.startDate?string | Date
options?RequestOptions
Returns ​

Promise<{ [key: string]: unknown; completeDate?: Date; createdDate?: Date; endDate?: Date; goal?: string; id?: number; name?: string; originBoardId?: number; self?: string; startDate?: Date; state: "active" | "closed" | string & object | "future"; }>

sprint.deleteProperty ​

ts
deleteProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ propertyKey: string; sprintId: string; }-
parameters.propertyKeystringThe key of the property to remove.
parameters.sprintId?stringThe ID of the sprint from which the property will be removed.
options?RequestOptions-
Returns ​

Promise<void>

sprint.deleteSprint ​

ts
deleteSprint: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ sprintId: number; }-
parameters.sprintIdnumberThe ID of the sprint to delete.
options?RequestOptions-
Returns ​

Promise<void>

sprint.getIssuesForSprint ​

ts
getIssuesForSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  isLast: boolean;
  issues: object[];
  names?: Record<string, string>;
  nextPageToken?: string;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  warningMessages?: string[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ expand?: string | string[]; fields?: Record<string, any>[]; jql?: string; maxResults?: number; nextPageToken?: string; reconcileIssues?: number[]; sprintId: number; validateQuery?: boolean; }-
parameters.expand?string | string[]A comma-separated list of the parameters to expand.
parameters.fields?Record<string, any>[]The list of fields to return for each issue. By default, all navigable and Software project fields are returned.
parameters.jql?stringFilters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
parameters.maxResults?numberThe maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. 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.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.
parameters.sprintId?numberThe ID of the sprint that contains the requested issues.
parameters.validateQuery?booleanSpecifies whether to validate the JQL query or not. Default: true.
options?RequestOptions-
Returns ​

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

sprint.getPropertiesKeys ​

ts
getPropertiesKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ sprintId: string; }-
parameters.sprintIdstringThe ID of the sprint from which property keys will be returned.
options?RequestOptions-
Returns ​

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

sprint.getProperty ​

ts
getProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key: string;
  value: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ propertyKey: string; sprintId: string; }-
parameters.propertyKeystringThe key of the property to return.
parameters.sprintId?stringThe ID of the sprint from which the property will be returned.
options?RequestOptions-
Returns ​

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

sprint.getSprint ​

ts
getSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  completeDate?: Date;
  createdDate?: Date;
  endDate?: Date;
  goal?: string;
  id?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: Date;
  state: "active" | "closed" | string & object | "future";
}>;
Parameters ​
ParameterTypeDescription
parameters{ sprintId: number; }-
parameters.sprintIdnumberThe ID of the requested sprint.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; completeDate?: Date; createdDate?: Date; endDate?: Date; goal?: string; id?: number; name?: string; originBoardId?: number; self?: string; startDate?: Date; state: "active" | "closed" | string & object | "future"; }>

sprint.moveIssuesToSprintAndRank ​

ts
moveIssuesToSprintAndRank: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ issues?: string[]; rankAfterIssue?: string; rankBeforeIssue?: string; rankCustomFieldId?: number; sprintId: number; }-
parameters.issues?string[]-
parameters.rankAfterIssue?string-
parameters.rankBeforeIssue?string-
parameters.rankCustomFieldId?number-
parameters.sprintId?numberThe ID of the sprint that you want to assign issues to.
options?RequestOptions-
Returns ​

Promise<void>

sprint.partiallyUpdateSprint ​

ts
partiallyUpdateSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  completeDate?: Date;
  createdDate?: Date;
  endDate?: Date;
  goal?: string;
  id?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: Date;
  state: "active" | "closed" | string & object | "future";
}>;
Parameters ​
ParameterTypeDescription
parameters{ completeDate?: string | Date; createdDate?: string | Date; endDate?: string | Date; goal?: string; id?: number; name?: string; originBoardId?: number; sprintId: number; startDate?: string | Date; state?: string; }-
parameters.completeDate?string | Date-
parameters.createdDate?string | Date-
parameters.endDate?string | Date-
parameters.goal?string-
parameters.id?number-
parameters.name?string-
parameters.originBoardId?number-
parameters.sprintId?numberThe ID of the sprint to update.
parameters.startDate?string | Date-
parameters.state?string-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; completeDate?: Date; createdDate?: Date; endDate?: Date; goal?: string; id?: number; name?: string; originBoardId?: number; self?: string; startDate?: Date; state: "active" | "closed" | string & object | "future"; }>

sprint.setProperty ​

ts
setProperty: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ propertyKey: string; propertyValue: Record<string, any>; sprintId: string; }-
parameters.propertyKeystringThe key of the sprint's property. The maximum length of the key is 255 bytes.
parameters.propertyValue?Record<string, any>-
parameters.sprintId?stringThe ID of the sprint on which the property will be set.
options?RequestOptions-
Returns ​

Promise<void>

sprint.swapSprint ​

ts
swapSprint: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ sprintId: number; sprintToSwapWith?: number; }-
parameters.sprintIdnumberThe ID of the sprint to swap.
parameters.sprintToSwapWith?number-
options?RequestOptions-
Returns ​

Promise<void>

sprint.updateSprint ​

ts
updateSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  completeDate?: Date;
  createdDate?: Date;
  endDate?: Date;
  goal?: string;
  id?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: Date;
  state: "active" | "closed" | string & object | "future";
}>;
Parameters ​
ParameterTypeDescription
parameters{ completeDate?: string | Date; createdDate?: string | Date; endDate?: string | Date; goal?: string; id?: number; name: string; originBoardId?: number; sprintId: number; startDate?: string | Date; state: string; }-
parameters.completeDate?string | Date-
parameters.createdDate?string | Date-
parameters.endDate?string | Date-
parameters.goal?string-
parameters.id?number-
parameters.name?string-
parameters.originBoardId?number-
parameters.sprintId?numberThe ID of the sprint to update.
parameters.startDate?string | Date-
parameters.state?string-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; completeDate?: Date; createdDate?: Date; endDate?: Date; goal?: string; id?: number; name?: string; originBoardId?: number; self?: string; startDate?: Date; state: "active" | "closed" | string & object | "future"; }>