- Any operations that can be performed on orders, workflows, jobs and related objects such as cancelling, suspending and resuming orders are performed by the JS7 REST Web Service.
- Consider that any operation offered by the JOC Cockpit GUI makes use of the REST Web Service.
- Find the Technical Documentation of the REST Web Service.
- In addition, a PowerShell module is available for simplified access to the REST Web Service, see JS7 - PowerShell Module.
- The REST Web Service is called by using an HTTP client that sends JSON based requests and that receives JSON based responses.
- 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/authentication/joc_cockpit_permissionsURL to retrieve the permissions for the current user.
- Subsequent calls to URLs can e.g. retrieve the inventory and current information about workflows and orders.
- Find the respective URLs from the Technical Documentation of the REST Web Service
- The JS7 REST Web Service will return the respective JSON response.
- The last operation of a client should be a call to this URL in order to logout from the REST Web Service.
- REST Web Service requests should use HTTP POST or GET operations as indicated.
- Should an idle timeout of 15 minutes between two web service requests be exceeded then the current session is invalidated and a login has to be performed. The timeout value can be adjusted with