v1

latestOpenAPI 3.0.02026-07-23620132.5 KB
Scenarios / Tools

Update tool configuration

Updates a tool configuration with a given scenario ID by passing new values in the request body. Any property that is not provided will be left unchanged. In the response, it returns all details of the updated tool configuration of the underlying scenario, including properties that were not changed.

patch/scenarios/tools/{scenarioId}

Path parameters

scenarioIdinteger required

The ID of the scenario. You can get the scenarioId with the List scenarios API call.

Query parameters

cols[]string[]

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

Request body

namestring

The name of the tool.

descriptionstring

A description of the tool.

inputsobject[]
moduleobject

The module of the tool. The module is a JSON object that contains the module ID, version, mapper, parameters, and metadata.

Response

Scenario was updated successfully