Help Center/ ServiceStage/ API Reference/ Historical APIs/ Build APIs/ Obtaining the Build Job List Based on the Component Name

Updated on 2024-11-27 GMT+08:00

View PDF

Obtaining the Build Job List Based on the Component Name

Function

This API is used to obtain the build job list based on the component name.

URI

GET /assembling/v1/jobs?page={page}&per_page={per_page}&job_name={job_name}

Table 1 describes the parameters.

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
page	Yes	Integer	Page index, indicating the page from which the query starts.
per_page	Yes	Integer	Page size, indicating the number of records on a page.
job_name	No	String	Build job name, which is the same as the custom component name. See Obtaining All Components of an Application.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default value: application/json;charset=utf8.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

Response

**Table 3** Response parameters
Parameter	Type	Description
list	Array of object	Build phase structure. See Table 4.
total	Integer	Number of build phases.
page	Integer	Page size, indicating the number of records on a page.
per_page	Integer	Page index, indicating the page from which the query starts.

**Table 4** list
Parameter	Type	Description
job_id	String	Build job ID.
job_name	String	Build job name, which is the same as the custom component name.

Example Request

None

Example Response

{
    "total": 12,
    "per_page": 6,
    "page": 1,
    "list": [
        {
            "job_id": "swpfk3wtzdjnlyely4rf40k52zyuq5s4lha9ch8f",
            "job_name": "test1"
        }
    ]
}