Overview
This article describes the payload format for running an orchestration with a specific environment configuration. This information is intended to provide clarity where it may be missing from the API Swagger or other documentation.
How It Works
The payload is a JSON object used to specify the project, environment, and configuration for an orchestration run. The top-level key is the Project ID, and its value is an object containing the Environment as the key and the Configuration ID as the value.
Payload Syntax
json
{"PROJECTID":{"ENVIRONMENT":"CONFIGID"}}
- PROJECTID: The unique identifier for the project.
- ENVIRONMENT: The name of the target environment (e.g., "development", "production").
- CONFIGID: The unique identifier for the configuration to be used within the specified environment.
Limitations
There are no known limitations associated with this payload format.
Related Info
For more information, please refer to the main API documentation for running orchestrations.