Read Build Action Information
Get information about a specific action Xcode Cloud performed as part of a build.
URL
GET https://api.appstoreconnect.apple.com/v1/ciBuildActions/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The opaque resource ID that uniquely identifies the Build Actions resource. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[ciBuildActions] Optional | [string] | Additional fields to include for the Build Actions resource returned by the response. |
include Optional | [string] | The relationship data to include in the response. |
fields[ciBuildRuns] Optional | [string] | Additional fields to include for the Build Actions resource returned by the response. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | CiBuildActionResponse | The request completed successfully. |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | An error occurred with your request. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Request not authorized. |
| 404 | Not Found Content-Type: application/json | ErrorResponse | Resource not found. |
| 429 | Content-Type: application/json | ErrorResponse |
Discussion
The example request below retrieves detailed information about an action Xcode Cloud performed. It also requests detailed information about the action’s build by including the Build Runs resource in the query. Use the information provided in the response to display information on a dashboard or to access additional information; for example, information about other actions Xcode Cloud performed during the build.
Example Request and Response
See Also
Getting Build Actions
List All Artifacts for a Build ActionRead the Xcode Cloud Build Information for a Build ActionList All Issues for a Build ActionList All Test Results for an Xcode Cloud Test ActionGET /v1/ciBuildActions/{id}/relationships/artifactsGET /v1/ciBuildActions/{id}/relationships/buildRunGET /v1/ciBuildActions/{id}/relationships/issuesGET /v1/ciBuildActions/{id}/relationships/testResults