Jump to

• Request
• Response

Run APIs in Batches

post

/api/core/Batch/execute

Runs the batch of APIs specified in the body as elements in an array.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Actions: array Actions
  Array of objects having API requests defined in them

{
    "properties":{
        "Actions":{
            "description":"Array of objects having API requests defined in them",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "api":{
                        "description":"API endpoint to be executed",
                        "type":"string",
                        "example":"/broker/services"
                    },
                    "method":{
                        "description":"The particular method in the API to be called",
                        "type":"string",
                        "example":"read"
                    },
                    "data":{
                        "description":"Request body for the API",
                        "type":"object",
                        "example":{
                            "ExampleKey":"ExampleValue"
                        }
                    },
                    "dynamicData":{
                        "description":"Variables whose values change dynamically as the batch file is executed",
                        "type":"object",
                        "example":{
                            "ExampleKey":"ExampleValue"
                        }
                    },
                    "response":{
                        "description":"Array of variables whose values need to be populated from the API response",
                        "type":"array",
                        "items":{
                        },
                        "example":[
                            {
                                "varName":"serverID",
                                "fieldName":"ServerID"
                            }
                        ]
                    },
                    "forEach":{
                        "description":"Object denoting a loop over an array of variables to call an API for each of them",
                        "type":"object",
                        "example":{
                            "from":"jobIDs",
                            "varName":"jobID"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : Actions

Type: array

Array of objects having API requests defined in them

Show Source

• Array of: object items

{
    "description":"Array of objects having API requests defined in them",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "api":{
                "description":"API endpoint to be executed",
                "type":"string",
                "example":"/broker/services"
            },
            "method":{
                "description":"The particular method in the API to be called",
                "type":"string",
                "example":"read"
            },
            "data":{
                "description":"Request body for the API",
                "type":"object",
                "example":{
                    "ExampleKey":"ExampleValue"
                }
            },
            "dynamicData":{
                "description":"Variables whose values change dynamically as the batch file is executed",
                "type":"object",
                "example":{
                    "ExampleKey":"ExampleValue"
                }
            },
            "response":{
                "description":"Array of variables whose values need to be populated from the API response",
                "type":"array",
                "items":{
                },
                "example":[
                    {
                        "varName":"serverID",
                        "fieldName":"ServerID"
                    }
                ]
            },
            "forEach":{
                "description":"Object denoting a loop over an array of variables to call an API for each of them",
                "type":"object",
                "example":{
                    "from":"jobIDs",
                    "varName":"jobID"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• api: string
  API endpoint to be executed

  Example: /broker/services
• data: object data
  Request body for the API
• dynamicData: object dynamicData
  Variables whose values change dynamically as the batch file is executed
• forEach: object forEach
  Object denoting a loop over an array of variables to call an API for each of them
• method: string
  The particular method in the API to be called

  Example: read
• response: array response
  Array of variables whose values need to be populated from the API response

{
    "type":"object",
    "properties":{
        "api":{
            "description":"API endpoint to be executed",
            "type":"string",
            "example":"/broker/services"
        },
        "method":{
            "description":"The particular method in the API to be called",
            "type":"string",
            "example":"read"
        },
        "data":{
            "description":"Request body for the API",
            "type":"object",
            "example":{
                "ExampleKey":"ExampleValue"
            }
        },
        "dynamicData":{
            "description":"Variables whose values change dynamically as the batch file is executed",
            "type":"object",
            "example":{
                "ExampleKey":"ExampleValue"
            }
        },
        "response":{
            "description":"Array of variables whose values need to be populated from the API response",
            "type":"array",
            "items":{
            },
            "example":[
                {
                    "varName":"serverID",
                    "fieldName":"ServerID"
                }
            ]
        },
        "forEach":{
            "description":"Object denoting a loop over an array of variables to call an API for each of them",
            "type":"object",
            "example":{
                "from":"jobIDs",
                "varName":"jobID"
            }
        }
    }
}

Nested Schema : data

Type: object

Request body for the API

Example:

{
    "ExampleKey":"ExampleValue"
}

Nested Schema : dynamicData

Type: object

Variables whose values change dynamically as the batch file is executed

Example:

{
    "ExampleKey":"ExampleValue"
}

Nested Schema : forEach

Type: object

Object denoting a loop over an array of variables to call an API for each of them

Example:

{
    "from":"jobIDs",
    "varName":"jobID"
}

Nested Schema : response

Type: array

Array of variables whose values need to be populated from the API response

Show Source

• Array of:

{
    "description":"Array of variables whose values need to be populated from the API response",
    "type":"array",
    "items":{
    },
    "example":[
        {
            "varName":"serverID",
            "fieldName":"ServerID"
        }
    ]
}

Example:

[
    {
        "varName":"serverID",
        "fieldName":"ServerID"
    }
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/coreBatchExecuteResponseBody"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/coreBatchExecuteResponseBody"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object coreBatchExecuteResponseBody

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/coreBatchExecuteResponseBody"
    }
}

Nested Schema : coreBatchExecuteResponseBody

Type: object

Show Source

• api: string
  API endpoint from which the response is returned

  Example: /broker/services
• method: string
  The particular method in the API that was called

  Example: read
• request: object request
  A combined object having properties of both data and dynamicData from the request body
• response: object response
  Response object from the API called

{
    "properties":{
        "api":{
            "description":"API endpoint from which the response is returned",
            "type":"string",
            "example":"/broker/services"
        },
        "method":{
            "description":"The particular method in the API that was called",
            "type":"string",
            "example":"read"
        },
        "request":{
            "description":"A combined object having properties of both data and dynamicData from the request body",
            "type":"object",
            "example":{
                "fromData":"value1",
                "fromDynamicData":"value2"
            }
        },
        "response":{
            "description":"Response object from the API called",
            "type":"object",
            "example":{
                "success":true,
                "message":"example",
                "data":[
                ]
            }
        }
    }
}

Nested Schema : request

Type: object

A combined object having properties of both data and dynamicData from the request body

Example:

{
    "fromData":"value1",
    "fromDynamicData":"value2"
}

Nested Schema : response

Type: object

Response object from the API called

Example:

{
    "success":true,
    "message":"example",
    "data":[
    ]
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top