Ruby / Cognite API v1 / Update extraction pipelines
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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": [
# {
# "id": 170038996366328,
# "update": {
# "externalId": {
# "set": "quis commodo minim incididunt et"
# },
# "name": {
# "set": "sed dolor Lorem in ipsum"
# },
# "description": {
# "set": "cillum nostrud sed"
# },
# "dataSetId": {
# "set": 5808835505541566
# },
# "schedule": {
# "set": "@every 82504669750µs8427843087ns555708762us7123273s051539154us5900122us91861576391ns8us34751758067m770238ns227346276ns"
# },
# "rawTables": {
# "add": [
# ],
# "remove": [
# ]
# },
# "contacts": {
# "set": [
# ]
# },
# "metadata": {
# "set": {}
# },
# "source": {
# "set": "laboris ut consectetur sint"
# },
# "documentation": {
# "set": "ullamco"
# }
# }
# },
# {
# "externalId": "ad",
# "update": {
# "externalId": {
# "set": "do non"
# },
# "name": {
# "set": "esse aliquip id dolor dolore"
# },
# "description": {
# "set": "sed quis occaecat"
# },
# "dataSetId": {
# "set": 2991526305068270
# },
# "schedule": {
# "set": "@every 005767486h236428466h76m27880668117h795ns97s784ns"
# },
# "rawTables": {
# "add": [
# ],
# "remove": [
# ]
# },
# "contacts": {
# "set": [
# ]
# },
# "metadata": {
# "add": {},
# "remove": [
# ]
# },
# "source": {
# "set": "aliquip eu ex"
# },
# "documentation": {
# "set": "ut"
# }
# }
# }
# ]
# }
json = Chilkat::CkJsonObject.new()
json.UpdateInt("items[0].id",123)
json.UpdateString("items[0].update.externalId.set","quis commodo minim incididunt et")
json.UpdateString("items[0].update.name.set","sed dolor Lorem in ipsum")
json.UpdateString("items[0].update.description.set","cillum nostrud sed")
json.UpdateInt("items[0].update.dataSetId.set",123)
json.UpdateString("items[0].update.schedule.set","@every 82504669750µs8427843087ns555708762us7123273s051539154us5900122us91861576391ns8us34751758067m770238ns227346276ns")
json.UpdateNewArray("items[0].update.rawTables.add")
json.UpdateNewArray("items[0].update.rawTables.remove")
json.UpdateNewArray("items[0].update.contacts.set")
json.UpdateNewObject("items[0].update.metadata.set")
json.UpdateString("items[0].update.source.set","laboris ut consectetur sint")
json.UpdateString("items[0].update.documentation.set","ullamco")
json.UpdateString("items[1].externalId","ad")
json.UpdateString("items[1].update.externalId.set","do non")
json.UpdateString("items[1].update.name.set","esse aliquip id dolor dolore")
json.UpdateString("items[1].update.description.set","sed quis occaecat")
json.UpdateInt("items[1].update.dataSetId.set",123)
json.UpdateString("items[1].update.schedule.set","@every 005767486h236428466h76m27880668117h795ns97s784ns")
json.UpdateNewArray("items[1].update.rawTables.add")
json.UpdateNewArray("items[1].update.rawTables.remove")
json.UpdateNewArray("items[1].update.contacts.set")
json.UpdateNewObject("items[1].update.metadata.add")
json.UpdateNewArray("items[1].update.metadata.remove")
json.UpdateString("items[1].update.source.set","aliquip eu ex")
json.UpdateString("items[1].update.documentation.set","ut")
http.SetRequestHeader("content-type","application/json")
http.SetRequestHeader("api-key","{{api-key}}")
# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/extpipes/update","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";
Curl Command
curl -X POST
-H "api-key: {{api-key}}"
-H "content-type: application/json"
-d '{
"items": [
{
"id": 170038996366328,
"update": {
"externalId": {
"set": "quis commodo minim incididunt et"
},
"name": {
"set": "sed dolor Lorem in ipsum"
},
"description": {
"set": "cillum nostrud sed"
},
"dataSetId": {
"set": 5808835505541566
},
"schedule": {
"set": "@every 82504669750µs8427843087ns555708762us7123273s051539154us5900122us91861576391ns8us34751758067m770238ns227346276ns"
},
"rawTables": {
"add": [],
"remove": []
},
"contacts": {
"set": []
},
"metadata": {
"set": {}
},
"source": {
"set": "laboris ut consectetur sint"
},
"documentation": {
"set": "ullamco"
}
}
},
{
"externalId": "ad",
"update": {
"externalId": {
"set": "do non"
},
"name": {
"set": "esse aliquip id dolor dolore"
},
"description": {
"set": "sed quis occaecat"
},
"dataSetId": {
"set": 2991526305068270
},
"schedule": {
"set": "@every 005767486h236428466h76m27880668117h795ns97s784ns"
},
"rawTables": {
"add": [],
"remove": []
},
"contacts": {
"set": []
},
"metadata": {
"add": {},
"remove": []
},
"source": {
"set": "aliquip eu ex"
},
"documentation": {
"set": "ut"
}
}
}
]
}'
https://domain.com/api/v1/projects/{{project}}/extpipes/update
Postman Collection Item JSON
{
"id": "updateExtPipes",
"name": "Update extraction pipelines",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"extpipes",
"update"
],
"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": "Update information for a list of extraction pipelines. Fields that are not included in the request, are not changed.",
"body": {
"mode": "raw",
"raw": "{\n \"items\": [\n {\n \"id\": 170038996366328,\n \"update\": {\n \"externalId\": {\n \"set\": \"quis commodo minim incididunt et\"\n },\n \"name\": {\n \"set\": \"sed dolor Lorem in ipsum\"\n },\n \"description\": {\n \"set\": \"cillum nostrud sed\"\n },\n \"dataSetId\": {\n \"set\": 5808835505541566\n },\n \"schedule\": {\n \"set\": \"@every 82504669750µs8427843087ns555708762us7123273s051539154us5900122us91861576391ns8us34751758067m770238ns227346276ns\"\n },\n \"rawTables\": {\n \"add\": [],\n \"remove\": []\n },\n \"contacts\": {\n \"set\": []\n },\n \"metadata\": {\n \"set\": {}\n },\n \"source\": {\n \"set\": \"laboris ut consectetur sint\"\n },\n \"documentation\": {\n \"set\": \"ullamco\"\n }\n }\n },\n {\n \"externalId\": \"ad\",\n \"update\": {\n \"externalId\": {\n \"set\": \"do non\"\n },\n \"name\": {\n \"set\": \"esse aliquip id dolor dolore\"\n },\n \"description\": {\n \"set\": \"sed quis occaecat\"\n },\n \"dataSetId\": {\n \"set\": 2991526305068270\n },\n \"schedule\": {\n \"set\": \"@every 005767486h236428466h76m27880668117h795ns97s784ns\"\n },\n \"rawTables\": {\n \"add\": [],\n \"remove\": []\n },\n \"contacts\": {\n \"set\": []\n },\n \"metadata\": {\n \"add\": {},\n \"remove\": []\n },\n \"source\": {\n \"set\": \"aliquip eu ex\"\n },\n \"documentation\": {\n \"set\": \"ut\"\n }\n }\n }\n ]\n}"
}
}
}
