Skip to main content

Create a dataset

POST 
/api/v2/Dataset

Dataset processing occurs in the background and may take a few minutes to complete.

Request​

Path Parameters

    version stringrequired

Query Parameters

    culture string

    Use this param to override the culture of the response. Options: - en (default) - es

Body

    Identifier stringrequired

    Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z0-9\-]*$

    Unique identifier for the dataset. Must be alphanumeric with optional hyphens. Maximum 64 characters.

    DisplayName string

    Possible values: <= 64 characters

    Display name for the dataset. Maximum 64 characters.

    Description string

    Possible values: <= 4000 characters

    Detailed description of the dataset. Maximum 4000 characters.

    SubtenantId uuid

    Optional subtenant identifier. Required if the user has subtenants.

    TableIdentifier stringrequired

    Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z0-9\-]*$

    Unique identifier for the table within the dataset. Must be alphanumeric with optional hyphens. Maximum 64 characters.

    TableDisplayName string

    Possible values: <= 64 characters

    Display name for the table. Maximum 64 characters.

    TableDescription string

    Possible values: <= 4000 characters

    Detailed description of the table. Maximum 4000 characters.

    File binary

    The data file to upload for the dataset (CSV, Excel, etc.).

Responses​

Dataset created successfully and processing job scheduled.

Loading...