Chilkat Online Tools

DataFlex / Cognite API v1 / Retrieve relationships

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": [
    //     {
    //       "externalId": "in eiusmod nulla"
    //     },
    //     {
    //       "externalId": "consectetur eu Excepteur voluptate"
    //     }
    //   ],
    //   "ignoreUnknownIds": false,
    //   "fetchResources": false
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "items[0].externalId" "in eiusmod nulla" To iSuccess
    Get ComUpdateString Of hoJson "items[1].externalId" "consectetur eu Excepteur voluptate" To iSuccess
    Get ComUpdateBool Of hoJson "ignoreUnknownIds" False To iSuccess
    Get ComUpdateBool Of hoJson "fetchResources" False 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/byids" "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": "in eiusmod nulla"
        },
        {
            "externalId": "consectetur eu Excepteur voluptate"
        }
    ],
    "ignoreUnknownIds": false,
    "fetchResources": false
}'
https://domain.com/api/v1/projects/{{project}}/relationships/byids

Postman Collection Item JSON

{
  "id": "byidsRelationships",
  "name": "Retrieve relationships",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "relationships",
        "byids"
      ],
      "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": "Retrieve relationships by external IDs. You can retrieve a maximum of 1000 relationships per request.\nThe order of the relationships in the response equals the order in the request.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"in eiusmod nulla\"\n        },\n        {\n            \"externalId\": \"consectetur eu Excepteur voluptate\"\n        }\n    ],\n    \"ignoreUnknownIds\": false,\n    \"fetchResources\": false\n}"
    }
  }
}