How do I run the legal_entities commands from the shell?

Reads one page of the collection. Nothing addresses it but the caller's tenant, so it is the read that shows what exists.

The command is shaped like this:

legal_entities list [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at refdata.v1.legal_entities.list.

legal_entities list --limit 1

Reads the one row its key addresses. A key states every identifying column, so a partial key is refused rather than answered with an arbitrary row.

The command is shaped like this:

legal_entities get <lei>

It is addressed at refdata.v1.legal_entities.get.

legal_entities get __none__

Reads several rows in one request, one key group per row.

The command is shaped like this:

legal_entities get-many <lei>

It is addressed at refdata.v1.legal_entities.get_many.

legal_entities get-many __none__

Writes a row. The change states that the row must not exist, so a create that collides with an existing row is refused rather than replacing it. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved.

The command is shaped like this:

legal_entities add <lei> <legal_name> <jurisdiction> <entity_status> <entity_category> <display_order> <reason> <commentary>

It is addressed at refdata.v1.legal_entities.put.

legal_entities add __none__ __none__ __none__ __none__ __none__ 0 system.new_record generated_script

Writes a row. The change states no precondition, so it replaces whatever row the key already addresses. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved. Passing –version makes the write conditional on the version the caller last read.

The command is shaped like this:

legal_entities set <lei> <legal_name> <jurisdiction> <entity_status> <entity_category> <display_order> <reason> <commentary> [--version <n>]

It is addressed at refdata.v1.legal_entities.put.

legal_entities set __none__ __none__ __none__ __none__ __none__ 0 system.new_record generated_script

Writes several rows in one request. The count states how many field groups follow. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved.

The command is shaped like this:

legal_entities put-many --count <n> <lei> <legal_name> <jurisdiction> <entity_status> <entity_category> <display_order> <reason> <commentary>

It is addressed at refdata.v1.legal_entities.put_many.

legal_entities put-many --count 1 __none__ __none__ __none__ __none__ __none__ 0 system.new_record generated_script

Removes a row. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved. Passing –version makes the write conditional on the version the caller last read.

The command is shaped like this:

legal_entities delete <lei> <reason> <commentary> [--version <n>]

It is addressed at refdata.v1.legal_entities.delete.

legal_entities delete __none__ system.new_record generated_script

Removes several rows in one request. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved.

The command is shaped like this:

legal_entities delete-many <lei> <reason> <commentary>

It is addressed at refdata.v1.legal_entities.delete_many.

legal_entities delete-many __none__ system.new_record generated_script

Reads the row's recorded history, newest first.

The command is shaped like this:

legal_entities versions <lei> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at refdata.v1.legal_entities_versions.list.

legal_entities versions __none__ --limit 1

Reads one recorded version of the row.

The command is shaped like this:

legal_entities version <lei> --version <n>

It is addressed at refdata.v1.legal_entities_versions.get.

legal_entities version __none__ --version 1