Skip to main content

get-folder 

dci get-folder id

Returns the specified Cloud Analytics folder.

Responses​

200 (application/json)​

OK - Folder returned.

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

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

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "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: get-folder, getfolder