Chapter

entity_idEntityID (string)

Identificador único da entidade no formato {entity_type}:{uuid_v7}.

Possible values: Value must match regular expression ^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$

Example: {entity_type}:018f74a6e3b270ccbf248a4b012f5f3e

entity_typestring

Possible values: [CHAPTER]

external_entity_idExternalEntityID (string)nullable

Identificador externo da entidade para interoperabilidade com outros sistemas.

Possible values: non-empty and <= 36 characters

Example: ext:123-456-789-ABCD

versionVersion (integer)

Possible values: >= 0 and <= 128

Default value: 0

namestring

descriptionstringnullable

ledger_entity_idEntityID (string)

Identificador único da entidade no formato {entity_type}:{uuid_v7}.

Possible values: Value must match regular expression ^([a-zA-Z_-]+:[0-9a-f]{8}[0-9a-f]{4}7[0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12})$

Example: {entity_type}:018f74a6e3b270ccbf248a4b012f5f3e

created_atstring<date-time>

Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).

Possible values: Value must match regular expression ^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$

updated_atstring<date-time>

Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).

Possible values: Value must match regular expression ^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$

discarded_atstring<date-time>nullable

Data e hora no formato no formato ISO 8601 / RFC 3339 (UTC).

Possible values: Value must match regular expression ^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$

metadata object

Os metadados a serem adicionados à entidade devem ser fornecidos como pares de chave-valor em um formato de objeto JSON, com chave e valor como strings. O tamanho maximo do objeto deve ser 1MB.

property name*string

Chapter

{
  "entity_id": "{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e",
  "entity_type": "CHAPTER",
  "external_entity_id": "ext:123-456-789-ABCD",
  "version": 0,
  "name": "string",
  "description": "string",
  "ledger_entity_id": "{entity_type}:018f74a6e3b270ccbf248a4b012f5f3e",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "discarded_at": "2024-07-29T15:51:28.071Z",
  "metadata": {
    "foo": "bar"
  }
}