Skip to main content

list-folders 

dci list-folders [flags]

Returns Cloud Analytics folders the current customer has access to. Folders are returned in id-ascending order.

Flags​

--max-results: (string default:"50")

--page-token: (string)

Responses​

200 (application/json)​

OK - The request succeeded.

{
  "type": "object",
  "properties": {
    "pageToken": {
      "type": "string",
      "description": "Page token, returned by a previous call, to request the next page of results."
    },
    "rowCount": {
      "type": "integer",
      "description": "Number of folders returned in this page."
    },
    "folders": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A Cloud Analytics folder.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Folder ID."
          },
          "name": {
            "type": "string",
            "description": "Folder name."
          },
          "description": {
            "type": "string",
            "description": "Folder description."
          },
          "parentFolderId": {
            "type": "string",
            "description": "Identifier of the parent folder. Set to \"root\" if the folder is at the top level.",
            "example": "root"
          }
        }
      }
    }
  }
}

400 (application/json)​

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

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

401 (application/json)​

Unauthorized - Invalid API key.

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

403 (application/json)​

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

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

500 (application/json)​

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

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

Aliases: list-folders, listfolders