- The JobScheduler Web Service can be used by any client program or job that has to access JobScheduler objects for operations such as adding an order to a job chain.
- The REST Web Service is a replacement for the XML Interface. and require authentication and authorization.
A system administrator manages the permissions required to carry out the operations used by the REST Web Services. More information about how this can be done is available with the Authentication and Authorization - Configuration article. The default setting is 20 minutes.
- The REST Web Service is called by using an HTTP client.
- The following REST web service requests are supported:
- The first operation of a client should be call to this URL in order to authenticate and to retrieve an access token.
- A valid account and password have to be provided by the client for HTTP authentication. The account and permissions for the command(s) to be executed are configured with the
shiro.iniconfiguration file. See the Authentication and Authorization - Configuration article and the example
api_userconfiguration for further information.
- Use the
joc/api/security/joc_cockpit_permissionsURL to retrieve the permissions for the current user.
- The last operation of a client should be a call to this URL in order to logout from the web service
- All REST web service requests should use an HTTP POST operation.
- The current session will be invalidated and a re-login will be required if the idle timeout between two web service requests is exceeded. The idle timeout can be configured in the [main] section of the
shiro.inifile (see Authentication and Authorization - Configuration for more information).
Complete List of Permissions
- The full list of API user permissions that are available for an API user can be seen here, in a format suitable for pasting into a
The following table provides more information about all of the permissions that can be set to allow an API user to address the JobScheduler REST Web Services.
|Permission||Reference to XML Interface||Description|
|Retrieves status information about a JobScheduler Master|
|Shows parameters from |
|Shows the planned start times|
|Terminates and restarts a JobScheduler Master|
|Aborts and restarts a JobScheduler Master|
|Pauses a JobScheduler Master|
|Continues operation of the JobScheduler Master after pausing|
|Terminates a JobScheduler Master|
|Aborts a JobScheduler Master|
|Stops any running tasks in a JobScheduler Master|
|Activates, retrieves and resets log categories|
|Terminates the active JobScheduler cluster member and activates a passive cluster member for fail-over|
|Terminates and restarts all JobScheduler cluster members|
|Terminates all JobScheduler cluster members|
|Retrieve the JobScheduler history|
|Retrieve order status information|
|Modifies the starting and ending states of an order|
|Modifies the run-time of a temporary ad hoc order|
|Modifies order parameters|
|Modifies the run-time of a permanent order|
|Modifies an order's state|
|Modifies any remaining order attributes not covered by other permissions|
|<||Updates an order in the JobScheduler Master |
|Causes an immediate start of the order|
|Updates order attributes|
|Suspends an order|
|Continues a previously suspended order|
|Resets an order|
|Removes a setback setting for an order|
|Removes a temporary ad hoc order from the JobScheduler Master|
|Retrieves status information about a job chain|
|Stops a job chain|
|Continues a previously stopped job chain|
|Add a temporary ad hoc order to a job chain|
|Skips a job chain node|
|Continues processing of a job chain node that has previously been skipped or stopped|
|Stops a job chain node|
|<||Updates a job chain in the JobScheduler Master |
|Removes a job chain|
|Retrieves status information about a job|
|Modifies the run-time of a job|
|<||Updates a job in the JobScheduler Master |
|Starts a job|
|Stops a job|
|Unstops a previously stopped job|
|Terminates a job|
|Kills a task that is running for the job|
|Sends all running tasks for a job a SIGTERM signal|
|Suspends all running tasks for a job|
|Continues all previously suspended tasks for a job|
|Retrieves status information about process classes|
|Modifies a process class|
|Removes a process class|
|<||Updates a process class in the JobScheduler Master |
|Retrieves status information about schedules|
|<||Assigns a substitute schedule to an existing schedule|
|Removes a schedule|
|<||Updates a schedule in the JobScheduler Master |
|Retrieves status information about locks|
|Modifies a lock|
|Removes a lock|
Allow orders to be viewed and executed
Allow all order operations except changing and removing orders
Retrieve permissions for the current user
The answer to the
joc/api/security/joc_cockpit_permissions request is a JSON object.
valueOf(permission) function will be evaluated to
true/false indicating if the permission is granted.
If the user is assigned a role that includes the permissions specified in brackets then the permission will be granted.