Chilkat Online Tools

C# / Cognite API v1 / List extraction pipeline runs

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateInt("limit",100);

http.SetRequestHeader("api-key","{{api-key}}");

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://domain.com/api/v1/projects/{{project}}/extpipes/runs",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Debug.WriteLine(Convert.ToString(resp.StatusCode));
Debug.WriteLine(resp.BodyStr);

Curl Command

curl -G -d "limit=100"
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/extpipes/runs

Postman Collection Item JSON

{
  "id": "runs",
  "name": "List extraction pipeline runs",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "extpipes",
        "runs"
      ],
      "query": [
        {
          "key": "externalId",
          "disabled": true
        },
        {
          "key": "limit",
          "description": "Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.",
          "value": "100",
          "disabled": true
        },
        {
          "key": "cursor",
          "description": "Cursor for paging through results.",
          "disabled": true
        }
      ],
      "variable": [
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ],
    "description": "List of all extraction pipeline runs for a given extraction pipeline. Sorted by createdTime value with descendant order."
  }
}