Objective-C / Cognite API v1 / Update relationships
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// 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 amet sit",
// "update": {
// "sourceType": {
// "set": "timeSeries"
// },
// "sourceExternalId": {
// "set": "qui labor"
// },
// "targetType": {
// "set": "file"
// },
// "targetExternalId": {
// "set": "laborum"
// },
// "confidence": {
// "setNull": true
// },
// "startTime": {
// "set": 97867670
// },
// "endTime": {
// "setNull": true
// },
// "dataSetId": {
// "set": 8379377116294748
// },
// "labels": {
// "set": [
// {
// "externalId": "ullamco anim"
// },
// {
// "externalId": "aliquip ut"
// }
// ]
// }
// }
// },
// {
// "externalId": "reprehenderit ut",
// "update": {
// "sourceType": {
// "set": "timeSeries"
// },
// "sourceExternalId": {
// "set": "adipisicing ullamco consequat"
// },
// "targetType": {
// "set": "sequence"
// },
// "targetExternalId": {
// "set": "aliqua"
// },
// "confidence": {
// "setNull": true
// },
// "startTime": {
// "setNull": false
// },
// "endTime": {
// "set": 51106464
// },
// "dataSetId": {
// "setNull": false
// },
// "labels": {
// "set": [
// {
// "externalId": "Lorem ipsum"
// },
// {
// "externalId": "officia consectetur pariatur"
// }
// ]
// }
// }
// }
// ]
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"items[0].externalId" value: @"dolor amet sit"];
[json UpdateString: @"items[0].update.sourceType.set" value: @"timeSeries"];
[json UpdateString: @"items[0].update.sourceExternalId.set" value: @"qui labor"];
[json UpdateString: @"items[0].update.targetType.set" value: @"file"];
[json UpdateString: @"items[0].update.targetExternalId.set" value: @"laborum"];
[json UpdateBool: @"items[0].update.confidence.setNull" value: YES];
[json UpdateInt: @"items[0].update.startTime.set" value: [NSNumber numberWithInt: 97867670]];
[json UpdateBool: @"items[0].update.endTime.setNull" value: YES];
[json UpdateInt: @"items[0].update.dataSetId.set" value: [NSNumber numberWithInt: 123]];
[json UpdateString: @"items[0].update.labels.set[0].externalId" value: @"ullamco anim"];
[json UpdateString: @"items[0].update.labels.set[1].externalId" value: @"aliquip ut"];
[json UpdateString: @"items[1].externalId" value: @"reprehenderit ut"];
[json UpdateString: @"items[1].update.sourceType.set" value: @"timeSeries"];
[json UpdateString: @"items[1].update.sourceExternalId.set" value: @"adipisicing ullamco consequat"];
[json UpdateString: @"items[1].update.targetType.set" value: @"sequence"];
[json UpdateString: @"items[1].update.targetExternalId.set" value: @"aliqua"];
[json UpdateBool: @"items[1].update.confidence.setNull" value: YES];
[json UpdateBool: @"items[1].update.startTime.setNull" value: NO];
[json UpdateInt: @"items[1].update.endTime.set" value: [NSNumber numberWithInt: 51106464]];
[json UpdateBool: @"items[1].update.dataSetId.setNull" value: NO];
[json UpdateString: @"items[1].update.labels.set[0].externalId" value: @"Lorem ipsum"];
[json UpdateString: @"items[1].update.labels.set[1].externalId" value: @"officia consectetur pariatur"];
[http SetRequestHeader: @"content-type" value: @"application/json"];
[http SetRequestHeader: @"api-key" value: @"{{api-key}}"];
CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/api/v1/projects/{{project}}/relationships/update" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);
Curl Command
curl -X POST
-H "api-key: {{api-key}}"
-H "content-type: application/json"
-d '{
"items": [
{
"externalId": "dolor amet sit",
"update": {
"sourceType": {
"set": "timeSeries"
},
"sourceExternalId": {
"set": "qui labor"
},
"targetType": {
"set": "file"
},
"targetExternalId": {
"set": "laborum"
},
"confidence": {
"setNull": true
},
"startTime": {
"set": 97867670
},
"endTime": {
"setNull": true
},
"dataSetId": {
"set": 8379377116294748
},
"labels": {
"set": [
{
"externalId": "ullamco anim"
},
{
"externalId": "aliquip ut"
}
]
}
}
},
{
"externalId": "reprehenderit ut",
"update": {
"sourceType": {
"set": "timeSeries"
},
"sourceExternalId": {
"set": "adipisicing ullamco consequat"
},
"targetType": {
"set": "sequence"
},
"targetExternalId": {
"set": "aliqua"
},
"confidence": {
"setNull": true
},
"startTime": {
"setNull": false
},
"endTime": {
"set": 51106464
},
"dataSetId": {
"setNull": false
},
"labels": {
"set": [
{
"externalId": "Lorem ipsum"
},
{
"externalId": "officia consectetur pariatur"
}
]
}
}
}
]
}'
https://domain.com/api/v1/projects/{{project}}/relationships/update
Postman Collection Item JSON
{
"id": "updateRelationships",
"name": "Update relationships",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"relationships",
"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 relationships between resources according to the partial definitions of the relationships given in the payload of the request. This means that fields not mentioned in the payload will remain unchanged. Up to 1000 relationships can be updated in one operation.\nTo delete a value from an optional value the `setNull` field should be set to `true`.\nThe order of the updated relationships in the response equals the order in the request.",
"body": {
"mode": "raw",
"raw": "{\n \"items\": [\n {\n \"externalId\": \"dolor amet sit\",\n \"update\": {\n \"sourceType\": {\n \"set\": \"timeSeries\"\n },\n \"sourceExternalId\": {\n \"set\": \"qui labor\"\n },\n \"targetType\": {\n \"set\": \"file\"\n },\n \"targetExternalId\": {\n \"set\": \"laborum\"\n },\n \"confidence\": {\n \"setNull\": true\n },\n \"startTime\": {\n \"set\": 97867670\n },\n \"endTime\": {\n \"setNull\": true\n },\n \"dataSetId\": {\n \"set\": 8379377116294748\n },\n \"labels\": {\n \"set\": [\n {\n \"externalId\": \"ullamco anim\"\n },\n {\n \"externalId\": \"aliquip ut\"\n }\n ]\n }\n }\n },\n {\n \"externalId\": \"reprehenderit ut\",\n \"update\": {\n \"sourceType\": {\n \"set\": \"timeSeries\"\n },\n \"sourceExternalId\": {\n \"set\": \"adipisicing ullamco consequat\"\n },\n \"targetType\": {\n \"set\": \"sequence\"\n },\n \"targetExternalId\": {\n \"set\": \"aliqua\"\n },\n \"confidence\": {\n \"setNull\": true\n },\n \"startTime\": {\n \"setNull\": false\n },\n \"endTime\": {\n \"set\": 51106464\n },\n \"dataSetId\": {\n \"setNull\": false\n },\n \"labels\": {\n \"set\": [\n {\n \"externalId\": \"Lorem ipsum\"\n },\n {\n \"externalId\": \"officia consectetur pariatur\"\n }\n ]\n }\n }\n }\n ]\n}"
}
}
}
