Chilkat Online Tools

DataFlex / Cognite API v1 / Create relationships

Back to Collection Items

Use ChilkatAx-9.5.0-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": [
    //     {
    //       "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"
    //         }
    //       ]
    //     }
    //   ]
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "items[0].externalId" "dolor incididunt" To iSuccess
    Get ComUpdateString Of hoJson "items[0].sourceExternalId" "veniam" To iSuccess
    Get ComUpdateString Of hoJson "items[0].sourceType" "file" To iSuccess
    Get ComUpdateString Of hoJson "items[0].targetExternalId" "aliquip" To iSuccess
    Get ComUpdateString Of hoJson "items[0].targetType" "file" To iSuccess
    Get ComUpdateInt Of hoJson "items[0].startTime" 44830797 To iSuccess
    Get ComUpdateInt Of hoJson "items[0].endTime" 1210005 To iSuccess
    Get ComUpdateNumber Of hoJson "items[0].confidence" "0.5198580769389212" To iSuccess
    Get ComUpdateInt Of hoJson "items[0].dataSetId" 123 To iSuccess
    Get ComUpdateString Of hoJson "items[0].labels[0].externalId" "irure commodo proident" To iSuccess
    Get ComUpdateString Of hoJson "items[0].labels[1].externalId" "dolore nulla consequat" To iSuccess
    Get ComUpdateString Of hoJson "items[1].externalId" "Lorem enim" To iSuccess
    Get ComUpdateString Of hoJson "items[1].sourceExternalId" "consequat Ut tempor dolore id" To iSuccess
    Get ComUpdateString Of hoJson "items[1].sourceType" "sequence" To iSuccess
    Get ComUpdateString Of hoJson "items[1].targetExternalId" "sed Ut incididunt adipisicing aliquip" To iSuccess
    Get ComUpdateString Of hoJson "items[1].targetType" "event" To iSuccess
    Get ComUpdateInt Of hoJson "items[1].startTime" 5339993 To iSuccess
    Get ComUpdateInt Of hoJson "items[1].endTime" 40374137 To iSuccess
    Get ComUpdateNumber Of hoJson "items[1].confidence" "0.1252789445409579" To iSuccess
    Get ComUpdateInt Of hoJson "items[1].dataSetId" 123 To iSuccess
    Get ComUpdateString Of hoJson "items[1].labels[0].externalId" "sed officia" To iSuccess
    Get ComUpdateString Of hoJson "items[1].labels[1].externalId" "sint est" 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}}/relationships" "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": [
        {
            "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}"
    }
  }
}