Chilkat Online Tools

delphiDll / Cognite API v1 / Get schema of resource type

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;

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

http := CkHttp_Create();

CkHttp_SetRequestHeader(http,'api-key','{{api-key}}');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/api/v1/projects/{{project}}/transformations/schema/:schemaType',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add('Response status code = ' + IntToStr(CkHttp_getLastStatus(http)));
Memo1.Lines.Add(CkStringBuilder__getAsString(sbResponseBody));

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);

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."
      }
    ]
  }
}