Class DevelopmentInformationService

APIs related to integrating development information (commits, branches and pull requests) with Jira. These APIs are available to Atlassian Connect apps and on-premise integrations using OAuth. Connect apps using these APIs must have the Development Tool module in the app descriptor, see https://developer.atlassian.com/cloud/jira/software/modules/development-tool/. For more details on integrating Jira Software Cloud with on-premises tools using OAuth 2.0 credentials, see https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/.

See

https://developer.atlassian.com/cloud/jira/software/rest/api-group-development-information

Hierarchy

CommonHttpService
- DevelopmentInformationService

Index

Constructors

constructor

Methods

deleteByProperties deleteEntity deleteRepository existsByProperties getRepository storeDevelopmentInformation initialize

Constructors

constructor

new DevelopmentInformationService(getClientInstance): DevelopmentInformationService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns DevelopmentInformationService
Inherited from CommonHttpService.constructor

Methods

deleteByProperties

deleteByProperties(params): Promise<void>
Deletes development information entities which have all the provided properties. Repositories which have properties that match ALL of the properties (i.e. treated as an AND), and all their related development information (such as commits, branches and pull requests), will be deleted. For example if request is DELETE bulk?accountId=123&projectId=ABC entities which have properties accountId=123 and projectId=ABC will be deleted. Optional param _updateSequenceId is no longer supported. Deletion is performed asynchronously: specified entities will eventually be removed from Jira.
Parameters
- params: {
  authorization: string;
  updateSequenceId?: number;
  }
  - authorization: string
    All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
  - OptionalupdateSequenceId?: number
    An 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.
Returns Promise<void>
Path
DELETE /rest/devinfo/0.10/bulkByProperties

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-development-information#api-rest-devinfo-0-10-bulkbyproperties-delete

deleteEntity

deleteEntity(params): Promise<void>
Deletes particular development information entity. Deletion is performed asynchronously.
Parameters
- params: {
      authorization: string;
      entityId: string;
      entityType: "commit" | "branch" | "pull_request";
      repositoryId: string;
      updateSequenceId?: number;
  }
  - authorization: string
    All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
  - entityId: string
  - entityType: "commit" | "branch" | "pull_request"
  - repositoryId: string
  - OptionalupdateSequenceId?: number
    An 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.
Returns Promise<void>
Path
DELETE /rest/devinfo/0.10/repository/{repositoryId}/{entityType}/{entityId}

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-development-information#api-rest-devinfo-0-10-repository-repositoryid-entitytype-entityid-delete

deleteRepository

deleteRepository(params): Promise<void>
Deletes the repository data stored by the given ID and all related development information entities. Deletion is performed asynchronously.
Parameters
- params: {
      authorization: string;
      repositoryId: string;
      updateSequenceId?: number;
  }
  - authorization: string
    All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
  - repositoryId: string
    The ID of repository to delete
  - OptionalupdateSequenceId?: number
    An 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.
Returns Promise<void>
Path
DELETE /rest/devinfo/0.10/repository/{repositoryId}

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-development-information#api-rest-devinfo-0-10-repository-repositoryid-delete

existsByProperties

existsByProperties(params): Promise<ExistsForPropertiesResponse>
Checks if repositories which have all the provided properties exists. For example, if request is GET existsByProperties?accountId=123&projectId=ABC then result will be positive only if there is at least one repository with both properties accountId=123 and projectId=ABC. Special property _updateSequenceId can be used to filter all entities with updateSequenceId less or equal than the value specified. In addition to the optional _updateSequenceId, one or more query params must be supplied to specify properties to search by.
Parameters
- params: {
  authorization: string;
  updateSequenceId?: number;
  }
  - authorization: string
    All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
  - OptionalupdateSequenceId?: number
    An optional property. Filters out entities and repositories which have updateSequenceId greater than specified.
Returns Promise<ExistsForPropertiesResponse>
Returns whether data exists for the specified properties.

Path
GET /rest/devinfo/0.10/existsByProperties

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-development-information#api-rest-devinfo-0-10-existsbyproperties-get

getRepository

getRepository(params): Promise<Repository>
For the specified repository ID, retrieves the repository and the most recent 400 development information entities. The result will be what is currently stored, ignoring any pending updates or deletes.
Parameters
- params: {
  authorization: string;
  repositoryId: string;
  }
  - authorization: string
    All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
  - repositoryId: string
    The ID of repository to fetch
Returns Promise<Repository>
The repository data currently stored for the given ID.

Path
GET /rest/devinfo/0.10/repository/{repositoryId}

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-development-information#api-rest-devinfo-0-10-repository-repositoryid-get

storeDevelopmentInformation

storeDevelopmentInformation(params): Promise<StoreDevinfoResult>
Stores development information provided in the request to make it available when viewing issues in Jira. Existing repository and entity data for the same ID will be replaced if the updateSequenceId of existing data is less than the incoming data. Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times.
Parameters
- params: {
  authorization: string;
  devInformation: DevInformation;
  }
  - authorization: string
    All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
  - devInformation: DevInformation
    Request object, which contains development information
Returns Promise<StoreDevinfoResult>
Submission accepted. Each submitted repository and entity that is of a valid format will be eventually available in Jira.

Path
POST /rest/devinfo/0.10/bulk

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-development-information#api-rest-devinfo-0-10-bulk-post

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class DevelopmentInformationService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns DevelopmentInformationService

Methods

deleteByProperties

Parameters

authorization: string

OptionalupdateSequenceId?: number

Returns Promise<void>

Path

See

deleteEntity

Parameters

authorization: string

entityId: string

entityType: "commit" | "branch" | "pull_request"

repositoryId: string

OptionalupdateSequenceId?: number

Returns Promise<void>

Path

See

deleteRepository

Parameters

authorization: string

repositoryId: string

OptionalupdateSequenceId?: number

Returns Promise<void>

Path

See

existsByProperties

Parameters

authorization: string

OptionalupdateSequenceId?: number

Returns Promise<ExistsForPropertiesResponse>

Path

See

getRepository

Parameters

authorization: string

repositoryId: string

Returns Promise<Repository>

Path

See

storeDevelopmentInformation

Parameters

authorization: string

devInformation: DevInformation

Returns Promise<StoreDevinfoResult>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`updateSequenceId?: number

`Optional`updateSequenceId?: number

`Optional`updateSequenceId?: number

`Optional`updateSequenceId?: number

`Protected` `Static`initialize