get-custom-theme

dci get-custom-theme id

Returns a custom theme by the specified Id.

Output

OK - Custom theme 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
`id`	string	The unique identifier of the custom theme.
`name`	string	The display name of the custom theme.
`primaryColor`	string	A color in hex notation. Accepts `#RGB`, `#RRGGBB`, or `#RRGGBBAA`.
`colors`	object	Palettes for light and dark display modes. Each palette must contain between 1 and 32 hex colors.
`colors.light`	array of string	Colors used when the report is displayed in light mode.
`colors.dark`	array of string	Colors used when the report is displayed in dark mode.
`createTime`	string (date-time)	The creation time of the custom theme.
`updateTime`	string (date-time)	The time when the custom theme was last updated.

Raw JSON schema

{
  "required": [
    "id",
    "name",
    "primaryColor",
    "colors"
  ],
  "type": "object",
  "description": "A custom color theme applied to Cloud Analytics reports.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the custom theme."
    },
    "name": {
      "type": "string",
      "description": "The display name of the custom theme.",
      "maxLength": 200
    },
    "primaryColor": {
      "type": "string",
      "description": "A color in hex notation. Accepts `#RGB`, `#RRGGBB`, or `#RRGGBBAA`.",
      "pattern": "^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
      "example": "#1A73E8"
    },
    "colors": {
      "type": "object",
      "required": [
        "light",
        "dark"
      ],
      "description": "Palettes for light and dark display modes. Each palette must contain between 1 and 32 hex colors.",
      "properties": {
        "light": {
          "type": "array",
          "minItems": 1,
          "maxItems": 32,
          "items": {
            "type": "string",
            "description": "A color in hex notation. Accepts `#RGB`, `#RRGGBB`, or `#RRGGBBAA`.",
            "pattern": "^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
            "example": "#1A73E8"
          },
          "description": "Colors used when the report is displayed in light mode."
        },
        "dark": {
          "type": "array",
          "minItems": 1,
          "maxItems": 32,
          "items": {
            "type": "string",
            "description": "A color in hex notation. Accepts `#RGB`, `#RRGGBB`, or `#RRGGBBAA`.",
            "pattern": "^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
            "example": "#1A73E8"
          },
          "description": "Colors used when the report is displayed in dark mode."
        }
      }
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "The creation time of the custom theme."
    },
    "updateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time when the custom theme was last updated."
    }
  }
}

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	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.
404	20	`RESOURCE_NOT_FOUND`	The requested resource does not exist. Check the identifier argument.

Aliases: getcustomtheme

Output​

Errors​

Output

Errors