Workflow API serves to interact with process instances and some other auxiliary operations of Workflow Server (for example, working with users, stopping timers in a server instance, etc.). The comprehensive Workflow API documentation is included in the server admin.
This page contains a list of all Workflow API methods available, forms for test requests, all parameters description and code examples that can be copied and pasted directly into your application.
- The name and description of the chosen API method.
- The URL format to be used.
- The button for opening / closing a form with the method parameters.
- The button for testing and sending a request with the filled-in parameters to the server.
- The button for managing the created instances.
- The result of the request execution.
- All method parameters.
Access to Workflow API
The access to Workflow API is not restricted in any way by default. Access options are available in the section: 'Settings' and then by clicking the tab 'Security'.
- Api access token - you can set an access token for Workflow API; if the token is set, then each request to Workflow API must contain a token field with the correct value.
- Use OpenId Connect for token access - if you check this box, the token access mechanism will work through the Identity Server tools, launched along with each instance of Workflow Server. You should fill out the Api access token field to enable this setting. How the access token works using the Identity Server (OpenId) is described in the next section.
Token Access Using Identity Server
First, let us describe the process of obtaining an access token manually. This is essential to understand the method, but, as a rule, it is recommended to use ready-made libraries.
Open this address in your browser: http://localhost:8077/.well-known/openid-configuration to receive JSON with the addresses of all endpoints of the identity server.
In this JSON, you are interested in the address
To obtain a Workflow API access token, a request should be sent to this address with the following parameters:
- client_id = workflowapi
- client_secret = the value of Api access token
- grant_type = client_credentials
POST /connect/token HTTP/1.1
JSON is obtained in response. The
access_tokenproperty should be taken from it.
The access_token obtained must be used with each request to Workflow API.
POST /workflowapi/createinstance/f54104f0-5de2-ea7b-e3be-47c9199a3967 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IkRDQTJFMTI2Nzg4QkY2RjZFQjU3MDY4NjAwQzc3RENDMzlFRkNGRTRSUzI1NiIsInR5cCI6ImF0K2p3dCIsIng1dCI6IjNLTGhKbmlMOXZiclZ3YUdBTWQ5ekRudnotUSJ9.eyJuYmYiOjE2MDY5ODgyMDUsImV4cCI6MTYwNjk5MTgwNSwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDc3IiwiYXVkIjoiV29ya2Zsb3dBcGkiLCJjbGllbnRfaWQiOiJ3b3JrZmxvd2FwaSIsImp0aSI6IjYwQzE3NTZBRkU4REFDQTY4M0Y0QzVDNkU4RDMwRkE3IiwiaWF0IjoxNjA2OTg4MjA1LCJzY29wZSI6WyJXb3JrZmxvd0FwaSJdfQ.auuTeD3hEBl40ZEXK58oSIGyHihuTMTxsFf_qAOeScsw4bcYz7YFVNWQqUPgx7Cno541wKMz70oOwO01M2Es31u9lN87y-jCJCn721vbGQeOXqXAlqztGUB5cJiTerOgVK_Fp4IMpm7TFQdzDKN42k3TPIX4IjOVBnc3bINXCtDnr5iteaLYcvwYI1vU-WyYqjfW4KCcEqwCjUA3F6eUYVMuXIsejD6DTI-7hwLqTP1Hopdtmq5x6W38kBcg1I-LrqPhLpg2-tj0xE7CcqttDWSC0G3wEjO04rflDkA0R58iDOgIuMhcPPZGaT8pAwhA5E0pkEjvIHKBV0aaeJ9pug
"schemeCode" : "TestScheme"
In addition, in case of using .NET Application when calling the workflow API methods, these instructions can be reviewed.