Check build promotion status

Learn how to use the Build Promoter API to check the status of promoted builds.

All sample requests in this guide include the following path parameters:

Parameter name	Description
tenantId	Tenant ID.
starSystemId	ID of the logical star system that includes the InsuranceSuite, EnterpriseEngage, or Solr (Advanced Search) applications.
applicationId	InsuranceSuite, EnterpriseEngage, or Solr application which includes the build. For example: - PC for PolicyCenter - BC for BillingCenter - CC for ClaimCenter - CM for ContactManager - pc-solr for Solr for PolicyCenter - cc-solr for Solr for ClaimCenter

About build promotion status

After promoting a build, you can check a build promotion status. You can check status of recently started and finished promote build jobs. Older promote build jobs are removed from a repository after 5 minutes.

You can check the following statuses:

• A status of all the promote build jobs that are available in a star system.
• A status of a particular promote build job based on its ID.

Note:

To check a status of a promote build job, you need a promote build job ID. You can get this ID by performing one of the following actions:

• Triggering a build promotion and getting ID in the response.
• Checking status of all the promote build jobs available in a star system.

A promote build job can have one of the following statuses:

• IN_PROGRESS
• COMPLETED
• FAILED

Check status of all the promote build jobs

To check the status of all the promote build jobs that are available in a star system, send the following GET request:

curl -X 'GET' \
  '{baseURL}/api/v2/tenants/{tenantId}/logicalStarSystems/{starSystemId}/applications/{applicationId}/promoteBuildJobs' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

You can narrow down the results using a status query parameter. For example, to list all the promote build jobs with IN_PROGRESS status, send the following GET request:

curl -X 'GET' \
  '{baseURL}/api/v2/tenants/{tenantId}/logicalStarSystems/{starSystemId}/applications/{applicationId}/promoteBuildJobs?status=IN_PROGRESS' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

A response contains an array with a list of statuses of all the promote build jobs with the IN_PROGRESS status that are available in the star system.

Example response

[
  {
    "id": "string",
    "status": "IN_PROGRESS",
    "buildId": "string",
    "targetPlanetClass": "prod",
    "targetStarSystemClass": "prod"
  }
]

Important:

Currently, the targetPlanetClass parameter displays the same values as the targetStarSystemClass parameter. The targetPlanetClass parameter is deprecated and Guidewire recommends using the targetStarSystemClass parameter instead.

You can use a promote build job ID to verify the status of a particular build.

Check status of a particular promote build job

To verify a status of a particular promote job based on its ID, send the following GET request:

curl -X 'GET' \
  '{baseURL}/api/v2/tenants/{tenantId}/logicalStarSystems/{starSystemId}/applications/{application}/promoteBuildJobs/<promoteBuildJobId>' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

A response contains a JSON object with information about the given promote job status.

Example response

{
  "id": "string",
  "status": "IN_PROGRESS",
  "buildId": "string",
  "targetPlanetClass": "prod",
  "targetStarSystemClass": "prod"
}

Important:

Currently, the targetPlanetClass parameter displays the same values as the targetStarSystemClass parameter. The targetPlanetClass parameter is deprecated and Guidewire recommends using the targetStarSystemClass parameter instead.

Once the promote build job status is COMPLETED, you can use the promoted build for deployment in the higher star system class. For details, see IS Deployment API, EE Deployment API, or Deploy Solr instance.