Using the Web API
Last updated
Last updated
The web api service must be first installed and started (see topic Web Api Service Setup)
The following Postman screens shows how to setup a sample project call using the web API:
The following C# shows how to setup a sample project using the web api:
Connection Params
Description
Organization
The organization. When not specified, Default is used
DatabaseId
The id the project database.
UserId
The user id for running the job
Password
The encrypted user password for running the job.
ApiKey
Security feature, Optional if a webapi key is not specified in the WebApi service config file, Must match the ApiKey on the server if specified - the project will be only run if Apikeys match on client and server
Execution Params
Description
Projectid
The integer id of the project to run
Reference
Optional reference for the job
Interactive
Mode for running the job: false = background (the project is launched only), true = foreground (the api waits for the project to end (used when return arguments are specified -example waiting for a return code to execute another project), Note: Default is false
Arguments
Optional name/value dictionary of arguments for running the job in Json format, leave blank if none (remove the Arguments json)