API Reference

Get diagram components

post
https://api.doit.com/clouddiagrams/v1/scheme/get

Returns diagram and statussheet data. When the request body is empty, returns all diagrams the caller has access to (scheme map only). When the body is populated, returns full diagram data including statussheet components projected to key display and cloud fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Include components in the statussheet response.

boolean

Include external (cross-diagram) components.

boolean

Include elements.

boolean

Include links.

boolean

Include groups.

boolean

Include notes.

boolean

Include combiners.

type
array of strings

Filter diagrams by type.

type
string
enum

Filter components by node type.

boolean

Include alarm counts (default true).

boolean

Include issue counts.

boolean

Omit diagrams that have no components.

boolean

Exclude the default VPC group (default true).

boolean

Exclude empty subnet groups (default true).

Body Params

Request body for getting diagram components. Leave empty to retrieve all accessible diagrams (returns scheme map only).

scheme
array of strings

IDs of diagrams to load.

scheme
statussheet
array of strings

IDs of statussheets to load.

statussheet
enum

Template type or array of template statussheet IDs to include.

Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago