Help Center> CodeArts Build> API Reference> Task APIs> API for Obtaining Construction History Details

Updated on 2023-12-06 GMT+08:00

View PDF

API for Obtaining Construction History Details

Function

Calling Method

For details, see Calling APIs.

URI

GET /v3/jobs/{job_id}/{build_number}/history-details

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
job_id	Yes	String	Indicates the ID of the build task. The value is a string of 32 characters consisting of digits and letters at the end of the browser URL when you edit the build task file.
build_number	Yes	Integer	build task build ID, which starts from 1 and increases by 1 for each build.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Obtain the value by calling the IAM service interface. (value of X-Subject-Token in the response header). Global tenant tokens are not supported. Use a region-level token whose scope is project.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
job_name	String	build task Name
build_number	Integer	Build ID
project_id	String	ID of the project to which the build task belongs.
project_name	String	Name of the project to which the build task belongs.
parameters	Map<String,String>	Parameter of the Map type. For sensitive parameter values, asterisks (*) are returned.
build_steps	Array of build_steps objects	Details about the build step of the task. The returned step is visible on the page.

**Table 4** build_steps
Parameter	Type	Description
name	String	Procedure name.
status	String	Specifies the step status. The value can be running, success, error, or an empty string.
build_time	Integer	Step execution duration, in milliseconds.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Example Requests

GET https://{endpoint}/v3/jobs/901878212b1a49be9c1a1054c272762a/1/history-details

Example Responses

Status code: 200

{
  "job_name" : "Test Task 01",
  "build_number" : 5,
  "project_id" : "6ecbc5bac7c8442fb3d2563d53c13582",
  "project_name" : "test-project",
  "parameters" : [ {
    "static_limit_param_name" : "static_limit_param_value_1",
    "sentive_param_name" : "******",
    "no_static_param_name" : "no_static_param_value",
    "static_param_name" : "static_param_value",
    "no_static_limit_param_name" : "no_static_limit_param_value_1"
  } ],
  "build_steps" : [ {
    "name" : "Code checkout",
    "status" : "success",
    "build_time" : 8366
  }, {
    "name" : "Uploading Software Packages to CloudRelease",
    "status" : "",
    "build_time" : 0
  } ]
}