Page History
...
- The JS7 offers to perform any operation on orders, workflows, jobs and related objects by the JS7 - REST Web Service API.
- Note that any operation available with the JOC Cockpit GUI makes use of the REST Web Service API.
- For detailed information see the Technical Documentation of the REST Web Service API.
- The REST Web Service API can be accessed from Shell utilities such as
curl
. - In addition, a PowerShell module is available for simplified access to the REST Web Service API. This is described in the JS7 - PowerShell Module article.
The script introduced in this article Unix Shell CLI can be used to perform frequently used status operations on workflows, jobs and orders. For details see :
Operation | Object | Documentation |
---|---|---|
add / cancel | order |
...
suspend / resume | ||
let run | ||
transfer | ||
suspend / resume | workflow |
...
...
stop / unstop | job |
...
skip / unskip |
Workflow Operation Script
...
-h | --help
- Displays usage.
-v | --verbose
- Displays verbose log output that includes requests and responses with the JS7 REST Web Service.
-p | --password
- Asks the user for interactive keyboard input of the password used for the account specified with the
--user
option.. - The switch is used for secure interactive input as an alternative to use of the option
--password=<password>
.
- Asks the user for interactive keyboard input of the password used for the account specified with the
-r | --recursive
- Specifies that folders will be looked up recursively if the
--folders
option is used.
- Specifies that folders will be looked up recursively if the
-f | --force
- Specifies forcible processing. When used with the
add-order
command then JS7 - Admission Times for Jobs will be ignored and the job will be executed. When used withcancel-order
andsuspend-order
commands then a currently running job will be terminated. See JS7 - FAQ - How does JobScheduler terminate Jobs.
- Specifies forcible processing. When used with the
--show-logs
- Displays the log output created by the script if the
--log-dir
option is used.
- Displays the log output created by the script if the
--make-dirs
- If directories are missing that are indicated with the
--log-dir
option then they will be created.
- If directories are missing that are indicated with the
Exit Codes
0:
cancellation of orders successfully initiated status operation successful1
: argument errors3
: no objects found4
: JS7 REST Web Service is not reachable or reports errors
...
Overview
Content Tools