Scenarios > Tools

The following endpoints allow you to manage tools.

Update tool configuration

patch
/scenarios/tools/{scenarioId}

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 underlaying scenario including properties that were not changed.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
scenarioIdintegerRequired

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

Example: 112
Query parameters
Body
namestringOptional

The name of the tool.

descriptionstringOptional

A description of the tool.

inputsobject[]Optional
moduleobjectOptional

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

Responses
chevron-right
200

Scenario was updated successfully

application/json
patch
/scenarios/tools/{scenarioId}
200

Scenario was updated successfully

Last updated