Chilkat Online Tools

phpAx / Cognite API v1 / Get schema of resource type

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->SetRequestHeader('api-key','{{api-key}}');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://domain.com/api/v1/projects/{{project}}/transformations/schema/:schemaType',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print 'Response status code = ' . $http->LastStatus . "\n";
print $sbResponseBody->getAsString() . "\n";

?>

Curl Command

curl -X GET
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/transformations/schema/:schemaType?

Postman Collection Item JSON

{
  "id": "getTransformationSchema",
  "name": "Get schema of resource type",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "transformations",
        "schema",
        ":schemaType"
      ],
      "query": [
        {
          "key": "conflictMode",
          "description": "Behavior when the data already exists.`upsert` - Create or Update,`abort` - Create and fail when already exists,`update` - update and fail if it does not exist,`delete` - delete the matched rows.",
          "disabled": true
        }
      ],
      "variable": [
        {
          "key": "schemaType",
          "description": "Name of the target schema type, please provide one of the following:\n assets, timeseries, asset_hierarchy, events, datapoints\n string_datapoints, sequences, files, labels, relationships, raw, data_sets",
          "disabled": true,
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ]
  }
}