FlexDeploy supports a REST Service interface using JSON. This enables access to capabilities of the tool from outside applications such as scheduling tools, scripts, and other build tools.

Make sure that you have request header Content-Type set to application/json.

 

http://<host>:<port>/flexdeploy/rest/workflow

API Functions

 

Authentication

The authentication parameter is comprised of 2 fields.

  • userId – a valid user id for FlexDeploy
  • password – the associated password

Inputs

This is a list of name/value pairs for the inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the workflow to run, it does not need to be changed.

Flex Fields

Applicable only for deployProject and deployApplication. This is a list of name (Display Name of FlexField)/value pairs for the FlexFields. Not all FlexFields need to be supplied. If a flex field has a default value or options that are acceptable for the workflow to run, it does not need to be changed.

InstanceCodes

The list of instances where the deployment will occur.