How do I run the business_processes commands from the shell?
Table of Contents
This file documents the business_processes resource at the shell, one section per command. Every command is a subcommand of business_processes, 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:
business_processes list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at refdata.v1.business_processes.list.
business_processes 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:
business_processes get <code> <coding_scheme_code>
It is addressed at refdata.v1.business_processes.get.
business_processes get __none__ __none__
1.3. get-many
Reads several rows in one request, one key group per row.
The command is shaped like this:
business_processes get-many <code> <coding_scheme_code>
It is addressed at refdata.v1.business_processes.get_many.
business_processes get-many __none__ __none__
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:
business_processes add <code> <coding_scheme_code> <source> <description> <reason> <commentary>
It is addressed at refdata.v1.business_processes.put.
business_processes add __none__ __none__ __none__ __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:
business_processes set <code> <coding_scheme_code> <source> <description> <reason> <commentary> [--version <n>]
It is addressed at refdata.v1.business_processes.put.
business_processes set __none__ __none__ __none__ __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:
business_processes put-many --count <n> <code> <coding_scheme_code> <source> <description> <reason> <commentary>
It is addressed at refdata.v1.business_processes.put_many.
business_processes put-many --count 1 __none__ __none__ __none__ __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:
business_processes delete <code> <coding_scheme_code> <reason> <commentary> [--version <n>]
It is addressed at refdata.v1.business_processes.delete.
business_processes delete __none__ __none__ 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:
business_processes delete-many <code> <coding_scheme_code> <reason> <commentary>
It is addressed at refdata.v1.business_processes.delete_many.
business_processes delete-many __none__ __none__ system.new_record generated_script
1.9. versions
Reads the row's recorded history, newest first.
The command is shaped like this:
business_processes versions <code> <coding_scheme_code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at refdata.v1.business_processes_versions.list.
business_processes versions __none__ __none__ --limit 1
1.10. version
Reads one recorded version of the row.
The command is shaped like this:
business_processes version <code> <coding_scheme_code> --version <n>
It is addressed at refdata.v1.business_processes_versions.get.
business_processes version __none__ __none__ --version 1