DataFlex / Cognite API v1 / Update sequences
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
Boolean bTemp1
// 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": [
// {
// "update": {
// "name": {
// "set": "commodo consectetur labore adipisicing et"
// },
// "description": {
// "set": "minim do officia commodo enim"
// },
// "assetId": {
// "setNull": true
// },
// "externalId": {
// "setNull": true
// },
// "metadata": {
// "set": {}
// },
// "dataSetId": {
// "setNull": false
// },
// "columns": {
// "modify": [
// ],
// "add": [
// ],
// "remove": [
// ]
// }
// },
// "id": 2341818327837744
// },
// {
// "update": {
// "name": {
// "setNull": true
// },
// "description": {
// "setNull": false
// },
// "assetId": {
// "setNull": false
// },
// "externalId": {
// "set": "ea non cupidatat"
// },
// "metadata": {
// "add": {},
// "remove": [
// ]
// },
// "dataSetId": {
// "set": -97287500
// },
// "columns": {
// "modify": [
// ],
// "add": [
// ],
// "remove": [
// ]
// }
// },
// "externalId": "do"
// }
// ]
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "items[0].update.name.set" "commodo consectetur labore adipisicing et" To iSuccess
Get ComUpdateString Of hoJson "items[0].update.description.set" "minim do officia commodo enim" To iSuccess
Get ComUpdateBool Of hoJson "items[0].update.assetId.setNull" True To iSuccess
Get ComUpdateBool Of hoJson "items[0].update.externalId.setNull" True To iSuccess
Get ComUpdateNewObject Of hoJson "items[0].update.metadata.set" To iSuccess
Get ComUpdateBool Of hoJson "items[0].update.dataSetId.setNull" False To iSuccess
Get ComUpdateNewArray Of hoJson "items[0].update.columns.modify" To iSuccess
Get ComUpdateNewArray Of hoJson "items[0].update.columns.add" To iSuccess
Get ComUpdateNewArray Of hoJson "items[0].update.columns.remove" To iSuccess
Get ComUpdateInt Of hoJson "items[0].id" 123 To iSuccess
Get ComUpdateBool Of hoJson "items[1].update.name.setNull" True To iSuccess
Get ComUpdateBool Of hoJson "items[1].update.description.setNull" False To iSuccess
Get ComUpdateBool Of hoJson "items[1].update.assetId.setNull" False To iSuccess
Get ComUpdateString Of hoJson "items[1].update.externalId.set" "ea non cupidatat" 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 ComUpdateInt Of hoJson "items[1].update.dataSetId.set" -97287500 To iSuccess
Get ComUpdateNewArray Of hoJson "items[1].update.columns.modify" To iSuccess
Get ComUpdateNewArray Of hoJson "items[1].update.columns.add" To iSuccess
Get ComUpdateNewArray Of hoJson "items[1].update.columns.remove" To iSuccess
Get ComUpdateString Of hoJson "items[1].externalId" "do" To iSuccess
Send ComSetRequestHeader To hoHttp "content-type" "application/json"
Send ComSetRequestHeader To hoHttp "api-key" "{{api-key}}"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://domain.com/api/v1/projects/{{project}}/sequences/update" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = 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
Send Destroy of hoResp
End_Procedure
Curl Command
curl -X POST
-H "api-key: {{api-key}}"
-H "content-type: application/json"
-d '{
"items": [
{
"update": {
"name": {
"set": "commodo consectetur labore adipisicing et"
},
"description": {
"set": "minim do officia commodo enim"
},
"assetId": {
"setNull": true
},
"externalId": {
"setNull": true
},
"metadata": {
"set": {}
},
"dataSetId": {
"setNull": false
},
"columns": {
"modify": [],
"add": [],
"remove": []
}
},
"id": 2341818327837744
},
{
"update": {
"name": {
"setNull": true
},
"description": {
"setNull": false
},
"assetId": {
"setNull": false
},
"externalId": {
"set": "ea non cupidatat"
},
"metadata": {
"add": {},
"remove": []
},
"dataSetId": {
"set": -97287500
},
"columns": {
"modify": [],
"add": [],
"remove": []
}
},
"externalId": "do"
}
]
}'
https://domain.com/api/v1/projects/{{project}}/sequences/update
Postman Collection Item JSON
{
"id": "updateSequences",
"name": "Update sequences",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"sequences",
"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 one or more sequences. Fields that are not included in the request, are not changed.",
"body": {
"mode": "raw",
"raw": "{\n \"items\": [\n {\n \"update\": {\n \"name\": {\n \"set\": \"commodo consectetur labore adipisicing et\"\n },\n \"description\": {\n \"set\": \"minim do officia commodo enim\"\n },\n \"assetId\": {\n \"setNull\": true\n },\n \"externalId\": {\n \"setNull\": true\n },\n \"metadata\": {\n \"set\": {}\n },\n \"dataSetId\": {\n \"setNull\": false\n },\n \"columns\": {\n \"modify\": [],\n \"add\": [],\n \"remove\": []\n }\n },\n \"id\": 2341818327837744\n },\n {\n \"update\": {\n \"name\": {\n \"setNull\": true\n },\n \"description\": {\n \"setNull\": false\n },\n \"assetId\": {\n \"setNull\": false\n },\n \"externalId\": {\n \"set\": \"ea non cupidatat\"\n },\n \"metadata\": {\n \"add\": {},\n \"remove\": []\n },\n \"dataSetId\": {\n \"set\": -97287500\n },\n \"columns\": {\n \"modify\": [],\n \"add\": [],\n \"remove\": []\n }\n },\n \"externalId\": \"do\"\n }\n ]\n}"
}
}
}
