get-statussheet-components

dci get-statussheet-components <id> [body] [flags]

Returns the specified components of a diagram layer. Provide at least one component type with one or more IDs in the request body (for example, node or element).

id — Layer ID: the ssid of a layer listed by dci get-cloud-diagram-components (also the ss_id field in dci get-cloud-diagrams-stats and dci search-cloud-diagrams results).

Pass the request body as name: value arguments or pipe JSON on stdin — see Command structure.

Examples

# Fetch specific nodes of a layer by component ID (IDs come from `dci search-cloud-diagrams` or `dci export-cloud-diagram-json`).
dci get-statussheet-components <layer-id> node: [<node-id>]

# Nodes and groups in one call, projected to a few fields.
dci get-statussheet-components <layer-id> --p "name cld_id cld_type" node: [<node-id>], group: [<group-id>]

# A longer selection read from a file.
dci get-statussheet-components <layer-id> < components.json

# components.json
{"node": ["<node-id>", "<node-id>"], "element": ["<element-id>"], "link": ["<link-id>"]}

Request

Content-Type: application/json

Field	Type	Description
`node`	array of string	Node IDs to fetch.
`element`	array of string	Element IDs to fetch.
`link`	array of string	Link IDs to fetch.
`group`	array of string	Group IDs to fetch.
`attachment`	array of string	Attachment IDs to fetch.
`note`	array of string	Note IDs to fetch.
`combiner`	array of string	Combiner IDs to fetch.

Raw JSON schema

{
  "type": "object",
  "description": "Request body for getting layer components. At least one component type must be\nprovided with one or more IDs.",
  "minProperties": 1,
  "properties": {
    "node": {
      "type": "array",
      "minItems": 1,
      "description": "Node IDs to fetch.",
      "items": {
        "type": "string"
      }
    },
    "element": {
      "type": "array",
      "minItems": 1,
      "description": "Element IDs to fetch.",
      "items": {
        "type": "string"
      }
    },
    "link": {
      "type": "array",
      "minItems": 1,
      "description": "Link IDs to fetch.",
      "items": {
        "type": "string"
      }
    },
    "group": {
      "type": "array",
      "minItems": 1,
      "description": "Group IDs to fetch.",
      "items": {
        "type": "string"
      }
    },
    "attachment": {
      "type": "array",
      "minItems": 1,
      "description": "Attachment IDs to fetch.",
      "items": {
        "type": "string"
      }
    },
    "note": {
      "type": "array",
      "minItems": 1,
      "description": "Note IDs to fetch.",
      "items": {
        "type": "string"
      }
    },
    "combiner": {
      "type": "array",
      "minItems": 1,
      "description": "Combiner IDs to fetch.",
      "items": {
        "type": "string"
      }
    }
  }
}

Flags

Flag	Type	Default	Example	Description
`--p`	string			Space-separated projection fields for component documents.

Every command also accepts the CLI-wide flags for output shaping — see Output formats and Table output options.

Output

OK - Layer components returned.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
`node`	map of object	Map of node ID to node component.
`node.*._id`	string	Node ID.
`node.*.name`	string	Component name.
`node.*.props`	object	Custom component properties (key-value pairs).
`node.*.cld_id`	string	Cloud resource ID (set on cloud-imported components).
`node.*.cld_type`	string	Cloud account type. One of: `"AWS"`, `"GCP"`, `"AZURE"`.
`node.*.cld_sync`	boolean	Whether this component is synced with cloud.
`node.*.cld_account`	string	Cloud account ID.
`node.*.tags`	array of string	Tags assigned to the component.
`node.*.color`	string	Node color.
`node.*.icon`	string	Node icon identifier.
`node.*.parent`	string	Parent node ID.
`node.*.infra_node`	object	Reference to a linked infrastructure node in another diagram.
`node.*.infra_node._id`	string	Infrastructure node ID.
`node.*.infra_node.scheme_id`	string	Parent diagram ID.
`node.*.infra_node.ss_id`	string	Parent layer ID.
`node.*.instance_count`	integer	Number of instances represented by this node.
`node.*.running`	boolean	Whether the node is currently running.
`node.*.issues`	array of object	Issues associated with this node.
`node.*.issues[]._id`	string	Issue reference ID.
`node.*.issues[].comment`	string	Optional comment on the issue.
`node.*.issues[].snoozed`	number	Snooze duration in seconds.
`node.*.issues[].jira`	string	Linked Jira ticket key or URL.
`element`	map of object	Map of element ID to element component.
`element.*._id`	string	Element ID.
`element.*.name`	string	Component name.
`element.*.props`	object	Custom component properties (key-value pairs).
`element.*.cld_id`	string	Cloud resource ID (set on cloud-imported components).
`element.*.cld_type`	string	Cloud account type. One of: `"AWS"`, `"GCP"`, `"AZURE"`.
`element.*.cld_sync`	boolean	Whether this component is synced with cloud.
`element.*.cld_account`	string	Cloud account ID.
`element.*.tags`	array of string	Tags assigned to the component.
`element.*.color`	string	Element color.
`element.*.icon`	string	Element icon identifier.
`element.*.parent`	string	Parent element ID.
`element.*.issues`	array of object	Issues associated with this element.
`element.*.issues[]._id`	string	Issue reference ID.
`element.*.issues[].comment`	string	Optional comment on the issue.
`element.*.issues[].snoozed`	number	Snooze duration in seconds.
`element.*.issues[].jira`	string	Linked Jira ticket key or URL.
`group`	map of object	Map of group ID to group component.
`group.*._id`	string	Group ID.
`group.*.name`	string	Component name.
`group.*.props`	object	Custom component properties (key-value pairs).
`group.*.cld_id`	string	Cloud resource ID (set on cloud-imported components).
`group.*.cld_type`	string	Cloud account type. One of: `"AWS"`, `"GCP"`, `"AZURE"`.
`group.*.cld_sync`	boolean	Whether this component is synced with cloud.
`group.*.cld_account`	string	Cloud account ID.
`group.*.tags`	array of string	Tags assigned to the component.
`group.*.group_type`	string	Group type. One of: `"account"`, `"az"`, `"azure_subscription"`, `"customer_gateway"`, `"ecs"`, `"eks"`, `"aks"`, `"k8s_namespace"`, `"k8s_pod"`, `"k8s_deployment"`, `"k8s_daemon_set"`, `"k8s_replica_set"`, ….
`group.*.color`	string	Group color.
`group.*.icon`	string	Group icon identifier.
`group.*.items`	array of object	Components contained in the group.
`group.*.items[]._id`	string	Component ID.
`group.*.items[].type`	string	Component type. One of: `"attachment"`, `"combiner"`, `"element"`, `"group"`, `"link"`, `"node"`, `"note"`, `"scheme"`, `"statussheet"`.
`group.*.issues`	array of object	Issues associated with this group.
`group.*.issues[]._id`	string	Issue reference ID.
`group.*.issues[].comment`	string	Optional comment on the issue.
`group.*.issues[].snoozed`	number	Snooze duration in seconds.
`group.*.issues[].jira`	string	Linked Jira ticket key or URL.
`link`	map of object	Map of link ID to link component.
`link.*._id`	string	Link ID.
`link.*.name`	string	Component name.
`link.*.props`	object	Custom component properties (key-value pairs).
`link.*.cld_id`	string	Cloud resource ID (set on cloud-imported components).
`link.*.cld_type`	string	Cloud account type. One of: `"AWS"`, `"GCP"`, `"AZURE"`.
`link.*.cld_sync`	boolean	Whether this component is synced with cloud.
`link.*.cld_account`	string	Cloud account ID.
`link.*.tags`	array of string	Tags assigned to the component.
`link.*.connection_type`	string	Link connection type. One of: `"normal"`, `"tunnel"`, `"private"`, `"VPN"`, `"VPC Peering"`, `"Network Connectivity Center"`, `"Private Service Connect"`, `"Private Google Access"`, `"Serverless VPC"`, `"Serverless VPC Access Connector"`, `"Cross Cloud Interconnect"`, `"Partner Interconnect"`, ….
`link.*.origin`	object	Reference to a diagram component, including its parent diagram and layer.
`link.*.origin._id`	string	Component ID.
`link.*.origin.type`	string	Component type. One of: `"attachment"`, `"combiner"`, `"element"`, `"group"`, `"link"`, `"node"`, `"note"`, `"scheme"`, `"statussheet"`.
`link.*.origin.scheme_id`	string	Parent diagram ID.
`link.*.origin.ss_id`	string	Parent layer ID.
`link.*.destination`	object	Reference to a diagram component, including its parent diagram and layer.
`link.*.destination._id`	string	Component ID.
`link.*.destination.type`	string	Component type. One of: `"attachment"`, `"combiner"`, `"element"`, `"group"`, `"link"`, `"node"`, `"note"`, `"scheme"`, `"statussheet"`.
`link.*.destination.scheme_id`	string	Parent diagram ID.
`link.*.destination.ss_id`	string	Parent layer ID.
`link.*.owner_ss_id`	string	Owner layer ID for cross-diagram links.
`link.*.issues`	array of object	Issues associated with this link.
`link.*.issues[]._id`	string	Issue reference ID.
`link.*.issues[].comment`	string	Optional comment on the issue.
`link.*.issues[].snoozed`	number	Snooze duration in seconds.
`link.*.issues[].jira`	string	Linked Jira ticket key or URL.
`attachment`	map of object	Map of attachment ID to attachment component.
`attachment.*._id`	string	Attachment ID.
`attachment.*.name`	string	Component name.
`attachment.*.props`	object	Custom component properties (key-value pairs).
`attachment.*.cld_id`	string	Cloud resource ID (set on cloud-imported components).
`attachment.*.cld_type`	string	Cloud account type. One of: `"AWS"`, `"GCP"`, `"AZURE"`.
`attachment.*.cld_sync`	boolean	Whether this component is synced with cloud.
`attachment.*.cld_account`	string	Cloud account ID.
`attachment.*.tags`	array of string	Tags assigned to the component.
`attachment.*.color`	string	Attachment color.
`attachment.*.icon`	string	Attachment icon identifier.
`attachment.*.group`	string	Parent group ID.
`attachment.*.issues`	array of object	Issues associated with this attachment.
`attachment.*.issues[]._id`	string	Issue reference ID.

注意

The field list above is truncated. Expand the raw JSON schema below for the full structure.

Raw JSON schema

{
  "type": "object",
  "description": "Component collections of a diagram layer, keyed by component ID.",
  "properties": {
    "node": {
      "type": "object",
      "description": "Map of node ID to node component.",
      "additionalProperties": {
        "type": "object",
        "required": [
          "_id"
        ],
        "description": "A node component (host, service, or application component).",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Node ID."
          },
          "name": {
            "type": "string",
            "description": "Component name."
          },
          "props": {
            "type": "object",
            "additionalProperties": true,
            "description": "Custom component properties (key-value pairs)."
          },
          "cld_id": {
            "type": "string",
            "description": "Cloud resource ID (set on cloud-imported components)."
          },
          "cld_type": {
            "type": "string",
            "enum": [
              "AWS",
              "GCP",
              "AZURE"
            ],
            "description": "Cloud account type."
          },
          "cld_sync": {
            "type": "boolean",
            "description": "Whether this component is synced with cloud."
          },
          "cld_account": {
            "type": "string",
            "description": "Cloud account ID."
          },
          "tags": {
            "type": "array",
            "description": "Tags assigned to the component.",
            "items": {
              "type": "string"
            }
          },
          "color": {
            "type": "string",
            "description": "Node color."
          },
          "icon": {
            "type": "string",
            "description": "Node icon identifier."
          },
          "parent": {
            "type": "string",
            "description": "Parent node ID."
          },
          "infra_node": {
            "type": "object",
            "required": [
              "_id",
              "scheme_id",
              "ss_id"
            ],
            "description": "Reference to a linked infrastructure node in another diagram.",
            "properties": {
              "_id": {
                "type": "string",
                "description": "Infrastructure node ID."
              },
              "scheme_id": {
                "type": "string",
                "description": "Parent diagram ID."
              },
              "ss_id": {
                "type": "string",
                "description": "Parent layer ID."
              }
            }
          },
          "instance_count": {
            "type": "integer",
            "description": "Number of instances represented by this node."
          },
          "running": {
            "type": "boolean",
            "description": "Whether the node is currently running."
          },
          "issues": {
            "type": "array",
            "description": "Issues associated with this node.",
            "items": {
              "type": "object",
              "description": "Issue annotation linked to a component.",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "Issue reference ID."
                },
                "comment": {
                  "type": "string",
                  "description": "Optional comment on the issue."
                },
                "snoozed": {
                  "type": "number",
                  "description": "Snooze duration in seconds."
                },
                "jira": {
                  "type": "string",
                  "description": "Linked Jira ticket key or URL."
                }
              }
            }
          }
        }
      }
    },
    "element": {
      "type": "object",
      "description": "Map of element ID to element component.",
      "additionalProperties": {
        "type": "object",
        "required": [
          "_id"
        ],
        "description": "An element component (application-layer component).",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Element ID."
          },
          "name": {
            "type": "string",
            "description": "Component name."
          },
          "props": {
            "type": "object",
            "additionalProperties": true,
            "description": "Custom component properties (key-value pairs)."
          },
          "cld_id": {
            "type": "string",
            "description": "Cloud resource ID (set on cloud-imported components)."
          },
          "cld_type": {
            "type": "string",
            "enum": [
              "AWS",
              "GCP",
              "AZURE"
            ],
            "description": "Cloud account type."
          },
          "cld_sync": {
            "type": "boolean",
            "description": "Whether this component is synced with cloud."
          },
          "cld_account": {
            "type": "string",
            "description": "Cloud account ID."
          },
          "tags": {
            "type": "array",
            "description": "Tags assigned to the component.",
            "items": {
              "type": "string"
            }
          },
          "color": {
            "type": "string",
            "description": "Element color."
          },
          "icon": {
            "type": "string",
            "description": "Element icon identifier."
          },
          "parent": {
            "type": "string",
            "description": "Parent element ID."
          },
          "issues": {
            "type": "array",
            "description": "Issues associated with this element.",
            "items": {
              "type": "object",
              "description": "Issue annotation linked to a component.",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "Issue reference ID."
                },
                "comment": {
                  "type": "string",
                  "description": "Optional comment on the issue."
                },
                "snoozed": {
                  "type": "number",
                  "description": "Snooze duration in seconds."
                },
                "jira": {
                  "type": "string",
                  "description": "Linked Jira ticket key or URL."
                }
              }
            }
          }
        }
      }
    },
    "group": {
      "type": "object",
      "description": "Map of group ID to group component.",
      "additionalProperties": {
        "type": "object",
        "required": [
          "_id"
        ],
        "description": "A group component (VPC, subnet, region, cluster, etc.).",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Group ID."
          },
          "name": {
            "type": "string",
            "description": "Component name."
          },
          "props": {
            "type": "object",
            "additionalProperties": true,
            "description": "Custom component properties (key-value pairs)."
          },
          "cld_id": {
            "type": "string",
            "description": "Cloud resource ID (set on cloud-imported components)."
          },
          "cld_type": {
            "type": "string",
            "enum": [
              "AWS",
              "GCP",
              "AZURE"
            ],
            "description": "Cloud account type."
          },
          "cld_sync": {
            "type": "boolean",
            "description": "Whether this component is synced with cloud."
          },
          "cld_account": {
            "type": "string",
            "description": "Cloud account ID."
          },
          "tags": {
            "type": "array",
            "description": "Tags assigned to the component.",
            "items": {
              "type": "string"
            }
          },
          "group_type": {
            "type": "string",
            "enum": [
              "account",
              "az",
              "azure_subscription",
              "customer_gateway",
              "ecs",
              "eks",
              "aks",
              "k8s_namespace",
              "k8s_pod",
              "k8s_deployment",
              "k8s_daemon_set",
              "k8s_replica_set",
              "k8s_stateful_set",
              "project",
              "region",
              "security_group",
              "subnet",
              "vpc",
              "gcp_instance_group",
              "gcp_managed_zone",
              "gke_cluster",
              "azure_dns_zone",
              "azure_cdn_profile",
              "azure_resource_group"
            ],
            "description": "Group type."
          },
          "color": {
            "type": "string",
            "description": "Group color."
          },
          "icon": {
            "type": "string",
            "description": "Group icon identifier."
          },
          "items": {
            "type": "array",
            "description": "Components contained in the group.",
            "items": {
              "type": "object",
              "required": [
                "_id",
                "type"
              ],
              "description": "Reference to a component contained within a group.",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "Component ID."
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "attachment",
                    "combiner",
                    "element",
                    "group",
                    "link",
                    "node",
                    "note",
                    "scheme",
                    "statussheet"
                  ],
                  "description": "Component type."
                }
              }
            }
          },
          "issues": {
            "type": "array",
            "description": "Issues associated with this group.",
            "items": {
              "type": "object",
              "description": "Issue annotation linked to a component.",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "Issue reference ID."
                },
                "comment": {
                  "type": "string",
                  "description": "Optional comment on the issue."
                },
                "snoozed": {
                  "type": "number",
                  "description": "Snooze duration in seconds."
                },
                "jira": {
                  "type": "string",
                  "description": "Linked Jira ticket key or URL."
                }
              }
            }
          }
        }
      }
    },
    "link": {
      "type": "object",
      "description": "Map of link ID to link component.",
      "additionalProperties": {
        "type": "object",
        "required": [
          "_id",
          "origin",
          "destination"
        ],
        "description": "A link component connecting two nodes or groups.",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Link ID."
          },
          "name": {
            "type": "string",
            "description": "Component name."
          },
          "props": {
            "type": "object",
            "additionalProperties": true,
            "description": "Custom component properties (key-value pairs)."
          },
          "cld_id": {
            "type": "string",
            "description": "Cloud resource ID (set on cloud-imported components)."
          },
          "cld_type": {
            "type": "string",
            "enum": [
              "AWS",
              "GCP",
              "AZURE"
            ],
            "description": "Cloud account type."
          },
          "cld_sync": {
            "type": "boolean",
            "description": "Whether this component is synced with cloud."
          },
          "cld_account": {
            "type": "string",
            "description": "Cloud account ID."
          },
          "tags": {
            "type": "array",
            "description": "Tags assigned to the component.",
            "items": {
              "type": "string"
            }
          },
          "connection_type": {
            "type": "string",
            "enum": [
              "normal",
              "tunnel",
              "private",
              "VPN",
              "VPC Peering",
              "Network Connectivity Center",
              "Private Service Connect",
              "Private Google Access",
              "Serverless VPC",
              "Serverless VPC Access Connector",
              "Cross Cloud Interconnect",
              "Partner Interconnect",
              "Dedicated Interconnect"
            ],
            "description": "Link connection type."
          },
          "origin": {
            "type": "object",
            "required": [
              "_id",
              "type",
              "scheme_id",
              "ss_id"
            ],
            "description": "Reference to a diagram component, including its parent diagram and layer.",
            "properties": {
              "_id": {
                "type": "string",
                "description": "Component ID."
              },
              "type": {
                "type": "string",
                "enum": [
                  "attachment",
                  "combiner",
                  "element",
                  "group",
                  "link",
                  "node",
                  "note",
                  "scheme",
                  "statussheet"
                ],
                "description": "Component type."
              },
              "scheme_id": {
                "type": "string",
                "description": "Parent diagram ID."
              },
              "ss_id": {
                "type": "string",
                "description": "Parent layer ID."
              }
            }
          },
          "destination": {
            "type": "object",
            "required": [
              "_id",
              "type",
              "scheme_id",
              "ss_id"
            ],
            "description": "Reference to a diagram component, including its parent diagram and layer.",
            "properties": {
              "_id": {
                "type": "string",
                "description": "Component ID."
              },
              "type": {
                "type": "string",
                "enum": [
                  "attachment",
                  "combiner",
                  "element",
                  "group",
                  "link",
                  "node",
                  "note",
                  "scheme",
                  "statussheet"
                ],
                "description": "Component type."
              },
              "scheme_id": {
                "type": "string",
                "description": "Parent diagram ID."
              },
              "ss_id": {
                "type": "string",
                "description": "Parent layer ID."
              }
            }
          },
          "owner_ss_id": {
            "type": "string",
            "description": "Owner layer ID for cross-diagram links."
          },
          "issues": {
            "type": "array",
            "description": "Issues associated with this link.",
            "items": {
              "type": "object",
              "description": "Issue annotation linked to a component.",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "Issue reference ID."
                },
                "comment": {
                  "type": "string",
                  "description": "Optional comment on the issue."
                },
                "snoozed": {
                  "type": "number",
                  "description": "Snooze duration in seconds."
                },
                "jira": {
                  "type": "string",
                  "description": "Linked Jira ticket key or URL."
                }
              }
            }
          }
        }
      }
    },
    "attachment": {
      "type": "object",
      "description": "Map of attachment ID to attachment component.",
      "additionalProperties": {
        "type": "object",
        "required": [
          "_id"
        ],
        "description": "An attachment component added to a group.",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Attachment ID."
          },
          "name": {
            "type": "string",
            "description": "Component name."
          },
          "props": {
            "type": "object",
            "additionalProperties": true,
            "description": "Custom component properties (key-value pairs)."
          },
          "cld_id": {
            "type": "string",
            "description": "Cloud resource ID (set on cloud-imported components)."
          },
          "cld_type": {
            "type": "string",
            "enum": [
              "AWS",
              "GCP",
              "AZURE"
            ],
            "description": "Cloud account type."
          },
          "cld_sync": {
            "type": "boolean",
            "description": "Whether this component is synced with cloud."
          },
          "cld_account": {
            "type": "string",
            "description": "Cloud account ID."
          },
          "tags": {
            "type": "array",
            "description": "Tags assigned to the component.",
            "items": {
              "type": "string"
            }
          },
          "color": {
            "type": "string",
            "description": "Attachment color."
          },
          "icon": {
            "type": "string",
            "description": "Attachment icon identifier."
          },
          "group": {
            "type": "string",
            "description": "Parent group ID."
          },
          "issues": {
            "type": "array",
            "description": "Issues associated with this attachment.",
            "items": {
              "type": "object",
              "description": "Issue annotation linked to a component.",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "Issue reference ID."
                },
                "comment": {
                  "type": "string",
                  "description": "Optional comment on the issue."
                },
                "snoozed": {
                  "type": "number",
                  "description": "Snooze duration in seconds."
                },
                "jira": {
                  "type": "string",
                  "description": "Linked Jira ticket key or URL."
                }
              }
            }
          }
        }
      }
    },
    "combiner": {
      "type": "object",
      "description": "Map of combiner ID to combiner component.",
      "additionalProperties": {
        "type": "object",
        "required": [
          "_id"
        ],
        "description": "A combiner component that visually groups multiple components.",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Combiner ID."
          },
          "name": {
            "type": "string",
            "description": "Combiner name."
          },
          "color": {
            "type": "string",
            "description": "Combiner color."
          },
          "icon": {
            "type": "string",
            "description": "Combiner icon identifier."
          },
          "items": {
            "type": "array",
            "description": "Components contained in the combiner.",
            "items": {
              "type": "object",
              "required": [
                "_id",
                "type"
              ],
              "description": "A component reference contained within a combiner.",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "Component ID."
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "attachment",
                    "combiner",
                    "element",
                    "group",
                    "link",
                    "node",
                    "note",
                    "scheme",
                    "statussheet"
                  ],
                  "description": "Component type."
                }
              }
            }
          }
        }
      }
    },
    "note": {
      "type": "object",
      "description": "Map of note ID to note component.",
      "additionalProperties": {
        "type": "object",
        "required": [
          "_id"
        ],
        "description": "A text note placed on the diagram.",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Note ID."
          },
          "text": {
            "type": "string",
            "description": "Note text content."
          },
          "color": {
            "type": "string",
            "description": "Note background color."
          },
          "font_size": {
            "type": "number",
            "description": "Note font size."
          }
        }
      }
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping

HTTP status	Exit code	Error code	Meaning
400	30	`VALIDATION_ERROR`	The arguments or request body were rejected. Review the command's flags and payload.
401	10	`AUTHENTICATION_FAILED`	Not signed in, or the API token is invalid. Run `dci login` or check `DCI_API_KEY`.
403	11	`PERMISSION_DENIED`	The DoiT user or the active customer context does not have access.

get-cloud-diagram-components — Get diagram components
export-cloud-diagram-json — Export diagram as JSON
search-cloud-diagrams — Search diagrams and components
list-cloud-diagram-node-activities — List node activities
API reference: POST /clouddiagrams/v1/statussheet/{id}/get

Aliases: getstatussheetcomponents

Examples​

Request​

Flags​

Output​

Errors​

Related​

Examples

Request

Flags

Output

Errors

Related