Skip to main content

list-datahub-datasets 

restish dci list-datahub-datasets

Returns a list of all DataHub datasets for the customer.

Responsesโ€‹

200 (application/json)โ€‹

OK - List of datasets returned successfully.

{
  "type": "object",
  "properties": {
    "datasets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the dataset.",
            "example": "My Custom Dataset"
          },
          "description": {
            "type": "string",
            "description": "The description of the dataset.",
            "example": "Dataset for tracking custom business metrics"
          },
          "records": {
            "type": "integer",
            "format": "int64",
            "description": "The number of records in the dataset.",
            "example": 1500
          },
          "updatedBy": {
            "type": "string",
            "description": "The email of the user who last updated the dataset.",
            "example": "[email protected]"
          },
          "lastUpdated": {
            "type": "string",
            "description": "The timestamp of the last update.",
            "example": "2024-03-10T23:00:00Z"
          }
        }
      }
    }
  }
}

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-datahub-datasets, listdatahubdatasets