Help Center> CodeArts Build> API Reference> Out-of-DateAPIs (Unavailable Soon)> Obtaining a Directed Acyclic Graph of Build Records (To Be Offline)
Updated on 2023-12-06 GMT+08:00

Obtaining a Directed Acyclic Graph of Build Records (To Be Offline)

Function

Obtaining a Directed Acyclic Graph of Build Records (To Be Offline)

Calling Method

For details, see Calling APIs.

URI

GET /v3/{build_flow_record_id}/flow-graph

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

build_flow_record_id

Yes

String

Parent Task Construction Record ID

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

success

Boolean

Status

message

String

Message

err_code

String

Error code.

result

result object

Result

Table 4 result

Parameter

Type

Description

edges

Array of edges objects

edges

vertices

Array of Vertices objects

Record information

Table 5 edges

Parameter

Type

Description

from

String

Dependent Subtask ID

to

String

ID of the depended subtask.

Table 6 Vertices

Parameter

Type

Description

id

String

Subtask Construction Record ID

status

String

Subtask Execution Status

display_name

String

Specifies the subtask name.

build_duration

Integer

Subtask Construction Duration

start_time

String

Start time of a sub-job.

finish_time

String

End time of a sub-job.

build_no

String

Subtask Construction ID

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

GET https://{endpoint}/v3/2ab0e6a3-3e1a-4708-bb16-fff2b0999027/flow-graph

Example Responses

Status code: 200

OK

{
  "success" : true,
  "result" : {
    "edges" : [ {
      "from" : "d5587caf-05d7-42af-8ed2-daa20eb1de1b",
      "to" : "af81a8ff-1d53-4e0a-9108-fa7880366e73"
    } ],
    "vertices" : [ {
      "id" : "7607d919-6c21-43b3-a06e-ee016ff8e7c7",
      "status" : "SUCCESS",
      "display_name" : "job4",
      "build_duration" : 38156,
      "start_time" : "2020-12-30T17:33:11+08:00",
      "finish_time" : "2020-12-30T17:33:27+08:00",
      "build_no" : "535"
    } ]
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.