How do I run the approval_decisions commands from the shell?
Table of Contents
This file documents the approval_decisions resource at the shell, one section per command. Every command is a subcommand of approval_decisions, and every section exports its own script into projects/ores.shell/scripts/library/. Loading a script runs that one command, so a failure names the command it came from.
1. Commands
1.1. list
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:
approval_decisions list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at inbox.v1.approval_decisions.list.
approval_decisions list --limit 1
1.2. get
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:
approval_decisions get <id>
It is addressed at inbox.v1.approval_decisions.get.
approval_decisions get 00000000-0000-0000-0000-000000000000
1.3. get-many
Reads several rows in one request, one key group per row.
The command is shaped like this:
approval_decisions get-many <id>
It is addressed at inbox.v1.approval_decisions.get_many.
approval_decisions get-many 00000000-0000-0000-0000-000000000000
1.4. add
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:
approval_decisions add <request_id> <decision_code> <part_code> <decided_by> <decided_at> <hold_reason_code> <comment> <reason> <commentary>
It is addressed at inbox.v1.approval_decisions.put.
approval_decisions add 00000000-0000-0000-0000-000000000000 __none__ - 00000000-0000-0000-0000-000000000000 1970-01-01T00:00:00Z - __none__ system.new_record generated_script
1.5. set
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:
approval_decisions set <id> <request_id> <decision_code> <part_code> <decided_by> <decided_at> <hold_reason_code> <comment> <reason> <commentary> [--version <n>]
It is addressed at inbox.v1.approval_decisions.put.
approval_decisions set 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ - 00000000-0000-0000-0000-000000000000 1970-01-01T00:00:00Z - __none__ system.new_record generated_script
1.6. put-many
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:
approval_decisions put-many --count <n> <id> <request_id> <decision_code> <part_code> <decided_by> <decided_at> <hold_reason_code> <comment> <reason> <commentary>
It is addressed at inbox.v1.approval_decisions.put_many.
approval_decisions put-many --count 1 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ - 00000000-0000-0000-0000-000000000000 1970-01-01T00:00:00Z - __none__ system.new_record generated_script
1.7. delete
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:
approval_decisions delete <id> <reason> <commentary> [--version <n>]
It is addressed at inbox.v1.approval_decisions.delete.
approval_decisions delete 00000000-0000-0000-0000-000000000000 system.new_record generated_script
1.8. delete-many
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:
approval_decisions delete-many <id> <reason> <commentary>
It is addressed at inbox.v1.approval_decisions.delete_many.
approval_decisions delete-many 00000000-0000-0000-0000-000000000000 system.new_record generated_script
1.9. by-request-id
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:
approval_decisions by-request-id <request_id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at inbox.v1.approval_decisions.list_by_request_id.
approval_decisions by-request-id 00000000-0000-0000-0000-000000000000 --limit 1
1.10. versions
Reads the row's recorded history, newest first.
The command is shaped like this:
approval_decisions versions <id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at inbox.v1.approval_decisions_versions.list.
approval_decisions versions 00000000-0000-0000-0000-000000000000 --limit 1
1.11. version
Reads one recorded version of the row.
The command is shaped like this:
approval_decisions version <id> --version <n>
It is addressed at inbox.v1.approval_decisions_versions.get.
approval_decisions version 00000000-0000-0000-0000-000000000000 --version 1