Intersight allows generic API tasks to be created by taking the API request body and a response parser specification in the form of content.Grammar object. Batch API associates the list of API requests to be executed as part of single task execution. Each API request takes the request body and a response parser specification.
Name | Type | Description | Notes |
---|---|---|---|
batch | list[WorkflowApi] | [optional] | |
constraints | str | Enter the constraints on when this task should match against the task definition. | [optional] |
description | str | A detailed description about the batch APIs. | [optional] |
name | str | Name for the batch API task. | [optional] |
outcomes | object | All the possible outcomes of this task are captured here. Outcomes property is a collection property of type workflow.Outcome objects. The outcomes can be mapped to the message to be shown. The outcomes are evaluated in the order they are given. At the end of the outcomes list, an catchall success/fail outcome can be added with condition as 'true'. This is an optional property and if not specified the task will be marked as success. | [optional] |
output | object | Intersight Orchestrator allows the extraction of required values from API responses using the API response grammar. These extracted values can be mapped to task output parameters defined in task definition. The mapping of API output parameters to the task output parameters is provided as JSON in this property. | [optional] |
skip_on_condition | str | The skip expression, if provided, allows the batch API executor to skip the task execution when the given expression evaluates to true. The expression is given as such a golang template that has to be evaluated to a final content true/false. The expression is an optional and in case not provided, the API will always be executed. | [optional] |
task_definition | WorkflowTaskDefinition | [optional] |