How do I run the report_configurations 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:

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

It is addressed at reporting.v1.report_configurations.list.

report_configurations 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:

report_configurations get <configuration_type_code>

It is addressed at reporting.v1.report_configurations.get.

report_configurations get __none__

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

The command is shaped like this:

report_configurations get-many <configuration_type_code>

It is addressed at reporting.v1.report_configurations.get_many.

report_configurations 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:

report_configurations add <report_definition_id> <configuration_type_code> <configuration_id> <reason> <commentary>

It is addressed at reporting.v1.report_configurations.put.

report_configurations add 00000000-0000-0000-0000-000000000000 __none__ 00000000-0000-0000-0000-000000000000 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:

report_configurations set <id> <report_definition_id> <configuration_type_code> <configuration_id> <reason> <commentary> [--version <n>]

It is addressed at reporting.v1.report_configurations.put.

report_configurations set 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ 00000000-0000-0000-0000-000000000000 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:

report_configurations put-many --count <n> <id> <report_definition_id> <configuration_type_code> <configuration_id> <reason> <commentary>

It is addressed at reporting.v1.report_configurations.put_many.

report_configurations put-many --count 1 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ 00000000-0000-0000-0000-000000000000 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:

report_configurations delete <configuration_type_code> <reason> <commentary> [--version <n>]

It is addressed at reporting.v1.report_configurations.delete.

report_configurations 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:

report_configurations delete-many <configuration_type_code> <reason> <commentary>

It is addressed at reporting.v1.report_configurations.delete_many.

report_configurations delete-many __none__ system.new_record generated_script

Reads one page of the rows that share a relation value. The relation is part of the address rather than a filter applied after the read.

The command is shaped like this:

report_configurations by-report-definition-id <report_definition_id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at reporting.v1.report_configurations.list_by_report_definition_id.

report_configurations by-report-definition-id 00000000-0000-0000-0000-000000000000 --limit 1

Reads one page of the rows that share a relation value. The relation is part of the address rather than a filter applied after the read.

The command is shaped like this:

report_configurations by-configuration-type-code <configuration_type_code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at reporting.v1.report_configurations.list_by_configuration_type_code.

report_configurations by-configuration-type-code __none__ --limit 1

Reads one page of the rows that share a relation value. The relation is part of the address rather than a filter applied after the read.

The command is shaped like this:

report_configurations by-configuration-id <configuration_id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at reporting.v1.report_configurations.list_by_configuration_id.

report_configurations by-configuration-id 00000000-0000-0000-0000-000000000000 --limit 1

Reads the row's recorded history, newest first.

The command is shaped like this:

report_configurations versions <configuration_type_code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at reporting.v1.report_configurations_versions.list.

report_configurations versions __none__ --limit 1

Reads one recorded version of the row.

The command is shaped like this:

report_configurations version <configuration_type_code> --version <n>

It is addressed at reporting.v1.report_configurations_versions.get.

report_configurations version __none__ --version 1