Cloud Diagrams

Search diagrams and components

Full-text search across diagram layers, components by name, and components by property values. Returns three result categories: diagram (matching layers), component (matching components by name), and prop (matching components by property values).

post/clouddiagrams/v1/scheme/search

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/clouddiagrams/v1/scheme/search
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Request body

querystring required

Search query string.

ss_idstring

Limit search to components within this layer.

frominteger

Pagination offset (default 0).

sizeinteger

Maximum number of results per category (default 20).

Response

OK - Search results returned.

Changes

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