Sign in
workflow-run-controller

Changed on
get/api/workflows/branch

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workflows/branch
  • Auth: none declared

Query parameters

branchstring required

Response

OK

idinteger required
namestring required
displayTitlestring required
status'QUEUED' | 'IN_PROGRESS' | 'COMPLETED' | 'ACTION_REQUIRED' | 'CANCELLED' | 'FAILURE' | 'NEUTRAL' | 'SKIPPED' | 'STALE' | 'SUCCESS' | 'TIMED_OUT' | 'REQUESTED' | 'WAITING' | 'PENDING' | 'UNKNOWN' required
workflowIdinteger required
conclusion'ACTION_REQUIRED' | 'CANCELLED' | 'FAILURE' | 'NEUTRAL' | 'SUCCESS' | 'SKIPPED' | 'STALE' | 'TIMED_OUT' | 'STARTUP_FAILURE' | 'UNKNOWN'
htmlUrlstring required
label'NONE' | 'TEST' required
testProcessingStatus'PROCESSING' | 'PROCESSED' | 'FAILED' nullable
headBranchstring nullable
headShastring nullable
runStartedAtstring date-time nullable
createdAtstring date-time required
updatedAtstring date-time required

Changes

  • ebc5b15b4477Revision changes
    • ▲

      the response property / became nullable for the status

    • ▲

      the response property / became nullable for the status

    • ▲

      the response property / became nullable for the status

    • ▲

      the response property / became nullable for the status

  • a5266332cfdfRevision changes
    • ○

      added the optional property / to the response with the status

    • ○

      added the optional property / to the response with the status

    • ○

      added the optional property / to the response with the status

    • ○

      added the required property / to the response with the status

    • ○

      added the required property / to the response with the status