Skip to main content

get-report 

restish dci get-report id [flags]

Returns the results of the specified report.

Flags​

--time-range: (string)

--start-date: (string)

--end-date: (string)

Responses​

200 (application/json)​

OK - The request succeeded.

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Report id."
        },
        "reportName": {
          "type": "string",
          "description": "The name of the report."
        },
        "owner": {
          "type": "string",
          "description": "The report owner in the form of [email protected]"
        },
        "type": {
          "type": "string",
          "enum": [
            "custom",
            "preset"
          ]
        },
        "createTime": {
          "type": "integer",
          "description": "The time when the report was created, in milliseconds since the epoch.",
          "format": "int64"
        },
        "updateTime": {
          "type": "integer",
          "description": "The time when this report was last updated, in milliseconds since the epoch.",
          "format": "int64"
        },
        "urlUI": {
          "type": "string",
          "description": "The URL of the report in DoiT Cloud Navigator."
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": "object",
          "properties": {
            "schema": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                }
              }
            },
            "mlFeatures": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "increasing",
                  "decreasing",
                  "none",
                  "forecast"
                ]
              }
            },
            "rows": {
              "type": "array",
              "items": {
                "type": "array",
                "items": {
                  "description": "The content of a single cell from a BigQuery result.",
                  "type": "object"
                }
              }
            },
            "forecastRows": {
              "type": "array",
              "items": {
                "type": "array",
                "items": {
                  "description": "The content of a single cell from a BigQuery result.",
                  "type": "object"
                }
              }
            },
            "cacheHit": {
              "type": "boolean",
              "description": "If set to true, results were fetched from the cache."
            }
          }
        }
      }
    }
  ]
}

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."
    }
  }
}

429 (application/json)​

Too Many Requests.

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

Aliases: get-report, getreport