API Reference

Description

Returns a list of all previous chain runs that match the provided criteria. The environment IDs specify which environments should be searched for the chain run. The chain IDs specify which specific chains should be returned. The state specified returns only those chains that are in that state (e.g. "completed"). If a cursor is provided, the corresponding page will be returned.

GET /v1/execute/chain_run/search

Parameters

ParameterInTypeRequiredDescription
environment_idqueryarray[string]falseThe ID(s) of the Environments to search.
chain_idqueryarray[string]falseThe ID(s) of the Chains to return.
start_datequerystringfalseStart Date (Unix timestamp).
end_datequerystringfalseEnd Date (Unix timestamp).
statequerystringfalseThe state of the Chain Run.
sortquerystringfalseSort direction (by date).
cursorquerystringfalseCursor value returned from the API, indicating page information.

Enumerated Values

ParameterValue
staterunning
statesucceeded
statefailed
statepaused
statewarned
statecompleted
sortdesc
sortasc

Code Samples

curl -X GET https://h.app.wdesk.com/s/wdata/oc/api/v1/execute/chain_run/search  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http GET https://h.app.wdesk.com/s/wdata/oc/api/v1/execute/chain_run/search  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=GET "https://h.app.wdesk.com/s/wdata/oc/api/v1/execute/chain_run/search" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://h.app.wdesk.com/s/wdata/oc/api/v1/execute/chain_run/search', headers = headers)

print(r.json())

Returns

200 - OK

Returns a ChainRunPageResponse containing the ChainRunPage object based on search filters.

Example Responses


{
  "data": {
    "cursor": "string",
    "chainExecutors": [
      {
        "id": "1",
        "chainId": "37",
        "envId": "1154",
        "userId": "5",
        "userName": "dev23",
        "startAt": "2019-02-08 06:25:00",
        "endAt": "2019-02-12 06:25:00",
        "pausedAt": "2019-02-12 06:25:00",
        "resumedAt": "2019-02-12 06:25:00",
        "state": "sleeping",
        "launchType": "manual",
        "resultText": "success"
      }
    ]
  }
}