Skip to main content
POST
/
v1
/
entities
Create Entity
curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "name": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "defaultAssignmentTable": "<string>"
}
'
{
  "displayName": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "defaultAssignmentTable": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://confidence-auth-testing.mintlify.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
entityId
string

The id to the give the created entity. If a not set a random one will be generated.

Body

application/json
​
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
​
name
string

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

​
labels
object[]

Custom labels for this entity.

​
owner
string

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

​
defaultAssignmentTable
string

The default assignment table for this entity.

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.

​
owner
string

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

​
defaultAssignmentTable
string

The default assignment table for this entity.