Skip to main content

get-dimensions 

restish dci get-dimensions [flags]

Returns a dimension by type and key.

Flags​

--type: (string enum:"datetime","fixed","optional","label","tag","project_label","system_label","attribution","attribution_group","gke","gke_label")

--id: (string)

Responses​

200 (application/json)​

OK - The dimension returned.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "datetime",
        "fixed",
        "optional",
        "label",
        "tag",
        "project_label",
        "system_label",
        "attribution",
        "attribution_group",
        "gke",
        "gke_label"
      ]
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cloud": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  }
}

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)​

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: get-dimensions, getdimensions