Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetKxDataview

Retrieves details of the dataview.

Request Syntax


GET /kx/environments/environmentId/databases/databaseName/dataviews/dataviewName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

databaseName

The name of the database where you created the dataview.

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

Required: Yes

dataviewName

A unique identifier for the dataview.

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

Required: Yes

environmentId

A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "activeVersions": [ 
      { 
         "attachedClusters": [ "string" ],
         "changesetId": "string",
         "createdTimestamp": number,
         "segmentConfigurations": [ 
            { 
               "dbPaths": [ "string" ],
               "onDemand": boolean,
               "volumeName": "string"
            }
         ],
         "versionId": "string"
      }
   ],
   "autoUpdate": boolean,
   "availabilityZoneId": "string",
   "azMode": "string",
   "changesetId": "string",
   "createdTimestamp": number,
   "databaseName": "string",
   "dataviewName": "string",
   "description": "string",
   "environmentId": "string",
   "lastModifiedTimestamp": number,
   "readWrite": boolean,
   "segmentConfigurations": [ 
      { 
         "dbPaths": [ "string" ],
         "onDemand": boolean,
         "volumeName": "string"
      }
   ],
   "status": "string",
   "statusReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

activeVersions

The current active changeset versions of the database on the given dataview.

Type: Array of KxDataviewActiveVersion objects

autoUpdate

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.

Type: Boolean

availabilityZoneId

The identifier of the availability zones.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 12.

Pattern: ^[a-zA-Z0-9-]+$

azMode

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

Type: String

Valid Values: SINGLE | MULTI

changesetId

A unique identifier of the changeset that you want to use to ingest data.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: ^[a-zA-Z0-9]+$

createdTimestamp

The timestamp at which the dataview 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.

Type: Timestamp

databaseName

The name of the database where you created the dataview.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

dataviewName

A unique identifier for the dataview.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

description

A description of the dataview.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

environmentId

A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: .*\S.*

lastModifiedTimestamp

The last time that the dataview was updated 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.

Type: Timestamp

readWrite

Returns True if the dataview is created as writeable and False otherwise.

Type: Boolean

segmentConfigurations

The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

Type: Array of KxDataviewSegmentConfiguration objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

status

The status of dataview creation.

CREATING – The dataview creation is in progress.
UPDATING – The dataview is in the process of being updated.
ACTIVE – The dataview is active.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | FAILED | DELETING

statusReason

The error message when a failed state occurs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 250.

Pattern: ^[a-zA-Z0-9\_\-\.\s]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400