...

• The REST Web Service API is called by using an HTTP client that sends JSON based requests and that receives JSON based responses.
• The following REST Web Service API requests are available:
  • URL joc/api/authentication/login
    • The first operation of a client is 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. For HTTPS connections in addition or alternatively JS7 - Certificate based Authentication can apply, for details see JS7 - Identity and Access Management.
    • Permissions apply as explained by JS7 - Management of User Accounts, Roles and Permissions.
  • URL  joc/api/* 
    
    • Subsequent calls to URLs can for example retrieve the inventory of workflow.
    • Find the respective URLs from the Technical Documentation of the REST Web Service API
    • The JS7 REST Web Service API returns the respective JSON response indicated with the docs.
  • URL joc/api/authentication/logout
    • The last operation of a client is a call to this URL in order to logout from the REST Web Service API.
• Requirements
  • REST Web Service API requests should use HTTP POST or GET operations as indicated.
  • Should the idle timeout between two web service requests exceed the JOC Cockpit session timeout then a login has to be performed, see JS7 - Settings.

Examples

Further Ressources