PureBasic / Cognite API v1 / Create relationships
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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": "dolor incididunt",
; "sourceExternalId": "veniam",
; "sourceType": "file",
; "targetExternalId": "aliquip",
; "targetType": "file",
; "startTime": 44830797,
; "endTime": 1210005,
; "confidence": 0.5198580769389212,
; "dataSetId": 1654747236161954,
; "labels": [
; {
; "externalId": "irure commodo proident"
; },
; {
; "externalId": "dolore nulla consequat"
; }
; ]
; },
; {
; "externalId": "Lorem enim",
; "sourceExternalId": "consequat Ut tempor dolore id",
; "sourceType": "sequence",
; "targetExternalId": "sed Ut incididunt adipisicing aliquip",
; "targetType": "event",
; "startTime": 5339993,
; "endTime": 40374137,
; "confidence": 0.1252789445409579,
; "dataSetId": 4001858727825240,
; "labels": [
; {
; "externalId": "sed officia"
; },
; {
; "externalId": "sint est"
; }
; ]
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"items[0].externalId","dolor incididunt")
CkJsonObject::ckUpdateString(json,"items[0].sourceExternalId","veniam")
CkJsonObject::ckUpdateString(json,"items[0].sourceType","file")
CkJsonObject::ckUpdateString(json,"items[0].targetExternalId","aliquip")
CkJsonObject::ckUpdateString(json,"items[0].targetType","file")
CkJsonObject::ckUpdateInt(json,"items[0].startTime",44830797)
CkJsonObject::ckUpdateInt(json,"items[0].endTime",1210005)
CkJsonObject::ckUpdateNumber(json,"items[0].confidence","0.5198580769389212")
CkJsonObject::ckUpdateInt(json,"items[0].dataSetId",123)
CkJsonObject::ckUpdateString(json,"items[0].labels[0].externalId","irure commodo proident")
CkJsonObject::ckUpdateString(json,"items[0].labels[1].externalId","dolore nulla consequat")
CkJsonObject::ckUpdateString(json,"items[1].externalId","Lorem enim")
CkJsonObject::ckUpdateString(json,"items[1].sourceExternalId","consequat Ut tempor dolore id")
CkJsonObject::ckUpdateString(json,"items[1].sourceType","sequence")
CkJsonObject::ckUpdateString(json,"items[1].targetExternalId","sed Ut incididunt adipisicing aliquip")
CkJsonObject::ckUpdateString(json,"items[1].targetType","event")
CkJsonObject::ckUpdateInt(json,"items[1].startTime",5339993)
CkJsonObject::ckUpdateInt(json,"items[1].endTime",40374137)
CkJsonObject::ckUpdateNumber(json,"items[1].confidence","0.1252789445409579")
CkJsonObject::ckUpdateInt(json,"items[1].dataSetId",123)
CkJsonObject::ckUpdateString(json,"items[1].labels[0].externalId","sed officia")
CkJsonObject::ckUpdateString(json,"items[1].labels[1].externalId","sint est")
CkHttp::ckSetRequestHeader(http,"content-type","application/json")
CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/v1/projects/{{project}}/relationships","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "api-key: {{api-key}}"
-H "content-type: application/json"
-d '{
"items": [
{
"externalId": "dolor incididunt",
"sourceExternalId": "veniam",
"sourceType": "file",
"targetExternalId": "aliquip",
"targetType": "file",
"startTime": 44830797,
"endTime": 1210005,
"confidence": 0.5198580769389212,
"dataSetId": 1654747236161954,
"labels": [
{
"externalId": "irure commodo proident"
},
{
"externalId": "dolore nulla consequat"
}
]
},
{
"externalId": "Lorem enim",
"sourceExternalId": "consequat Ut tempor dolore id",
"sourceType": "sequence",
"targetExternalId": "sed Ut incididunt adipisicing aliquip",
"targetType": "event",
"startTime": 5339993,
"endTime": 40374137,
"confidence": 0.1252789445409579,
"dataSetId": 4001858727825240,
"labels": [
{
"externalId": "sed officia"
},
{
"externalId": "sint est"
}
]
}
]
}'
https://domain.com/api/v1/projects/{{project}}/relationships
Postman Collection Item JSON
{
"id": "createRelationships",
"name": "Create relationships",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"relationships"
],
"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": "List of the relationships to create. You can create a maximum of 1000 relationships per request. Relationships should be unique, but CDF does not prevent you from creating duplicates where only the externalId differs.\n\nRelationships are uniquely identified by their externalId. Non-unique relationships will not be created.\n\nThe order of relationships in the response equals the order in the request.",
"body": {
"mode": "raw",
"raw": "{\n \"items\": [\n {\n \"externalId\": \"dolor incididunt\",\n \"sourceExternalId\": \"veniam\",\n \"sourceType\": \"file\",\n \"targetExternalId\": \"aliquip\",\n \"targetType\": \"file\",\n \"startTime\": 44830797,\n \"endTime\": 1210005,\n \"confidence\": 0.5198580769389212,\n \"dataSetId\": 1654747236161954,\n \"labels\": [\n {\n \"externalId\": \"irure commodo proident\"\n },\n {\n \"externalId\": \"dolore nulla consequat\"\n }\n ]\n },\n {\n \"externalId\": \"Lorem enim\",\n \"sourceExternalId\": \"consequat Ut tempor dolore id\",\n \"sourceType\": \"sequence\",\n \"targetExternalId\": \"sed Ut incididunt adipisicing aliquip\",\n \"targetType\": \"event\",\n \"startTime\": 5339993,\n \"endTime\": 40374137,\n \"confidence\": 0.1252789445409579,\n \"dataSetId\": 4001858727825240,\n \"labels\": [\n {\n \"externalId\": \"sed officia\"\n },\n {\n \"externalId\": \"sint est\"\n }\n ]\n }\n ]\n}"
}
}
}
