create-datahub-dataset

restish dci create-datahub-dataset

Creates a new DataHub dataset. A dataset is a logical grouping of events that share the same provider name. Creating a dataset allows you to define metadata such as name and description before ingesting events.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the dataset. Allowed characters: alphanumeric (0-9,a-z,A-Z), underscore (_), dash (-), and spaces between words.",
      "example": "My Custom Dataset",
      "pattern": "^[a-zA-Z0-9_-]+( [a-zA-Z0-9_-]+)*$"
    },
    "description": {
      "type": "string",
      "description": "An optional description for the dataset.",
      "example": "Dataset for tracking custom business metrics"
    }
  }
}

Responses

201 (application/json)

Created - Dataset created successfully.

{
  "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": null,
      "nullable": true
    },
    "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"
    }
  }
}

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: create-datahub-dataset, createdatahubdataset