Data Views Data

The Data API allows users to retrieve data for a specified data view. This API is one portion of the data views API.

Get Data View Interpolated Data

Returns interpolated data for the provided index parameters with paging. See documentation on paging for further information.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/data/interpolated
?startIndex={startIndex}&endIndex={endIndex}&interval={interval}&form={form}&continuationToken={continuationToken}&count={count}&cache={cache}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

string startIndex
The requested start index, inclusive. The default value is the .DefaultStartIndex of the data view. Optional if a default value is specified.

string endIndex
The requested end index, inclusive. The default value is the .DefaultEndIndex of the data view. Optional if a default value is specified.

string interval
The requested interval between index values. The default value is the .DefaultInterval of the data view. Optional if a default is specified.

string form
The requested data output format. Output formats: default, table, tableh, csv, csvh.

string continuationToken
The token used to retrieve the next page of data when paging through large result sets.

Do not specify a continuationToken when requesting the first page of data. The value of continuationToken is returned in the response when additional data is available, and must be provided in the next request to continue retrieving results from where the previous request ended.

The token encodes information about the current position in the data set and is only valid when used with the same values for other query parameters, such as startIndex, endIndex, interval, form, count, and cache. If you change any of these parameters, the continuationToken may become invalid or ignored.

For example, a continuationToken value might look like: eyJpZCI6IjEyMzQ1NiIsImxhc3RJbmRleCI6IjIwMjQtMDgtMTVUMDg6MDA6MDBaIn0.

integer count
The requested page size. The maximum is 250,000. If the parameter is not provided, an optimal page size will be calculated.

[optional] string cache
Controls when the data view backing resources are to be refreshed. Used only when requesting the first page of data. Ignored if used with the continuationToken. Values are:

| Value | Description | |--|--| | Refresh | Force the resource to re-resolve. This is the default value for this API route.
| Preserve| Use cached information, if available.

Response

Response Headers

Example response body

200 Response

null

400 Response (ErrorResponse)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  },
  "ChildErrors": {
    "property1": null,
    "property2": null
  }
}

Get Data View Stored Data

Returns stored data for the provided index parameters with paging. See documentation on paging for further information.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/data/stored
?startIndex={startIndex}&endIndex={endIndex}&form={form}&continuationToken={continuationToken}&count={count}&cache={cache}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

string startIndex
The requested start index, inclusive. The default value is the .DefaultStartIndex of the data view. Optional if a default value is specified.

string endIndex
The requested end index, inclusive. The default value is the .DefaultEndIndex of the data view. Optional if a default value is specified.

string form
The requested data output format. Output formats: default, table, tableh, csv, csvh.

string continuationToken
The token used to retrieve the next page of data when paging through large result sets.

Do not specify a continuationToken when requesting the first page of data. The value of continuationToken is returned in the response when additional data is available, and must be provided in the next request to continue retrieving results from where the previous request ended.

The token encodes information about the current position in the data set and is only valid when used with the same values for other query parameters, such as startIndex, endIndex, interval, form, count, and cache. If you change any of these parameters, the continuationToken may become invalid or ignored.

For example, a continuationToken value might look like: eyJpZCI6IjEyMzQ1NiIsImxhc3RJbmRleCI6IjIwMjQtMDgtMTVUMDg6MDA6MDBaIn0.

integer count
The requested page size. The maximum is 250,000. If the parameter is not provided, an optimal page size will be calculated.

[optional] string cache
Controls when the data view backing resources are to be refreshed. Used only when requesting the first page of data. Ignored if used with the continuationToken. Values are:

| Value | Description | |--|--| | Refresh | Force the resource to re-resolve. This is the default value for this API route.
| Preserve| Use cached information, if available.

Response

Response Headers

Example response body

200 Response

null

400 Response (ErrorResponse)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  },
  "ChildErrors": {
    "property1": null,
    "property2": null
  }
}

Definitions

ErrorResponse

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  },
  "ChildErrors": {
    "property1": null,
    "property2": null
  }
}