Class BuildsService

APIs related to integrating builds data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the Build module see https://developer.atlassian.com/cloud/jira/software/modules/build/ in your app's descriptor. They are also related to 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-builds

Hierarchy

  • CommonHttpService
    • BuildsService

Constructors

constructor

Methods

deleteBuildByKey deleteBuildsByProperty getBuildByKey submitBuilds initialize

Constructors

constructor

  • new BuildsService(getClientInstance): BuildsService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns BuildsService

Methods

deleteBuildByKey

  • deleteBuildByKey(params): Promise<void>

  • Delete the build data currently stored for the given pipelineId and buildNumber combination.

    Deletion is performed asynchronously. The getBuildByKey operation can be used to confirm that data has been deleted successfully (if needed).

    Only Connect apps that define the jiraBuildInfoProvider module, and on-premise integrations, can access this resource. This resource requires the 'DELETE' scope for Connect apps.

    Parameters

    • params: {
          authorization: string;
          buildNumber: number;
          pipelineId: string;
          updateSequenceNumber?: 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 Connect JWT token corresponds to an app that does not define jiraBuildInfoProvider 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.

      • buildNumber: number

        The buildNumber of the build to delete.

      • pipelineId: string

        The pipelineId of the build to delete.

      • OptionalupdateSequenceNumber?: number

        This parameter usage is no longer supported.

        An optional _updateSequenceNumber to use to control deletion.

        Only stored data with an updateSequenceNumber less than or equal to that provided will be deleted. This can be used help ensure submit/delete requests are applied correctly if issued close together.

        Deprecated

    Returns Promise<void>

    Path

    DELETE /rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-builds#api-rest-builds-0-1-pipelines-pipelineid-builds-buildnumber-delete

deleteBuildsByProperty

  • deleteBuildsByProperty(params): Promise<void>

  • Bulk delete all builds data that match the given request.

    One or more query params must be supplied to specify Properties to delete by. Optional param _updateSequenceNumber is no longer supported. If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND).

    See the documentation for the submitBuilds operation for more details.

    e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345

    Deletion is performed asynchronously. The getBuildByKey operation can be used to confirm that data has been deleted successfully (if needed).

    Only Connect apps that define the jiraBuildInfoProvider module, and on-premise integrations, can access this resource. This resource requires the 'DELETE' scope for Connect apps.

    Parameters

    • params: {
          authorization: string;
          updateSequenceNumber?: 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 Connect JWT token corresponds to an app that does not define jiraBuildInfoProvider 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.

      • OptionalupdateSequenceNumber?: number

        This parameter usage is no longer supported.

        An optional _updateSequenceNumber to use to control deletion.

        Only stored data with an updateSequenceNumber less than or equal to that provided will be deleted. This can be used help ensure submit/delete requests are applied correctly if issued close together.

        If not provided, all stored data that matches the request will be deleted.

        Deprecated

    Returns Promise<void>

    Path

    DELETE /rest/builds/0.1/bulkByProperties

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-builds#api-rest-builds-0-1-bulkbyproperties-delete

getBuildByKey

submitBuilds

  • submitBuilds(params): Promise<SubmitBuildsResponse>

  • Update / insert builds data.

    Builds are identified by the combination of pipelineId and buildNumber, and existing build data for the same build will be replaced if it exists and the updateSequenceNumber of the 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. The getBuildByKey operation can be used to confirm that data has been stored successfully (if needed).

    In the case of multiple builds being submitted in one request, each is validated individually prior to submission. Details of which build failed submission (if any) are available in the response object.

    Only Connect apps that define the jiraBuildInfoProvider module, and on-premise integrations, can access this resource. This resource requires the 'WRITE' scope for Connect apps.

    Parameters

    Returns Promise<SubmitBuildsResponse>

    Submission accepted. Each submitted build that is of a valid format will be eventually available in Jira.

    Details of which builds were submitted and which failed submission (due to data format problems etc.) are available in the response object.

    Path

    POST /rest/builds/0.1/bulk

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-builds#api-rest-builds-0-1-bulk-post

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods