DataFlex / Cognite API v1 / Update extraction pipelines
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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"
// }
// }
// }
// ]
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateInt Of hoJson "items[0].id" 123 To iSuccess
Get ComUpdateString Of hoJson "items[0].update.externalId.set" "quis commodo minim incididunt et" To iSuccess
Get ComUpdateString Of hoJson "items[0].update.name.set" "sed dolor Lorem in ipsum" To iSuccess
Get ComUpdateString Of hoJson "items[0].update.description.set" "cillum nostrud sed" To iSuccess
Get ComUpdateInt Of hoJson "items[0].update.dataSetId.set" 123 To iSuccess
Get ComUpdateString Of hoJson "items[0].update.schedule.set" "@every 82504669750µs8427843087ns555708762us7123273s051539154us5900122us91861576391ns8us34751758067m770238ns227346276ns" To iSuccess
Get ComUpdateNewArray Of hoJson "items[0].update.rawTables.add" To iSuccess
Get ComUpdateNewArray Of hoJson "items[0].update.rawTables.remove" To iSuccess
Get ComUpdateNewArray Of hoJson "items[0].update.contacts.set" To iSuccess
Get ComUpdateNewObject Of hoJson "items[0].update.metadata.set" To iSuccess
Get ComUpdateString Of hoJson "items[0].update.source.set" "laboris ut consectetur sint" To iSuccess
Get ComUpdateString Of hoJson "items[0].update.documentation.set" "ullamco" To iSuccess
Get ComUpdateString Of hoJson "items[1].externalId" "ad" To iSuccess
Get ComUpdateString Of hoJson "items[1].update.externalId.set" "do non" To iSuccess
Get ComUpdateString Of hoJson "items[1].update.name.set" "esse aliquip id dolor dolore" To iSuccess
Get ComUpdateString Of hoJson "items[1].update.description.set" "sed quis occaecat" To iSuccess
Get ComUpdateInt Of hoJson "items[1].update.dataSetId.set" 123 To iSuccess
Get ComUpdateString Of hoJson "items[1].update.schedule.set" "@every 005767486h236428466h76m27880668117h795ns97s784ns" To iSuccess
Get ComUpdateNewArray Of hoJson "items[1].update.rawTables.add" To iSuccess
Get ComUpdateNewArray Of hoJson "items[1].update.rawTables.remove" To iSuccess
Get ComUpdateNewArray Of hoJson "items[1].update.contacts.set" To iSuccess
Get ComUpdateNewObject Of hoJson "items[1].update.metadata.add" To iSuccess
Get ComUpdateNewArray Of hoJson "items[1].update.metadata.remove" To iSuccess
Get ComUpdateString Of hoJson "items[1].update.source.set" "aliquip eu ex" To iSuccess
Get ComUpdateString Of hoJson "items[1].update.documentation.set" "ut" To iSuccess
Send ComSetRequestHeader To hoHttp "content-type" "application/json"
Send ComSetRequestHeader To hoHttp "api-key" "{{api-key}}"
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
Get pvComObject of hoJson to vJson
Get pvComObject of hoResp to vResp
Get ComHttpJson Of hoHttp "POST" "https://domain.com/api/v1/projects/{{project}}/extpipes/update" vJson "application/json" vResp To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
End_Procedure
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}"
}
}
}
