Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1431163144.6 KB

Returns information about a Dataset.

get/datasetsv2/{datasetId}

Path parameters

datasetIdstring required

1 - 255 character String

The unique identifier for a Dataset.

Response

Success

datasetIdstring

The unique identifier for a Dataset.

datasetArnstring

The ARN identifier of the Dataset.

datasetTitlestring

Display title for a Dataset.

kind'TABULAR' | 'NON_TABULAR'
<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>
datasetDescriptionstring

A description of the Dataset.

createTimeinteger

The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

lastModifiedTimeinteger

The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

aliasstring

The unique resource identifier for a Dataset.

status'PENDING' | 'FAILED' | 'SUCCESS' | 'RUNNING'
<p>Status of the Dataset creation.</p> <ul> <li> <p> <code>PENDING</code> – Dataset is pending creation.</p> </li> <li> <p> <code>FAILED</code> – Dataset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> – Dataset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> – Dataset creation is running.</p> </li> </ul>