Chilkat Online Tools

Objective-C / Cognite API v1 / Create 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 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"
//         }
//       ]
//     }
//   ]
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"items[0].externalId" value: @"dolor incididunt"];
[json UpdateString: @"items[0].sourceExternalId" value: @"veniam"];
[json UpdateString: @"items[0].sourceType" value: @"file"];
[json UpdateString: @"items[0].targetExternalId" value: @"aliquip"];
[json UpdateString: @"items[0].targetType" value: @"file"];
[json UpdateInt: @"items[0].startTime" value: [NSNumber numberWithInt: 44830797]];
[json UpdateInt: @"items[0].endTime" value: [NSNumber numberWithInt: 1210005]];
[json UpdateNumber: @"items[0].confidence" numericStr: @"0.5198580769389212"];
[json UpdateInt: @"items[0].dataSetId" value: [NSNumber numberWithInt: 123]];
[json UpdateString: @"items[0].labels[0].externalId" value: @"irure commodo proident"];
[json UpdateString: @"items[0].labels[1].externalId" value: @"dolore nulla consequat"];
[json UpdateString: @"items[1].externalId" value: @"Lorem enim"];
[json UpdateString: @"items[1].sourceExternalId" value: @"consequat Ut tempor dolore id"];
[json UpdateString: @"items[1].sourceType" value: @"sequence"];
[json UpdateString: @"items[1].targetExternalId" value: @"sed Ut incididunt adipisicing aliquip"];
[json UpdateString: @"items[1].targetType" value: @"event"];
[json UpdateInt: @"items[1].startTime" value: [NSNumber numberWithInt: 5339993]];
[json UpdateInt: @"items[1].endTime" value: [NSNumber numberWithInt: 40374137]];
[json UpdateNumber: @"items[1].confidence" numericStr: @"0.1252789445409579"];
[json UpdateInt: @"items[1].dataSetId" value: [NSNumber numberWithInt: 123]];
[json UpdateString: @"items[1].labels[0].externalId" value: @"sed officia"];
[json UpdateString: @"items[1].labels[1].externalId" value: @"sint est"];

[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" 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 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}"
    }
  }
}