RUrunway
release

Get StepRun by StepConfig and Release

Returns the details of a step run for a given step config and release. The step run is looked up using the release's FlightPath run and the step config. Only available for apps with FlightPaths enabled.

get/app/{appId}/stepConfig/{stepConfigId}/release/{releaseId}/stepRun

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/stepConfig/{stepConfigId}/release/{releaseId}/stepRun
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

stepConfigIdstring required

The id of the step config (FlightPaths). A step config defines a step in the release FlightPath.

releaseIdstring required

The id of the release. Constructed from the app's id and the release version like so: {appId}:{version}. For the GET single release endpoint, the following keywords are also accepted: live (latest completed release), next or current (current active release).

Response

A step run response

idstring required

The identifier of the step run

stepConfigIdstring required

The identifier of the step config this step run was created from

stepArchetype'kickoff' | 'featureReadiness' | 'releaseCandidate' | 'regressionTesting' | 'betaTesting' | 'metadata' | 'screenshots' | 'approvals' | 'submission' | 'storeReview' | 'takeoff' | 'ciDistribution' required

The type of release step

displayNamestring required

The display name of the step run

status'ready' | 'pending' | 'pendingChecklist' | 'blocked' | 'inactive' required

The status of a release step

statusReasonStringstring required

The user-friendly description of the reason for the status of the step run

Example response

{
  "checklistItems": [
    {
      "title": "Gather new release notes",
      "description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
      "oneOffForVersion": "1.1.0",
      "status": {
        "createdAt": "2022-03-02T01:15:00Z"
      }
    }
  ],
  "data": {
    "approvalItems": [
      {
        "title": "Gather new release notes",
        "description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
        "oneOffForVersion": "1.1.0",
        "status": {
          "createdAt": "2022-03-02T01:15:00Z"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.