Data View Schemas

The DataViewSchema API provides mechanisms to create, read, and delete data view schemas. This is one portion of the whole data views API.

List Data View Schemas

Returns a list of data view schemas for the specified data view.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/schemas

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

Response

Response Headers

Example response body

200 Response

HTTP 200 OK
Content-Type: application/json
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DataViewId": "demo view 1",
    "CreatedDate": "2019-12-13T01:23:45Z",
    "Fields": [
      ...
    ]
  },
  {
    "Id": "11111111-1111-1111-1111-111111111111",
    "DataViewId": "demo view 1",
    "CreatedDate": "2020-01-06T06:23:15Z",
    "Fields": [
      ...
    ]
  },
  {
    "Id": "22222222-2222-2222-2222-222222222222",
    "DataViewId": "demo view 1",
    "CreatedDate": "2020-02-15T01:31:13Z",
    "Fields": [
      ...
    ]
  }
]

Get Data View Schema

Returns the specified data view schema.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/schemas/{schemaId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

string schemaId
Schema identifier.

Response

Example response body

200 Response

HTTP 200 OK
Content-Type: application/json
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "DataViewId": "demo view 1",
  "CreatedDate": "2019-12-13T01:23:45Z",
  "Fields": [
    {
      "Id": "Timestamp",
      "Label": "Timestamp",
      "TypeCode": "DateTime"
    },
    {
      "Id": "Site",
      "Label": "Site",
      "TypeCode": "String",
      "FieldIndex": 0
    },
    {
      "Id": "Power In Value",
      "Label": "Power In Value",
      "TypeCode": "Double",
      "FieldSetIndex": 0,
      "FieldIndex": 0,
      "IdentifyingValue": "Power In"
    },
    {
      "Id": "Power Out Value",
      "Label": "Power Out Value",
      "TypeCode": "Double",
      "FieldSetIndex": 0,
      "FieldIndex": 0,
      "IdentifyingValue": "Power Out"
    }
  ]
}

Create Data View Schema

Creates a new data view schema and returns the schema as generated in the response.

Request

POST /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/schemas

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

Response

Example response body

201 Response

HTTP 201 Created
Content-Type: application/json
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "DataViewId": "demo view 1",
  "CreatedDate": "2019-12-13T01:23:45Z",
  "Fields": [
    {
      "Id": "Timestamp",
      "Label": "Timestamp",
      "TypeCode": "DateTime"
    },
    {
      "Id": "Site",
      "Label": "Site",
      "TypeCode": "String",
      "FieldIndex": 0
    },
    {
      "Id": "Power In Value",
      "Label": "Power In Value",
      "TypeCode": "Double",
      "FieldSetIndex": 0,
      "FieldIndex": 0,
      "IdentifyingValue": "Power In"
    },
    {
      "Id": "Power Out Value",
      "Label": "Power Out Value",
      "TypeCode": "Double",
      "FieldSetIndex": 0,
      "FieldIndex": 0,
      "IdentifyingValue": "Power Out"
    }
  ]
}

Delete Data View Schema

Deletes the data view schema with the specified id.

Request

DELETE /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/dataviews/{id}/schemas/{schemaId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Data view identifier.

string schemaId
Schema identifier.

Response

Definitions

DataViewSchema

A fixed representation of the fields in a resolved data view as generated at a point in time.

Properties

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "DataViewId": "demo view 1",
  "CreatedDate": "2019-12-13T01:23:45Z",
  "Fields": [
    {
      "Id": "Timestamp",
      "Label": "Timestamp",
      "TypeCode": "DateTime"
    },
    {
      "Id": "Site",
      "Label": "Site",
      "TypeCode": "String",
      "FieldIndex": 0
    },
    {
      "Id": "Power In Value",
      "Label": "Power In Value",
      "TypeCode": "Double",
      "FieldSetIndex": 0,
      "FieldIndex": 0,
      "IdentifyingValue": "Power In"
    },
    {
      "Id": "Power Out Value",
      "Label": "Power Out Value",
      "TypeCode": "Double",
      "FieldSetIndex": 0,
      "FieldIndex": 0,
      "IdentifyingValue": "Power Out"
    }
  ]
}

Field

A fixed representation of a single field or column in a resolved data view as generated at a point in time.

Properties

{
  "Id": "Power In Value",
  "Label": "Power In Value",
  "TypeCode": "Double",
  "Uom": "kW",
  "FieldSetIndex": 0,
  "FieldIndex": 0,
  "IdentifyingValue": "Power In"
}

SdsTypeCode

Enumerated Values

ErrorResponse

Properties

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