Id

Description

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

UUID Entity Identifier

A UUID identifier for the entity.

Integer Entity Identifier

An integer identifier for the entity.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "An entity identifier. It may be either an integer or a universally unique\nidentifier (UUID) represented as a string.",
  "oneOf": [
    {
      "description": "A UUID identifier for the entity.",
      "example": "74b84967-14a9-4709-a076-30b6da39744d",
      "format": "uuid",
      "title": "UUID Entity Identifier",
      "type": "string"
    },
    {
      "description": "An integer identifier for the entity.",
      "example": 12345,
      "title": "Integer Entity Identifier",
      "type": "integer"
    }
  ],
  "title": "Entity Identifier"
}