Get Entity - Confidence Documentation

GET

/

v1

/

entities

/

{entity}

Get Entity

curl --request GET \
  --url https://metrics.eu.confidence.dev/v1/entities/{entity} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://metrics.eu.confidence.dev/v1/entities/{entity}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://metrics.eu.confidence.dev/v1/entities/{entity}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://metrics.eu.confidence.dev/v1/entities/{entity}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://metrics.eu.confidence.dev/v1/entities/{entity}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "displayName": "<string>",
  "primaryKeyType": "COLUMN_TYPE_UNSPECIFIED",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "defaultAssignmentTable": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entity

string

required

Response

200 - application/json

Returns a Entity.

Description of a uniquely identifiable entity.

displayName

string

required

Human friendly name of the entity.

primaryKeyType

enum<string>

required

The type of the identifier in the data warehouse storage.

Available options:

COLUMN_TYPE_UNSPECIFIED,

COLUMN_TYPE_STRING,

COLUMN_TYPE_INT32,

COLUMN_TYPE_INT64,

COLUMN_TYPE_DOUBLE,

COLUMN_TYPE_BOOLEAN,

COLUMN_TYPE_DATE,

COLUMN_TYPE_TIMESTAMP,

COLUMN_TYPE_BYTES,

COLUMN_TYPE_TIMESTAMP_WITHOUT_TIMEZONE,

COLUMN_TYPE_DECIMAL,

COLUMN_TYPE_HLL_SKETCH

createTime

object

required

Time when the entity was first created.

updateTime

object

required

Time when the entity was last updated.

creator

string

required

Reference to the identity that created this entity.

updater

string

required

Reference to the identity that last updated this entity.

name

string

Unique identifier of the entity. For example: entities/0smva5nxuhv4yts6paxt

labels

object[]

Custom labels for this entity.

Show child attributes

owner

string

The owner of the resource. If not set will default to the creator.

defaultAssignmentTable

string

The default assignment table for this entity.

⌘I

Get Entity

curl --request GET \
  --url https://metrics.eu.confidence.dev/v1/entities/{entity} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://metrics.eu.confidence.dev/v1/entities/{entity}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://metrics.eu.confidence.dev/v1/entities/{entity}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://metrics.eu.confidence.dev/v1/entities/{entity}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://metrics.eu.confidence.dev/v1/entities/{entity}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "displayName": "<string>",
  "primaryKeyType": "COLUMN_TYPE_UNSPECIFIED",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "defaultAssignmentTable": "<string>"
}