Chilkat Online Tools

VB.NET / Cognite API v1 / Create 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.

Dim http As New Chilkat.Http
Dim success As Boolean

' Use this online tool to generate code from sample JSON: Generate Code to Create JSON

' The following JSON is sent in the request body.

' {
'   "items": [
'     {
'       "externalId": "eu incididunt deserunt",
'       "status": "seen",
'       "message": "commodo",
'       "createdTime": 20868621
'     }
'   ]
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("items[0].externalId","eu incididunt deserunt")
json.UpdateString("items[0].status","seen")
json.UpdateString("items[0].message","commodo")
json.UpdateInt("items[0].createdTime",20868621)

http.SetRequestHeader("content-type","application/json")
http.SetRequestHeader("api-key","{{api-key}}")

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/extpipes/runs","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "eu incididunt deserunt",
            "status": "seen",
            "message": "commodo",
            "createdTime": 20868621
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/extpipes/runs

Postman Collection Item JSON

{
  "id": "createRuns",
  "name": "Create extraction pipeline runs",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "extpipes",
        "runs"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "description": "Create multiple extraction pipeline runs. Current version supports one extraction pipeline run per request. Extraction pipeline runs support three statuses: success, failure, seen. The content of the Error Message parameter is configurable and will contain any messages that have been configured within the extraction pipeline.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"eu incididunt deserunt\",\n            \"status\": \"seen\",\n            \"message\": \"commodo\",\n            \"createdTime\": 20868621\n        }\n    ]\n}"
    }
  }
}