Skip to main content

Creates a new dataset by downloading a file from a URL.

POST 
/api/v2/Dataset/Url

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

Request​

Query Parameters

    culture string

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

Body

The dataset creation request containing the file URL and metadata.

    identifier stringrequired

    Possible values: non-empty and <= 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 stringrequired

    Possible values: non-empty and <= 64 characters

    Display name for the dataset. Maximum 64 characters.

    description stringnullable

    Possible values: <= 4000 characters

    Detailed description of the dataset. Maximum 4000 characters.

    subtenantId uuidnullable

    Optional subtenant identifier. Required if the user has subtenants.

    tableIdentifier stringrequired

    Possible values: non-empty and <= 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 stringrequired

    Possible values: non-empty and <= 64 characters

    Display name for the table. Maximum 64 characters.

    tableDescription stringnullable

    Possible values: <= 4000 characters

    Detailed description of the table. Maximum 4000 characters.

    fileUrl stringnullable

    Publicly accessible URL of the CSV file to download and use as the dataset source.

Responses​

Dataset created successfully and processing job scheduled.

Loading...