Create Entity

Create a new entity. An entity is a class of instances that can be uniquely identified and measured. A typical example is a user, but can also be something more abstract like a bank transaction.

POST /v1/entities

Create Entity

cURL

curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

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

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

The body is of type object.

Response

200 - application/json

OK

Description of a uniquely identifiable entity.

displayName · string · required

Human friendly name of the entity.

primaryKeyType · object · required

The type of the identifier in the data warehouse storage.

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.