Fetch Continuous Integration run

Version 4.0.25.8 (latest)

Fetches a CI Run.

Request

GET /projects/{project_id}/ci/runs/{run_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
project_id
string
Project Id
run_id
string
Run Id
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields

Response

200: CI Run

Datatype
Description
(object)
run
Continuous Integration run results
Expand CIRun definition...
run_id
string
ID of the CI run
created_at
string
Time and date that the CI run was initiated
started_at
string
Time and date that the CI run began executing
finished_at
string
Time and date that the CI run completed
status_url
string
Git provider URL where you can view the commit status. This is the status URL that you specify when you create a CI suite
status
string
Status of the CI run (unknown, failed, passed, skipped, errored, cancelled, queued, running)
git_service
string
Git service for CI run (e.g. GitHub)
git_state
Git state information for the CI run
Expand CIGitState definition...
branch
string
Git branch that the CI run validates
repository
string
Git repository that contains the Git branch being validated
commit_ref
string
Git commit that the CI run validates
target
string
For incremental runs, the Git branch that the CI run compares against during validation
result
Results of the CI run
Expand CIRunResult definition...
sql_result
Results of the SQL validation
sql_error
Errors that occurred when attempting SQL validation
assert_result
Results of the assert validation
assert_error
Errors that occurred when attempting assert validation
content_result
Results of the content validation
content_error
Errors that occurred when attempting content validation
lookml_result
Results of the LookML validation
lookml_error
Errors that occurred when attempting LookML validation
generic_error
Errors that occurred when attempting validation
schedule
Schedule for CI run
Expand CIScheduleTrigger definition...
enabled
boolean
Whether the CI run schedule is active
day
string
For scheduled runs, day of the week that the CI run is scheduled
hour
string
For schedules runs, the hour of the day (24 hour format) that the CI run is scheduled
frequency
string
For scheduled runs, how often the CI run is scheduled to run (hourly, daily, weekly)
target_branch
string
Git branch that the CI run compares against during validation, used for incremental runs
title
string
Name of the CI suite
trigger
string
Trigger for CI run (unknown, manual, schedule, change_request)
change_request
Details of the change request, if the CI run was triggered by a change request
Expand CIChangeRequest definition...
change_request_number
integer
Numeric identifier of the change request
change_request_url
string
URL of the change request
change_request_name
string
Name of the change request
change_request_commits_url
string
For PR-triggered CI runs, the URL to the change request commit that triggered the run.
suite_id
string
ID of the CI suite
username
string
Username of the user who triggered the CI run, if the CI run was manually triggered

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link