Webservice
Configuration
config.json
In the config file: general/apiAuthentication
Login to get the access token.
POST [/auth/]
- Body parameters
- user (string)
- password (string)
- Sample (body)
important
All the API calls (except /auth/) must content the headers:
Content-Type: application/json
Authorization: Bearer [TOKEN_RESULTANTE_DE_AUTH]
Check service status
Returns http 200 if runnerty is working
GET [/health/]
- Sample (url) http://sample_host.com/api/health
Get chains
Gets loaded chains
GET [/chains/]
Get chain
Gets chain
GET [/chain/:chainId/:uniqueId]
URL parameters
- chainId (Chain ID)
- uniqueId (chain uId or execId)
Sample (url) http://sample_host.com/api/chain/CHAIN_SAMPLE
Force chain execution
Executes the indicated chain if it is not runnning yet
POST [/chain/forceStart/:chainId]
URL parameters
- chainId (Chain ID)
Sample (url) http://sample_host.com/api/chain/forceStart/CHAIN_SAMPLE
Body parameters
- custom_values (object)
- GLOBAL_VALUE_KEY:VALUE_KEY (Global variable and custom value)
- custom_values (object)
Sample (body)
Get a chain processes
Gets the processes of a chain
GET [/processes/:chainId/:uniqueId]
URL parameters
- chainId (chain ID)
- uniqueId (chain uId or execId)
Sample (url) http://sample_host.com/api/processes/CHAIN_SAMPLE
Get process of a chain
Gets a process of a chain
GET [/process/:chainId/:uniqueId/:processId]
URL parameters
- chainId (Chain ID)
- uniqueId (chain uId or execId)
- processId (process ID)
Sample (url) http://sample_host.com/api/process/CHAIN_SAMPLE/PROCESS_ONE
CORS Configuation
CORS API configuration parameters:
Options
You can see the configuration options in the module documentation expressjs/cors
Sample: