Tools

List all tools

Returns all tools in the tool registry.

get/tools

Request

  • Base URL: https://example.itential.io
  • URL: https://example.itential.io/tools
  • Auth: none declared

Query parameters

skipinteger

The number of results to skip for pagination.

limitinteger

The maximum number of results to return.

typestring

The type of tool to search for.

namestring

Resource name.

referenceIdsstring

Comma separated referenceIds of tools.

descriptionstring

A keyword to match against tool descriptions.

activeboolean

Whether to only return active tools.

parentIdsstring

Comma separated list of parentIds to filter tools by.

parentTypesstring

Comma separated list of parentTypes to filter tools by.

parentTitlesstring

Comma separated list of parentTitles to filter tools by.

excludeToolChildrenboolean

If true, exclude tools that are children of other tools (i.e. only return top-level tools).

sort'name' | 'type' | 'description' | 'source' | 'referenceId'

Determines which field to sort by. Defaults to name

order'asc' | 'desc'

Determines whether to sort by ascending or descending alphanumeric order. Defaults to ascending.

Response

Contains the list of tools

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.