Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

 


Info
titleBase URL for Workflow Execution REST API
http://<host>:<port>/flexdeploy/rest/workflow
Set the request header Content-Type to application/json.

API Functions

Child pages (Children Display)
 


Excerpt
hiddentrue

Common Parameters

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

...

code/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

...

supplied.

Flex Fields

...

FlexFields

This is a list of

...

the code/value pairs for

...

the Flexfields (not the Display Name). Not all

...

FlexFields need to be supplied. If a

...

FlexField 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.

...

Read more about FlexFields.