DRIVR GraphQL API
DRIVR is an IoT platform that allows device manufacturers to connect their devices, collect data at scale and make aggregated and raw data and device control available through an easy-to-use API. All with simple and transparent SaaS pricing.
This is the static GraphQL API documentation. It contains everything but the metadata, which can be configured per domain by using MetadataTypes. To view the complete schema including metadata or to test the API, go to https://{slug}.api.drivr.cloud/ to open your personal GraphiQL instance or just click on "Open GraphiQL" within the Customer Portal.
API Endpoints
https://{slug}.api.drivr.cloud/graphqlHeaders
# Your API token. Must be included in all API calls.
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
aggregatedDatapoints
Description
Get multiple _AggregatedDatapoint_s.
Response
Returns a PagedAggregatedDatapoints!
Arguments
| Name | Description |
|---|---|
after - String
|
The cursor after which items should be returned. |
carryForward - Boolean
|
Add an aggregate datapoint to each grid interval even if no explicit datapoint was published during that interval. In the case of missing datapoints, the last value recorded is carried forward into empty time intervals. |
characteristicCode - [String]
|
The list of Characteristic codes by which to filter fetched items. |
characteristicUuid - [UUID]
|
The list of Characteristic UUIDs by which to filter fetched items. |
componentCode - [String]
|
The list of Component codes by which to filter fetched items. |
componentModelCode - [String]
|
The list of Component Model codes by which to filter fetched items. |
componentModelUuid - [UUID]
|
The list of Component Model UUIDs by which to filter fetched items. |
componentUuid - [UUID]
|
The list of Component UUIDs by which to filter fetched items. |
from - DateTime
|
The inclusive start of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the previous possible time. A grid of 1h will snap to the previous full hour A grid of 1d snaps to the previous midnight in the UTC time zone A grid of 1w snaps to the previous midnight on Monday in the UTC time zone All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with a time of 12:12:00 matches to 12:00:00 and returns all elements from 12:00:00 to 12:15:00 in this grid. |
grid - Timespan
|
Given a start and end time, a grid is the size of the partitions by which this time period should be divided. It is specified by a timespan in ISO 8601 duration format. If the grid is set, start and end are required. The smallest time unit supported for the grid is second. The largest time unit supported for the grid is week. All grid values must be evenly divisible into the next largest available time unit (minutes, hours, days or weeks). For example, 20s is valid because it can evenly divide into 60 seconds (20 · 3 = 60 seconds = 1 minute). All grid values must be non-zero, non-negative integers. Grid values may be represented in smaller units as long as they evenly divide into the next largest unit. For example, 120s may be used instead of 2m because 120s / 60s = 2m. Grids which are in hours can only be full hours (1-23) (e.g. 1 hour 30 minutes is invalid). Grids which are in days must be full days (1-6) (e.g. 1 day and 3 hours is invalid) Grids which are in weeks cannot have smaller units (days or hours) attached (e.g. 1 week and 1 day is invalid) |
group - [AggregatedDatapointGroup]
|
Group results by object. |
limit - Int
|
The maximum number of items which should be returned. |
orderBy - [DatapointOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
round - Int
|
Optional Integer. Configures the rounding of aggregate values before being counted. round specifies the number decimals to use when rounding the number. 0 rounds to the nearest integer. Optional, defaults to no rounding applied. |
serviceCode - [String]
|
The list of Service codes by which to filter fetched items. |
serviceIndex - [Int]
|
A list of Service & ComponentModel relationship indices to filter retrieved items. |
serviceUuid - [UUID]
|
A list of Service UUIDs by which to filter retrieved items. |
systemCode - [String]
|
The list of System codes by which to filter fetched items. |
systemUuid - [UUID]
|
The list of System UUIDs by which to filter fetched items. |
timeStreamUuid - [UUID]
|
The list of TimeStream UUIDs by which to filter fetched items. |
to - DateTime
|
The exclusive end of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the next possible time. A grid of 1h will snap to the next full hour A grid of 1d snaps to next midnight in the UTC time zone A grid of 1w snaps to the next midnight on Monday in the UTC time zone. All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with an to time of 12:12:00 matches to 12:15:00 and returns all elements from 12:00:00 to 12:15:00 in the last grid. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - AggregatedDatapointsWhereQuery
|
Complex filtering over _AggregatedDatapoint_s. |
Example
Query
query aggregatedDatapoints(
$after: String,
$carryForward: Boolean,
$characteristicCode: [String],
$characteristicUuid: [UUID],
$componentCode: [String],
$componentModelCode: [String],
$componentModelUuid: [UUID],
$componentUuid: [UUID],
$from: DateTime,
$grid: Timespan,
$group: [AggregatedDatapointGroup],
$limit: Int,
$orderBy: [DatapointOrderByQuery],
$round: Int,
$serviceCode: [String],
$serviceIndex: [Int],
$serviceUuid: [UUID],
$systemCode: [String],
$systemUuid: [UUID],
$timeStreamUuid: [UUID],
$to: DateTime,
$uuid: [UUID],
$where: AggregatedDatapointsWhereQuery
) {
aggregatedDatapoints(
after: $after,
carryForward: $carryForward,
characteristicCode: $characteristicCode,
characteristicUuid: $characteristicUuid,
componentCode: $componentCode,
componentModelCode: $componentModelCode,
componentModelUuid: $componentModelUuid,
componentUuid: $componentUuid,
from: $from,
grid: $grid,
group: $group,
limit: $limit,
orderBy: $orderBy,
round: $round,
serviceCode: $serviceCode,
serviceIndex: $serviceIndex,
serviceUuid: $serviceUuid,
systemCode: $systemCode,
systemUuid: $systemUuid,
timeStreamUuid: $timeStreamUuid,
to: $to,
uuid: $uuid,
where: $where
) {
cursor
items {
...AggregatedDatapointFragment
}
limit
}
}
Variables
{
"after": "abc123",
"carryForward": true,
"characteristicCode": ["abc123"],
"characteristicUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentCode": ["xyz789"],
"componentModelCode": ["abc123"],
"componentModelUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"from": "2007-12-03T10:15:30Z",
"grid": Timespan,
"group": ["CHARACTERISTIC"],
"limit": 987,
"orderBy": [DatapointOrderByQuery],
"round": 987,
"serviceCode": ["abc123"],
"serviceIndex": [123],
"serviceUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"systemCode": ["abc123"],
"systemUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"timeStreamUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"to": "2007-12-03T10:15:30Z",
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": AggregatedDatapointsWhereQuery
}
Response
{
"data": {
"aggregatedDatapoints": {
"cursor": "xyz789",
"items": [AggregatedDatapoint],
"limit": 987
}
}
}
aggregatedEvents
Description
Aggregate events on different entities.
Response
Returns a PagedAggregatedEvents!
Arguments
| Name | Description |
|---|---|
after - String
|
The cursor after which items should be returned. |
from - DateTime
|
The inclusive from of the window which data should be requested. |
groupBy - AggregatedEventGroupingEntityType!
|
The grouping which should be applied. |
limit - Int
|
The maximum number of items which should be returned. |
orderBy - [AggregatedEventOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
to - DateTime
|
The exclusive to of the window which data should be requested |
where - AggregatedEventQuery
|
Complex filtering over events |
Example
Query
query aggregatedEvents(
$after: String,
$from: DateTime,
$groupBy: AggregatedEventGroupingEntityType!,
$limit: Int,
$orderBy: [AggregatedEventOrderByQuery],
$to: DateTime,
$where: AggregatedEventQuery
) {
aggregatedEvents(
after: $after,
from: $from,
groupBy: $groupBy,
limit: $limit,
orderBy: $orderBy,
to: $to,
where: $where
) {
cursor
items {
...AggregatedEventFragment
}
limit
}
}
Variables
{
"after": "xyz789",
"from": "2007-12-03T10:15:30Z",
"groupBy": "COMPONENT",
"limit": 987,
"orderBy": [AggregatedEventOrderByQuery],
"to": "2007-12-03T10:15:30Z",
"where": AggregatedEventQuery
}
Response
{
"data": {
"aggregatedEvents": {
"cursor": "xyz789",
"items": [AggregatedEvent],
"limit": 987
}
}
}
applicationConsumer
Description
This endpoint retrieves a specific ApplicationConsumer by UUID.
Response
Returns an ApplicationConsumer!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the ApplicationConsumer. |
Example
Query
query applicationConsumer($uuid: UUID!) {
applicationConsumer(uuid: $uuid) {
createdAt
defaultRedirectUri
domain {
...DomainFragment
}
domainUuid
grantTypes
identifier
name
noExplicitConsentRequired
owner {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
ownerUuid
redirectUris
scopes
secret
slug
status
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"applicationConsumer": {
"createdAt": "2007-12-03T10:15:30Z",
"defaultRedirectUri": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"grantTypes": ["AUTHORIZATION_CODE"],
"identifier": "xyz789",
"name": "abc123",
"noExplicitConsentRequired": false,
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"redirectUris": ["xyz789"],
"scopes": ["xyz789"],
"secret": "xyz789",
"slug": "xyz789",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
applicationConsumers
Description
This endpoint retrieves multiple ApplicationConsumer objects.
Response
Returns a PagedApplicationConsumers!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [ApplicationConsumerOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - ApplicationConsumerQuery
|
Filtering options for ApplicationConsumer objects. |
Example
Query
query applicationConsumers(
$limit: Int,
$offset: Int,
$orderBy: [ApplicationConsumerOrderByQuery],
$uuid: [UUID],
$where: ApplicationConsumerQuery
) {
applicationConsumers(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
items {
...ApplicationConsumerFragment
}
limit
offset
totalItems
}
}
Variables
{
"limit": 123,
"offset": 987,
"orderBy": [ApplicationConsumerOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": ApplicationConsumerQuery
}
Response
{
"data": {
"applicationConsumers": {
"items": [ApplicationConsumer],
"limit": 987,
"offset": 987,
"totalItems": 987
}
}
}
authenticationMethod
Description
Retrieve a specific DomainAuthenticationMethod by its UUID.
Response
Returns an AuthenticationMethod!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the DomainAuthenticationMethod to retrieve. |
Example
Query
query authenticationMethod($uuid: UUID!) {
authenticationMethod(uuid: $uuid) {
... on AzureAuthenticationMethod {
...AzureAuthenticationMethodFragment
}
... on DefaultAuthenticationMethod {
...DefaultAuthenticationMethodFragment
}
... on GoogleAuthenticationMethod {
...GoogleAuthenticationMethodFragment
}
... on OpenIdDelegatedAuthenticationMethod {
...OpenIdDelegatedAuthenticationMethodFragment
}
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"authenticationMethod": AzureAuthenticationMethod
}
}
authenticationMethods
Description
This endpoint returns multiple DomainAuthenticationMethods for the current Domain based on filter criteria specified as arguments. Each DomainAuthenticationMethods represents a global setting for authentication against DRIVR. This could be internal or a third party system depending on the DomainAuthenticationMethod configured.
Response
Returns a PagedAuthenticationMethods!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [DomainAuthenticationMethodOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - DomainAuthenticationMethodQuery
|
Filter the DomainAuthenticationMethods by complex conditions. This can be one or multiple conditions, using field names as keys, and its specific conditions as the value of that key. |
Example
Query
query authenticationMethods(
$limit: Int,
$offset: Int,
$orderBy: [DomainAuthenticationMethodOrderByQuery],
$uuid: [UUID],
$where: DomainAuthenticationMethodQuery
) {
authenticationMethods(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
items {
... on AzureAuthenticationMethod {
...AzureAuthenticationMethodFragment
}
... on DefaultAuthenticationMethod {
...DefaultAuthenticationMethodFragment
}
... on GoogleAuthenticationMethod {
...GoogleAuthenticationMethodFragment
}
... on OpenIdDelegatedAuthenticationMethod {
...OpenIdDelegatedAuthenticationMethodFragment
}
}
limit
offset
totalItems
}
}
Variables
{
"limit": 123,
"offset": 123,
"orderBy": [DomainAuthenticationMethodOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": DomainAuthenticationMethodQuery
}
Response
{
"data": {
"authenticationMethods": {
"items": [AzureAuthenticationMethod],
"limit": 123,
"offset": 987,
"totalItems": 987
}
}
}
certificate
Description
Get a specific Certificate by UUID.
Response
Returns a Certificate!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Certificate to be retrieved. |
Example
Query
query certificate($uuid: UUID!) {
certificate(uuid: $uuid) {
certificate
createdAt
csr
domain {
...DomainFragment
}
domainUuid
duration
entity {
... on Component {
...ComponentFragment
}
... on System {
...SystemFragment
}
}
entityType
entityUuid
expiresAt
issuer {
...IssuerFragment
}
issuerUuid
name
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"certificate": {
"certificate": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csr": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"duration": Timespan,
"entity": Component,
"entityType": "COMPONENT",
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"expiresAt": "2007-12-03T10:15:30Z",
"issuer": Issuer,
"issuerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
certificates
Description
Retrieve multiple Certificates.
Response
Returns a PagedCertificates!
Arguments
| Name | Description |
|---|---|
entityType - CertificateEntityType
|
The type of entity that the Certificate object pertains to. |
entityUuid - [UUID]
|
The list of System or Component UUIDs to filter the Certificates by. |
issuerUuid - [UUID]
|
The list of Issuer UUIDs to filter the Certificates by. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [CertificateOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - CertificateQuery
|
Complex filtering over Certificates. |
Example
Query
query certificates(
$entityType: CertificateEntityType,
$entityUuid: [UUID],
$issuerUuid: [UUID],
$limit: Int,
$offset: Int,
$orderBy: [CertificateOrderByQuery],
$uuid: [UUID],
$where: CertificateQuery
) {
certificates(
entityType: $entityType,
entityUuid: $entityUuid,
issuerUuid: $issuerUuid,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
cursor
items {
...CertificateFragment
}
limit
}
}
Variables
{
"entityType": "COMPONENT",
"entityUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"issuerUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"limit": 123,
"offset": 987,
"orderBy": [CertificateOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": CertificateQuery
}
Response
{
"data": {
"certificates": {
"cursor": "abc123",
"items": [Certificate],
"limit": 987
}
}
}
characteristic
Description
Returns the details of the Characteristic with the provided uuid.
Response
Returns a Characteristic!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The uuid of the Characteristic to be returned. |
Example
Query
query characteristic($uuid: UUID!) {
characteristic(uuid: $uuid) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"characteristic": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
characteristicValidValue
Description
Retrieves the information about a CharacteristicValidValue entity with a specific UUID.
Response
Returns a CharacteristicValidValue!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the CharacteristicValidValue entity to retrieve. |
Example
Query
query characteristicValidValue($uuid: UUID!) {
characteristicValidValue(uuid: $uuid) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"characteristicValidValue": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
characteristicValidValues
Description
Retrieves information for multiple CharacteristicValidValue entities.
Response
Returns a PagedCharacteristicValidValues!
Arguments
| Name | Description |
|---|---|
characteristicUuid - [UUID]
|
The UUID of the Characteristic entity to filter by. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [CharacteristicValidValueOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
Example
Query
query characteristicValidValues(
$characteristicUuid: [UUID],
$limit: Int,
$offset: Int,
$orderBy: [CharacteristicValidValueOrderByQuery],
$uuid: [UUID]
) {
characteristicValidValues(
characteristicUuid: $characteristicUuid,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid
) {
items {
...CharacteristicValidValueFragment
}
limit
offset
totalItems
}
}
Variables
{
"characteristicUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"limit": 987,
"offset": 123,
"orderBy": [CharacteristicValidValueOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
]
}
Response
{
"data": {
"characteristicValidValues": {
"items": [CharacteristicValidValue],
"limit": 987,
"offset": 123,
"totalItems": 987
}
}
}
characteristics
Description
Returns a list of paged Characteristic's matching a given set of filters and ordering.
Response
Returns a PagedCharacteristics!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [CharacteristicOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [Status]
|
The status by which to filter entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - CharacteristicQuery
|
Complex filtering over Characteristics. |
Example
Query
query characteristics(
$limit: Int,
$offset: Int,
$orderBy: [CharacteristicOrderByQuery],
$status: [Status],
$uuid: [UUID],
$where: CharacteristicQuery
) {
characteristics(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
status: $status,
uuid: $uuid,
where: $where
) {
items {
...CharacteristicFragment
}
limit
offset
totalItems
}
}
Variables
{
"limit": 123,
"offset": 123,
"orderBy": [CharacteristicOrderByQuery],
"status": ["ACTIVATED"],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": CharacteristicQuery
}
Response
{
"data": {
"characteristics": {
"items": [Characteristic],
"limit": 987,
"offset": 123,
"totalItems": 123
}
}
}
component
Description
Get a specific Component by UUID.
Response
Returns a Component!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Component to be retrieved. |
Example
Query
query component($uuid: UUID!) {
component(uuid: $uuid) {
certificate {
...CertificateFragment
}
characteristics {
...PagedCharacteristicsFragment
}
code
componentModel {
...ComponentModelFragment
}
componentModelUuid
connectionState
connectionStateUpdatedAt
createdAt
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesOnComponentFragment
}
status
system {
...SystemFragment
}
systemUuid
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"component": {
"certificate": Certificate,
"characteristics": PagedCharacteristics,
"code": "xyz789",
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServicesOnComponent,
"status": "ACTIVATED",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
componentModel
Description
Retrieve a specific ComponentModel by its UUID
Response
Returns a ComponentModel!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
UUID of the ComponentModel to be retrieved. |
Example
Query
query componentModel($uuid: UUID!) {
componentModel(uuid: $uuid) {
code
componentType
components {
...PagedComponentsFragment
}
createdAt
description
domain {
...DomainFragment
}
domainUuid
isConnective
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesOnComponentModelFragment
}
status
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"componentModel": {
"code": "xyz789",
"componentType": "DEVICE",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"isConnective": false,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServicesOnComponentModel,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
componentModels
Description
This endpoint retrieves multiple ComponentModel objects by filtering and/or pagination.
Response
Returns a PagedComponentModels!
Arguments
| Name | Description |
|---|---|
code - String
|
Filter component models by their code. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [ComponentModelOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [Status]
|
The status by which to filter entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - ComponentModelQuery
|
Complex filtering over ComponentModels. |
Example
Query
query componentModels(
$code: String,
$limit: Int,
$offset: Int,
$orderBy: [ComponentModelOrderByQuery],
$status: [Status],
$uuid: [UUID],
$where: ComponentModelQuery
) {
componentModels(
code: $code,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
status: $status,
uuid: $uuid,
where: $where
) {
items {
...ComponentModelFragment
}
limit
offset
totalItems
}
}
Variables
{
"code": "xyz789",
"limit": 123,
"offset": 123,
"orderBy": [ComponentModelOrderByQuery],
"status": ["ACTIVATED"],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": ComponentModelQuery
}
Response
{
"data": {
"componentModels": {
"items": [ComponentModel],
"limit": 123,
"offset": 123,
"totalItems": 987
}
}
}
components
Description
Retrieve multiple Components.
Response
Returns a PagedComponents!
Arguments
| Name | Description |
|---|---|
componentModelUuid - [UUID]
|
The list of component model UUIDs to filter the components by. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [ComponentOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [Status]
|
The status by which to filter entities. |
systemUuid - [UUID]
|
The list of system UUIDs to filter the components by. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - ComponentQuery
|
Complex filtering over components. |
Example
Query
query components(
$componentModelUuid: [UUID],
$limit: Int,
$offset: Int,
$orderBy: [ComponentOrderByQuery],
$status: [Status],
$systemUuid: [UUID],
$uuid: [UUID],
$where: ComponentQuery
) {
components(
componentModelUuid: $componentModelUuid,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
status: $status,
systemUuid: $systemUuid,
uuid: $uuid,
where: $where
) {
items {
...ComponentFragment
}
limit
offset
totalItems
}
}
Variables
{
"componentModelUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"limit": 987,
"offset": 987,
"orderBy": [ComponentOrderByQuery],
"status": ["ACTIVATED"],
"systemUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": ComponentQuery
}
Response
{
"data": {
"components": {
"items": [Component],
"limit": 987,
"offset": 123,
"totalItems": 987
}
}
}
currentDatapoints
Description
Get the latest Datapoints with various filters.
Response
Returns a PagedDatapoints!
Arguments
| Name | Description |
|---|---|
after - String
|
The cursor after which items should be returned. |
characteristicCode - [String]
|
The list of Characteristic codes by which to filter fetched items. |
characteristicUuid - [UUID]
|
The list of Characteristic UUIDs by which to filter fetched items. |
componentCode - [String]
|
The list of Component codes by which to filter fetched items. |
componentModelCode - [String]
|
The list of Component Model codes by which to filter fetched items. |
componentModelUuid - [UUID]
|
The list of Component Model UUIDs by which to filter fetched items. |
componentUuid - [UUID]
|
The list of Component UUIDs by which to filter fetched items. |
from - DateTime
|
The inclusive start of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the previous possible time. A grid of 1h will snap to the previous full hour A grid of 1d snaps to the previous midnight in the UTC time zone A grid of 1w snaps to the previous midnight on Monday in the UTC time zone All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with a time of 12:12:00 matches to 12:00:00 and returns all elements from 12:00:00 to 12:15:00 in this grid. |
limit - Int
|
The maximum number of items which should be returned. |
orderBy - [DatapointOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
round - Int
|
Optional Integer. Configures the rounding of raw values before being counted. round specifies the number decimals to use when rounding the number. 0 rounds to the nearest integer. Optional, defaults to no rounding applied. |
serviceCode - [String]
|
The list of Service codes by which to filter fetched items. |
serviceIndex - [Int]
|
A list of Service & ComponentModel relationship indices to filter retrieved items. |
serviceUuid - [UUID]
|
A list of Service UUIDs by which to filter retrieved items. |
systemCode - [String]
|
The list of System codes by which to filter fetched items. |
systemUuid - [UUID]
|
The list of System UUIDs by which to filter fetched items. |
timeStreamUuid - [UUID]
|
The list of TimeStream UUIDs by which to filter fetched items. |
to - DateTime
|
The exclusive end of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the next possible time. A grid of 1h will snap to the next full hour A grid of 1d snaps to next midnight in the UTC time zone A grid of 1w snaps to the next midnight on Monday in the UTC time zone. All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with an to time of 12:12:00 matches to 12:15:00 and returns all elements from 12:00:00 to 12:15:00 in the last grid. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - DatapointsWhereQuery
|
Complex filtering over Datapoints |
Example
Query
query currentDatapoints(
$after: String,
$characteristicCode: [String],
$characteristicUuid: [UUID],
$componentCode: [String],
$componentModelCode: [String],
$componentModelUuid: [UUID],
$componentUuid: [UUID],
$from: DateTime,
$limit: Int,
$orderBy: [DatapointOrderByQuery],
$round: Int,
$serviceCode: [String],
$serviceIndex: [Int],
$serviceUuid: [UUID],
$systemCode: [String],
$systemUuid: [UUID],
$timeStreamUuid: [UUID],
$to: DateTime,
$uuid: [UUID],
$where: DatapointsWhereQuery
) {
currentDatapoints(
after: $after,
characteristicCode: $characteristicCode,
characteristicUuid: $characteristicUuid,
componentCode: $componentCode,
componentModelCode: $componentModelCode,
componentModelUuid: $componentModelUuid,
componentUuid: $componentUuid,
from: $from,
limit: $limit,
orderBy: $orderBy,
round: $round,
serviceCode: $serviceCode,
serviceIndex: $serviceIndex,
serviceUuid: $serviceUuid,
systemCode: $systemCode,
systemUuid: $systemUuid,
timeStreamUuid: $timeStreamUuid,
to: $to,
uuid: $uuid,
where: $where
) {
cursor
items {
...DatapointFragment
}
limit
}
}
Variables
{
"after": "abc123",
"characteristicCode": ["xyz789"],
"characteristicUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentCode": ["xyz789"],
"componentModelCode": ["abc123"],
"componentModelUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"from": "2007-12-03T10:15:30Z",
"limit": 987,
"orderBy": [DatapointOrderByQuery],
"round": 987,
"serviceCode": ["abc123"],
"serviceIndex": [987],
"serviceUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"systemCode": ["xyz789"],
"systemUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"timeStreamUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"to": "2007-12-03T10:15:30Z",
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": DatapointsWhereQuery
}
Response
{
"data": {
"currentDatapoints": {
"cursor": "xyz789",
"items": [Datapoint],
"limit": 123
}
}
}
currentDomain
Description
Retrieve information about the Domain associated with the current User's tenant. A Domain is an isolated environment for an individual tenant, normally a company or a team. This endpoint can be used to obtain information about the current tenant's Domain within DRIVR.
Response
Returns a Domain!
Example
Query
query currentDomain {
currentDomain {
authenticationMethods {
...PagedAuthenticationMethodsFragment
}
componentModels {
...PagedComponentModelsFragment
}
createdAt
domainFeatures {
...PagedDomainFeaturesFragment
}
hostNames
name
organizations {
...PagedOrganizationsFragment
}
owner {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
ownerUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
slug
status
systems {
...PagedSystemsFragment
}
updatedAt
users {
...PagedUsersFragment
}
uuid
}
}
Response
{
"data": {
"currentDomain": {
"authenticationMethods": PagedAuthenticationMethods,
"componentModels": PagedComponentModels,
"createdAt": "2007-12-03T10:15:30Z",
"domainFeatures": PagedDomainFeatures,
"hostNames": ["xyz789"],
"name": "abc123",
"organizations": PagedOrganizations,
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"slug": "xyz789",
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"users": PagedUsers,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
dataSource
Description
Retrieve a specific DataSource entity by its UUID.
Response
Returns a DataSource!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the DataSource entity. |
Example
Query
query dataSource($uuid: UUID!) {
dataSource(uuid: $uuid) {
code
createdAt
description
domain {
...DomainFragment
}
domainUuid
name
reference
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"dataSource": {
"code": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "abc123",
"reference": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
dataSources
Description
Retrieve multiple DataSources by specifying one or more codes to filter by.
Response
Returns a PagedDataSources!
Arguments
| Name | Description |
|---|---|
code - [String]
|
The codes used to filter the DataSource. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [DataSourceOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - DataSourceQuery
|
Complex filtering over data sources. |
Example
Query
query dataSources(
$code: [String],
$limit: Int,
$offset: Int,
$orderBy: [DataSourceOrderByQuery],
$uuid: [UUID],
$where: DataSourceQuery
) {
dataSources(
code: $code,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
items {
...DataSourceFragment
}
limit
offset
totalItems
}
}
Variables
{
"code": ["xyz789"],
"limit": 987,
"offset": 123,
"orderBy": [DataSourceOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": DataSourceQuery
}
Response
{
"data": {
"dataSources": {
"items": [DataSource],
"limit": 123,
"offset": 123,
"totalItems": 987
}
}
}
datapoints
Description
Get all Datapoints with various filters.
Response
Returns a PagedDatapoints!
Arguments
| Name | Description |
|---|---|
after - String
|
The cursor after which items should be returned. |
characteristicCode - [String]
|
The list of Characteristic codes by which to filter fetched items. |
characteristicUuid - [UUID]
|
The list of Characteristic UUIDs by which to filter fetched items. |
componentCode - [String]
|
The list of Component codes by which to filter fetched items. |
componentModelCode - [String]
|
The list of Component Model codes by which to filter fetched items. |
componentModelUuid - [UUID]
|
The list of Component Model UUIDs by which to filter fetched items. |
componentUuid - [UUID]
|
The list of Component UUIDs by which to filter fetched items. |
from - DateTime
|
The inclusive start of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the previous possible time. A grid of 1h will snap to the previous full hour A grid of 1d snaps to the previous midnight in the UTC time zone A grid of 1w snaps to the previous midnight on Monday in the UTC time zone All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with a time of 12:12:00 matches to 12:00:00 and returns all elements from 12:00:00 to 12:15:00 in this grid. |
limit - Int
|
The maximum number of items which should be returned. |
orderBy - [DatapointOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
round - Int
|
Optional Integer. Configures the rounding of raw values before being counted. round specifies the number decimals to use when rounding the number. 0 rounds to the nearest integer. Optional, defaults to no rounding applied. |
serviceCode - [String]
|
The list of Service codes by which to filter fetched items. |
serviceIndex - [Int]
|
A list of Service & ComponentModel relationship indices to filter retrieved items. |
serviceUuid - [UUID]
|
A list of Service UUIDs by which to filter retrieved items. |
systemCode - [String]
|
The list of System codes by which to filter fetched items. |
systemUuid - [UUID]
|
The list of System UUIDs by which to filter fetched items. |
timeStreamUuid - [UUID]
|
The list of TimeStream UUIDs by which to filter fetched items. |
to - DateTime
|
The exclusive end of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the next possible time. A grid of 1h will snap to the next full hour A grid of 1d snaps to next midnight in the UTC time zone A grid of 1w snaps to the next midnight on Monday in the UTC time zone. All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with an to time of 12:12:00 matches to 12:15:00 and returns all elements from 12:00:00 to 12:15:00 in the last grid. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - DatapointsWhereQuery
|
Complex filtering over Datapoints |
Example
Query
query datapoints(
$after: String,
$characteristicCode: [String],
$characteristicUuid: [UUID],
$componentCode: [String],
$componentModelCode: [String],
$componentModelUuid: [UUID],
$componentUuid: [UUID],
$from: DateTime,
$limit: Int,
$orderBy: [DatapointOrderByQuery],
$round: Int,
$serviceCode: [String],
$serviceIndex: [Int],
$serviceUuid: [UUID],
$systemCode: [String],
$systemUuid: [UUID],
$timeStreamUuid: [UUID],
$to: DateTime,
$uuid: [UUID],
$where: DatapointsWhereQuery
) {
datapoints(
after: $after,
characteristicCode: $characteristicCode,
characteristicUuid: $characteristicUuid,
componentCode: $componentCode,
componentModelCode: $componentModelCode,
componentModelUuid: $componentModelUuid,
componentUuid: $componentUuid,
from: $from,
limit: $limit,
orderBy: $orderBy,
round: $round,
serviceCode: $serviceCode,
serviceIndex: $serviceIndex,
serviceUuid: $serviceUuid,
systemCode: $systemCode,
systemUuid: $systemUuid,
timeStreamUuid: $timeStreamUuid,
to: $to,
uuid: $uuid,
where: $where
) {
cursor
items {
...DatapointFragment
}
limit
}
}
Variables
{
"after": "abc123",
"characteristicCode": ["xyz789"],
"characteristicUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentCode": ["abc123"],
"componentModelCode": ["xyz789"],
"componentModelUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"from": "2007-12-03T10:15:30Z",
"limit": 987,
"orderBy": [DatapointOrderByQuery],
"round": 987,
"serviceCode": ["abc123"],
"serviceIndex": [123],
"serviceUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"systemCode": ["abc123"],
"systemUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"timeStreamUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"to": "2007-12-03T10:15:30Z",
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": DatapointsWhereQuery
}
Response
{
"data": {
"datapoints": {
"cursor": "abc123",
"items": [Datapoint],
"limit": 987
}
}
}
distinctAggregatedDatapoints
Description
Returns all distinct values for a set of aggregated datapoints.
Response
Returns a PagedDistinctAggregatedDatapoints!
Arguments
| Name | Description |
|---|---|
after - String
|
The cursor after which items should be returned. |
aggregate - ValueAggregate!
|
Specify aggregate function to apply for each grid portion. One of avg, count, sum, min, max, first, last. Only one aggregation is supported per call. Always required. |
carryForward - Boolean
|
Add an aggregate datapoint to each grid interval even if no explicit datapoint was published during that interval. In the case of missing datapoints, the last value recorded is carried forward into empty time intervals. |
characteristicCode - [String]
|
The list of Characteristic codes by which to filter fetched items. |
characteristicUuid - [UUID]
|
The list of Characteristic UUIDs by which to filter fetched items. |
componentCode - [String]
|
The list of Component codes by which to filter fetched items. |
componentModelCode - [String]
|
The list of Component Model codes by which to filter fetched items. |
componentModelUuid - [UUID]
|
The list of Component Model UUIDs by which to filter fetched items. |
componentUuid - [UUID]
|
The list of Component UUIDs by which to filter fetched items. |
from - DateTime
|
The inclusive start of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the previous possible time. A grid of 1h will snap to the previous full hour A grid of 1d snaps to the previous midnight in the UTC time zone A grid of 1w snaps to the previous midnight on Monday in the UTC time zone All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with a time of 12:12:00 matches to 12:00:00 and returns all elements from 12:00:00 to 12:15:00 in this grid. |
grid - Timespan
|
Given a start and end time, a grid is the size of the partitions by which this time period should be divided. It is specified by a timespan in ISO 8601 duration format. If the grid is set, start and end are required. The smallest time unit supported for the grid is second. The largest time unit supported for the grid is week. All grid values must be evenly divisible into the next largest available time unit (minutes, hours, days or weeks). For example, 20s is valid because it can evenly divide into 60 seconds (20 · 3 = 60 seconds = 1 minute). All grid values must be non-zero, non-negative integers. Grid values may be represented in smaller units as long as they evenly divide into the next largest unit. For example, 120s may be used instead of 2m because 120s / 60s = 2m. Grids which are in hours can only be full hours (1-23) (e.g. 1 hour 30 minutes is invalid). Grids which are in days must be full days (1-6) (e.g. 1 day and 3 hours is invalid) Grids which are in weeks cannot have smaller units (days or hours) attached (e.g. 1 week and 1 day is invalid) |
group - DistinctDatapointGroup
|
Group results by object. One of CHARACTERISTIC or TIME_STREAM. Defaults to CHARACTERISTIC if not provided. |
limit - Int
|
The maximum number of items which should be returned. |
listZeroCounts - Boolean
|
Optional Boolean. If set to true, all observed values of the returned page will be listed per grouping/time step. Hence, the resulting distinct value list all observed values with a possible count of 0. Default is False, which omits all distinct values with a count of 0. |
orderBy - [DatapointOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
round - Int
|
Optional Integer. Configures the rounding of aggregate values before being counted. round specifies the number decimals to use when rounding the number. 0 rounds to the nearest integer. Optional, defaults to no rounding applied. |
serviceCode - [String]
|
The list of Service codes by which to filter fetched items. |
serviceIndex - [Int]
|
A list of Service & ComponentModel relationship indices to filter retrieved items. |
serviceUuid - [UUID]
|
A list of Service UUIDs by which to filter retrieved items. |
systemCode - [String]
|
The list of System codes by which to filter fetched items. |
systemUuid - [UUID]
|
The list of System UUIDs by which to filter fetched items. |
timeStreamUuid - [UUID]
|
The list of TimeStream UUIDs by which to filter fetched items. |
to - DateTime
|
The exclusive end of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the next possible time. A grid of 1h will snap to the next full hour A grid of 1d snaps to next midnight in the UTC time zone A grid of 1w snaps to the next midnight on Monday in the UTC time zone. All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with an to time of 12:12:00 matches to 12:15:00 and returns all elements from 12:00:00 to 12:15:00 in the last grid. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - DistinctAggregatedDatapointsWhereQuery
|
Complex nested filters on aggregated distinct datapoints allowing to query by attached entities. |
Example
Query
query distinctAggregatedDatapoints(
$after: String,
$aggregate: ValueAggregate!,
$carryForward: Boolean,
$characteristicCode: [String],
$characteristicUuid: [UUID],
$componentCode: [String],
$componentModelCode: [String],
$componentModelUuid: [UUID],
$componentUuid: [UUID],
$from: DateTime,
$grid: Timespan,
$group: DistinctDatapointGroup,
$limit: Int,
$listZeroCounts: Boolean,
$orderBy: [DatapointOrderByQuery],
$round: Int,
$serviceCode: [String],
$serviceIndex: [Int],
$serviceUuid: [UUID],
$systemCode: [String],
$systemUuid: [UUID],
$timeStreamUuid: [UUID],
$to: DateTime,
$uuid: [UUID],
$where: DistinctAggregatedDatapointsWhereQuery
) {
distinctAggregatedDatapoints(
after: $after,
aggregate: $aggregate,
carryForward: $carryForward,
characteristicCode: $characteristicCode,
characteristicUuid: $characteristicUuid,
componentCode: $componentCode,
componentModelCode: $componentModelCode,
componentModelUuid: $componentModelUuid,
componentUuid: $componentUuid,
from: $from,
grid: $grid,
group: $group,
limit: $limit,
listZeroCounts: $listZeroCounts,
orderBy: $orderBy,
round: $round,
serviceCode: $serviceCode,
serviceIndex: $serviceIndex,
serviceUuid: $serviceUuid,
systemCode: $systemCode,
systemUuid: $systemUuid,
timeStreamUuid: $timeStreamUuid,
to: $to,
uuid: $uuid,
where: $where
) {
cursor
items {
...DistinctAggregatedDatapointsFragment
}
limit
}
}
Variables
{
"after": "abc123",
"aggregate": "AVG",
"carryForward": false,
"characteristicCode": ["abc123"],
"characteristicUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentCode": ["abc123"],
"componentModelCode": ["xyz789"],
"componentModelUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"from": "2007-12-03T10:15:30Z",
"grid": Timespan,
"group": "CHARACTERISTIC",
"limit": 987,
"listZeroCounts": true,
"orderBy": [DatapointOrderByQuery],
"round": 987,
"serviceCode": ["abc123"],
"serviceIndex": [123],
"serviceUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"systemCode": ["xyz789"],
"systemUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"timeStreamUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"to": "2007-12-03T10:15:30Z",
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": DistinctAggregatedDatapointsWhereQuery
}
Response
{
"data": {
"distinctAggregatedDatapoints": {
"cursor": "abc123",
"items": [DistinctAggregatedDatapoints],
"limit": 987
}
}
}
distinctDatapoints
Description
Returns a count for distinct Datapoints. It allows for filtering and sorting of data points by various parameters.
Response
Returns a PagedDistinctDatapoints!
Arguments
| Name | Description |
|---|---|
after - String
|
The cursor after which items should be returned. |
carryForward - Boolean
|
Specifies whether to include a Datapoint for each grid interval in the response even if no actual Datapoints fall into the interval. In this case, the last value seen is carried forward. A from, to, and grid parameter must be set if carry_forward is set to true. The default value is false. |
characteristicCode - [String]
|
The list of Characteristic codes by which to filter fetched items. |
characteristicUuid - [UUID]
|
The list of Characteristic UUIDs by which to filter fetched items. |
componentCode - [String]
|
The list of Component codes by which to filter fetched items. |
componentModelCode - [String]
|
The list of Component Model codes by which to filter fetched items. |
componentModelUuid - [UUID]
|
The list of Component Model UUIDs by which to filter fetched items. |
componentUuid - [UUID]
|
The list of Component UUIDs by which to filter fetched items. |
from - DateTime
|
The inclusive start of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the previous possible time. A grid of 1h will snap to the previous full hour A grid of 1d snaps to the previous midnight in the UTC time zone A grid of 1w snaps to the previous midnight on Monday in the UTC time zone All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with a time of 12:12:00 matches to 12:00:00 and returns all elements from 12:00:00 to 12:15:00 in this grid. |
grid - Timespan
|
Given a start and end time, a grid is the size of the partitions by which this time period should be divided. It is specified by a timespan in ISO 8601 duration format. If the grid is set, start and end are required. The smallest time unit supported for the grid is second. The largest time unit supported for the grid is week. All grid values must be evenly divisible into the next largest available time unit (minutes, hours, days or weeks). For example, 20s is valid because it can evenly divide into 60 seconds (20 · 3 = 60 seconds = 1 minute). All grid values must be non-zero, non-negative integers. Grid values may be represented in smaller units as long as they evenly divide into the next largest unit. For example, 120s may be used instead of 2m because 120s / 60s = 2m. Grids which are in hours can only be full hours (1-23) (e.g. 1 hour 30 minutes is invalid). Grids which are in days must be full days (1-6) (e.g. 1 day and 3 hours is invalid) Grids which are in weeks cannot have smaller units (days or hours) attached (e.g. 1 week and 1 day is invalid) |
group - DistinctDatapointGroup
|
Specifies the type of object to group the results by. Accepted values are CHARACTERISTIC or TIME_STREAM. The default value is CHARACTERISTIC if this parameter is not provided. |
limit - Int
|
The maximum number of items which should be returned. |
listZeroCounts - Boolean
|
Optional Boolean. If set to true, all observed values of the returned page will be listed per grouping/time step. Hence, the resulting distinct value list all observed values with a possible count of 0. Default is False, which omits all distinct values with a count of 0. |
orderBy - [DatapointOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
round - Int
|
Optional Integer. Configures the rounding of raw values before being counted. round specifies the number decimals to use when rounding the number. 0 rounds to the nearest integer. Optional, defaults to no rounding applied. |
serviceCode - [String]
|
The list of Service codes by which to filter fetched items. |
serviceIndex - [Int]
|
A list of Service & ComponentModel relationship indices to filter retrieved items. |
serviceUuid - [UUID]
|
A list of Service UUIDs by which to filter retrieved items. |
systemCode - [String]
|
The list of System codes by which to filter fetched items. |
systemUuid - [UUID]
|
The list of System UUIDs by which to filter fetched items. |
timeStreamUuid - [UUID]
|
The list of TimeStream UUIDs by which to filter fetched items. |
to - DateTime
|
The exclusive end of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the next possible time. A grid of 1h will snap to the next full hour A grid of 1d snaps to next midnight in the UTC time zone A grid of 1w snaps to the next midnight on Monday in the UTC time zone. All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with an to time of 12:12:00 matches to 12:15:00 and returns all elements from 12:00:00 to 12:15:00 in the last grid. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - DistinctDatapointsWhereQuery
|
Specifies complex nested filters on distinct datapoints allowing to query by attached entities. |
Example
Query
query distinctDatapoints(
$after: String,
$carryForward: Boolean,
$characteristicCode: [String],
$characteristicUuid: [UUID],
$componentCode: [String],
$componentModelCode: [String],
$componentModelUuid: [UUID],
$componentUuid: [UUID],
$from: DateTime,
$grid: Timespan,
$group: DistinctDatapointGroup,
$limit: Int,
$listZeroCounts: Boolean,
$orderBy: [DatapointOrderByQuery],
$round: Int,
$serviceCode: [String],
$serviceIndex: [Int],
$serviceUuid: [UUID],
$systemCode: [String],
$systemUuid: [UUID],
$timeStreamUuid: [UUID],
$to: DateTime,
$uuid: [UUID],
$where: DistinctDatapointsWhereQuery
) {
distinctDatapoints(
after: $after,
carryForward: $carryForward,
characteristicCode: $characteristicCode,
characteristicUuid: $characteristicUuid,
componentCode: $componentCode,
componentModelCode: $componentModelCode,
componentModelUuid: $componentModelUuid,
componentUuid: $componentUuid,
from: $from,
grid: $grid,
group: $group,
limit: $limit,
listZeroCounts: $listZeroCounts,
orderBy: $orderBy,
round: $round,
serviceCode: $serviceCode,
serviceIndex: $serviceIndex,
serviceUuid: $serviceUuid,
systemCode: $systemCode,
systemUuid: $systemUuid,
timeStreamUuid: $timeStreamUuid,
to: $to,
uuid: $uuid,
where: $where
) {
cursor
items {
...DistinctDatapointsFragment
}
limit
}
}
Variables
{
"after": "abc123",
"carryForward": true,
"characteristicCode": ["xyz789"],
"characteristicUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentCode": ["abc123"],
"componentModelCode": ["abc123"],
"componentModelUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"from": "2007-12-03T10:15:30Z",
"grid": Timespan,
"group": "CHARACTERISTIC",
"limit": 123,
"listZeroCounts": true,
"orderBy": [DatapointOrderByQuery],
"round": 123,
"serviceCode": ["xyz789"],
"serviceIndex": [987],
"serviceUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"systemCode": ["abc123"],
"systemUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"timeStreamUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"to": "2007-12-03T10:15:30Z",
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": DistinctDatapointsWhereQuery
}
Response
{
"data": {
"distinctDatapoints": {
"cursor": "xyz789",
"items": [DistinctDatapoints],
"limit": 987
}
}
}
distinctMetadataValues
Description
Retrieve all distinct metadata values for the given metadata types.
Response
Returns a PagedDistinctMetadataValues!
Arguments
| Name | Description |
|---|---|
after - String
|
The cursor after which items should be returned. |
entityType - MetadataTypeEntityTypes
|
The entity type for which the distinct metadata values should be calculated. |
entityUuid - [UUID]
|
The list of entity UUIDs for which the distinct metadata values should be returned. |
limit - Int
|
The maximum number of items which should be returned. |
metadataTypeUuid - [UUID]
|
The list of MetadataType UUIDs for which the distinct metadata values should be calculated. |
orderBy - [DistinctMetadataOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
where - DistinctMetadataValueQuery
|
Complex filtering over distinct metadata values. |
Example
Query
query distinctMetadataValues(
$after: String,
$entityType: MetadataTypeEntityTypes,
$entityUuid: [UUID],
$limit: Int,
$metadataTypeUuid: [UUID],
$orderBy: [DistinctMetadataOrderByQuery],
$where: DistinctMetadataValueQuery
) {
distinctMetadataValues(
after: $after,
entityType: $entityType,
entityUuid: $entityUuid,
limit: $limit,
metadataTypeUuid: $metadataTypeUuid,
orderBy: $orderBy,
where: $where
) {
cursor
items {
...DistinctMetadataValueFragment
}
limit
}
}
Variables
{
"after": "abc123",
"entityType": "CHARACTERISTIC",
"entityUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"limit": 123,
"metadataTypeUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"orderBy": [DistinctMetadataOrderByQuery],
"where": DistinctMetadataValueQuery
}
Response
{
"data": {
"distinctMetadataValues": {
"cursor": "xyz789",
"items": [DistinctMetadataValue],
"limit": 987
}
}
}
domainFeature
Description
The DomainFeature query retrieves a specific DomainFeature by its slug. DomainFeatures are associated with a Domain and represent a global setting within DRIVR which can be enabled or disabled.
Response
Returns a DomainFeature!
Arguments
| Name | Description |
|---|---|
slug - DomainFeatureSlug!
|
A slug is a unique identifier assigned to a specific DomainFeature. |
Example
Query
query domainFeature($slug: DomainFeatureSlug!) {
domainFeature(slug: $slug) {
domain {
...DomainFragment
}
domainUuid
enabled
slug
}
}
Variables
{"slug": "DELETE_ARCHIVE_ORGANIZATION_USERS"}
Response
{
"data": {
"domainFeature": {
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"enabled": true,
"slug": "DELETE_ARCHIVE_ORGANIZATION_USERS"
}
}
}
domainFeatures
Description
This endpoint returns multiple DomainFeatures for the current Domain based on filter criteria specified as arguments. Each DomainFeature represents a global setting which can be enabled or disabled. For example, a DomainFeature can represent a requirement for users to have an email.
Response
Returns a PagedDomainFeatures!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [DomainFeatureOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
slug - DomainFeatureSlug
|
The unique identifier by which to filter DomainFeatures. If specified, only DomainFeatures with the given slug will be returned. |
where - DomainFeatureQuery
|
A complex filter allowing for more granular filtering over DomainFeatures. Use this filter to build more complex queries for retrieving DomainFeatures. |
Example
Query
query domainFeatures(
$limit: Int,
$offset: Int,
$orderBy: [DomainFeatureOrderByQuery],
$slug: DomainFeatureSlug,
$where: DomainFeatureQuery
) {
domainFeatures(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
slug: $slug,
where: $where
) {
items {
...DomainFeatureFragment
}
limit
offset
totalItems
}
}
Variables
{
"limit": 987,
"offset": 123,
"orderBy": [DomainFeatureOrderByQuery],
"slug": "DELETE_ARCHIVE_ORGANIZATION_USERS",
"where": DomainFeatureQuery
}
Response
{
"data": {
"domainFeatures": {
"items": [DomainFeature],
"limit": 123,
"offset": 123,
"totalItems": 987
}
}
}
event
Description
Get a specific Event by UUID.
Example
Query
query event($uuid: UUID!) {
event(uuid: $uuid) {
acknowledged
acks {
...PagedEventAcksFragment
}
createdAt
endTime
entity {
... on Component {
...ComponentFragment
}
... on System {
...SystemFragment
}
}
entityUuid
eventModel {
...EventModelFragment
}
eventModelUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
status
time
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"event": {
"acknowledged": true,
"acks": PagedEventAcks,
"createdAt": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"entity": Component,
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"eventModel": EventModel,
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"status": "ACTIVE",
"time": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
eventModel
Description
Get a single EventModel by its UUID. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities.
Response
Returns an EventModel!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the EventModel. |
Example
Query
query eventModel($uuid: UUID!) {
eventModel(uuid: $uuid) {
code
createdAt
domain {
...DomainFragment
}
domainUuid
entityType
eventLevel
eventModelLinks {
...PagedEventModelLinksFragment
}
eventType
limitToPrototypes
message
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
status
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"eventModel": {
"code": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "COMPONENT",
"eventLevel": "ERROR",
"eventModelLinks": PagedEventModelLinks,
"eventType": "RANGED",
"limitToPrototypes": false,
"message": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePair],
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
eventModelLink
Description
This endpoint gets a specific EventModelLink by UUID.
Response
Returns an EventModelLink!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the EventModelLink to retrieve. |
Example
Query
query eventModelLink($uuid: UUID!) {
eventModelLink(uuid: $uuid) {
createdAt
eventModel {
...EventModelFragment
}
eventModelUuid
prototype {
... on ComponentModel {
...ComponentModelFragment
}
}
prototypeUuid
status
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"eventModelLink": {
"createdAt": "2007-12-03T10:15:30Z",
"eventModel": EventModel,
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"prototype": ComponentModel,
"prototypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
eventModelLinks
Description
This endpoint retrieves multiple EventModelLink's filtered by various parameters.
Response
Returns a PagedEventModelLinks!
Arguments
| Name | Description |
|---|---|
eventModelCode - [String]
|
Filter by a list of codes, the EventModelLink's attached EventModel's are required to have. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [EventModelLinkOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
prototypeUuid - [UUID]
|
Filter by a list of prototype UUID's. Valid prototype types are ComponentModel, Service and Characteristic. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - EventModelLinkQuery
|
Complex filtering over EventModelLinks. |
Example
Query
query eventModelLinks(
$eventModelCode: [String],
$limit: Int,
$offset: Int,
$orderBy: [EventModelLinkOrderByQuery],
$prototypeUuid: [UUID],
$uuid: [UUID],
$where: EventModelLinkQuery
) {
eventModelLinks(
eventModelCode: $eventModelCode,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
prototypeUuid: $prototypeUuid,
uuid: $uuid,
where: $where
) {
items {
...EventModelLinkFragment
}
limit
offset
totalItems
}
}
Variables
{
"eventModelCode": ["abc123"],
"limit": 123,
"offset": 123,
"orderBy": [EventModelLinkOrderByQuery],
"prototypeUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": EventModelLinkQuery
}
Response
{
"data": {
"eventModelLinks": {
"items": [EventModelLink],
"limit": 987,
"offset": 123,
"totalItems": 987
}
}
}
eventModels
Description
Retrieve a list of EventModels that match the specified filters.
Response
Returns a PagedEventModels!
Arguments
| Name | Description |
|---|---|
code - [String]
|
Filter the EventModels by code. Can be provided as a single string, or a list of strings. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [EventModelOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - EventModelQuery
|
Filter the EventModels by complex condition. This can be one or multiple conditions, using field names as keys, and its specific conditions as the value of that key. |
Example
Query
query eventModels(
$code: [String],
$limit: Int,
$offset: Int,
$orderBy: [EventModelOrderByQuery],
$uuid: [UUID],
$where: EventModelQuery
) {
eventModels(
code: $code,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
items {
...EventModelFragment
}
limit
offset
totalItems
}
}
Variables
{
"code": ["xyz789"],
"limit": 987,
"offset": 123,
"orderBy": [EventModelOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": EventModelQuery
}
Response
{
"data": {
"eventModels": {
"items": [EventModel],
"limit": 987,
"offset": 987,
"totalItems": 123
}
}
}
events
Description
Get multiple Events.
Response
Returns a PagedEvents!
Arguments
| Name | Description |
|---|---|
after - String
|
The cursor after which items should be returned. |
entityUuid - UUID
|
The entity uuid by which to filter events. |
eventModelUuid - UUID
|
The event model uuid by which to filter events. |
from - DateTime
|
The inclusive from of the window which data should be requested. |
limit - Int
|
The maximum number of items which should be returned. |
orderBy - [EventOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [EventStatus]
|
The status by which to filter the Events. |
to - DateTime
|
The exclusive to of the window which data should be requested |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - EventQuery
|
Complex filtering over events |
Example
Query
query events(
$after: String,
$entityUuid: UUID,
$eventModelUuid: UUID,
$from: DateTime,
$limit: Int,
$orderBy: [EventOrderByQuery],
$status: [EventStatus],
$to: DateTime,
$uuid: [UUID],
$where: EventQuery
) {
events(
after: $after,
entityUuid: $entityUuid,
eventModelUuid: $eventModelUuid,
from: $from,
limit: $limit,
orderBy: $orderBy,
status: $status,
to: $to,
uuid: $uuid,
where: $where
) {
cursor
items {
...EventFragment
}
limit
}
}
Variables
{
"after": "xyz789",
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"from": "2007-12-03T10:15:30Z",
"limit": 987,
"orderBy": [EventOrderByQuery],
"status": ["ACTIVE"],
"to": "2007-12-03T10:15:30Z",
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": EventQuery
}
Response
{
"data": {
"events": {
"cursor": "abc123",
"items": [Event],
"limit": 987
}
}
}
integrations
Description
Retrieves a paged list of Integrations available in DRIVR.
Response
Returns a PagedIntegrations!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [IntegrationOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [Status]
|
The status by which to filter entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - IntegrationQuery
|
Complex filtering over integrations. |
Example
Query
query integrations(
$limit: Int,
$offset: Int,
$orderBy: [IntegrationOrderByQuery],
$status: [Status],
$uuid: [UUID],
$where: IntegrationQuery
) {
integrations(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
status: $status,
uuid: $uuid,
where: $where
) {
items {
...IntegrationFragment
}
limit
offset
totalItems
}
}
Variables
{
"limit": 123,
"offset": 987,
"orderBy": [IntegrationOrderByQuery],
"status": ["ACTIVATED"],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": IntegrationQuery
}
Response
{
"data": {
"integrations": {
"items": [Integration],
"limit": 987,
"offset": 123,
"totalItems": 123
}
}
}
issuer
Description
Returns the details of the Issuer with the provided uuid.
Response
Returns an Issuer!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The uuid of the Issuer to be returned. |
Example
Query
query issuer($uuid: UUID!) {
issuer(uuid: $uuid) {
ca
createdAt
domain {
...DomainFragment
}
domainUuid
name
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"issuer": {
"ca": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
issuers
Description
Retrieves a paged list of Issuers available in DRIVR.
Response
Returns a PagedIssuers!
Arguments
| Name | Description |
|---|---|
certificateUuid - UUID
|
The certificate UUID signed by the Issuer object to be retrieved. |
limit - Int
|
The maximum number of items which should be returned. |
name - String
|
The name of the Issuer object to be retrieved. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [IssuerOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - IssuerQuery
|
Complex filtering over Issuers. |
Example
Query
query issuers(
$certificateUuid: UUID,
$limit: Int,
$name: String,
$offset: Int,
$orderBy: [IssuerOrderByQuery],
$uuid: [UUID],
$where: IssuerQuery
) {
issuers(
certificateUuid: $certificateUuid,
limit: $limit,
name: $name,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
items {
...IssuerFragment
}
limit
offset
totalItems
}
}
Variables
{
"certificateUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"limit": 987,
"name": "abc123",
"offset": 123,
"orderBy": [IssuerOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": IssuerQuery
}
Response
{
"data": {
"issuers": {
"items": [Issuer],
"limit": 987,
"offset": 123,
"totalItems": 123
}
}
}
loginMethods
Description
Returns a list of paged LoginMethods matching a given set of filters and ordering.
Response
Returns a PagedLoginMethods!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [LoginMethodOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - LoginMethodQuery
|
The set of filters to apply for retrieving paged LoginMethods. |
Example
Query
query loginMethods(
$limit: Int,
$offset: Int,
$orderBy: [LoginMethodOrderByQuery],
$uuid: [UUID],
$where: LoginMethodQuery
) {
loginMethods(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
items {
...BaseLoginMethodFragment
}
limit
offset
totalItems
}
}
Variables
{
"limit": 987,
"offset": 123,
"orderBy": [LoginMethodOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": LoginMethodQuery
}
Response
{
"data": {
"loginMethods": {
"items": [BaseLoginMethod],
"limit": 123,
"offset": 987,
"totalItems": 123
}
}
}
machineUser
Description
Returns the details of the MachineUser with the provided uuid.
Response
Returns a MachineUser!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The uuid of the MachineUser to be returned. |
Example
Query
query machineUser($uuid: UUID!) {
machineUser(uuid: $uuid) {
createdAt
domain {
...DomainFragment
}
domainUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
status
updatedAt
username
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"machineUser": {
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"username": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
machineUsers
Description
Returns a list of paged MachineUsers matching a given set of filters and ordering.
Response
Returns a PagedMachineUsers!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [MachineUserOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - MachineUserQuery
|
The set of filters to apply for retrieving paged MachineUsers. |
Example
Query
query machineUsers(
$limit: Int,
$offset: Int,
$orderBy: [MachineUserOrderByQuery],
$uuid: [UUID],
$where: MachineUserQuery
) {
machineUsers(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
items {
...MachineUserFragment
}
limit
offset
totalItems
}
}
Variables
{
"limit": 987,
"offset": 987,
"orderBy": [MachineUserOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": MachineUserQuery
}
Response
{
"data": {
"machineUsers": {
"items": [MachineUser],
"limit": 987,
"offset": 987,
"totalItems": 987
}
}
}
metadataType
Description
Retrieve a single MetadataType by specifying its UUID.
Response
Returns a MetadataType!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the MetadataType to be retrieved. |
Example
Query
query metadataType($uuid: UUID!) {
metadataType(uuid: $uuid) {
createdAt
dataType
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"metadataType": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"description": "abc123",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
metadataTypes
Description
Retrieve a list of MetadataType entities and apply filters to narrow down the search results.
Response
Returns a PagedMetadataTypes!
Arguments
| Name | Description |
|---|---|
entityType - [MetadataTypeEntityTypes]
|
An array of entity types to filter metadata fields by. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [MetadataTypeOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - MetadataTypeQuery
|
Complex filtering of MetadataType entities. |
Example
Query
query metadataTypes(
$entityType: [MetadataTypeEntityTypes],
$limit: Int,
$offset: Int,
$orderBy: [MetadataTypeOrderByQuery],
$uuid: [UUID],
$where: MetadataTypeQuery
) {
metadataTypes(
entityType: $entityType,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
items {
...MetadataTypeFragment
}
limit
offset
totalItems
}
}
Variables
{
"entityType": ["CHARACTERISTIC"],
"limit": 987,
"offset": 123,
"orderBy": [MetadataTypeOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": MetadataTypeQuery
}
Response
{
"data": {
"metadataTypes": {
"items": [MetadataType],
"limit": 987,
"offset": 123,
"totalItems": 987
}
}
}
meteringRecords
Description
Retrieve multiple MeteringRecords.
Response
Returns a PagedMeteringRecords!
Arguments
| Name | Description |
|---|---|
entityType - [MeteringRecordEntityType]
|
An array of entity types to filter metering records by. |
entityUuid - UUID
|
The entity uuid by which to filter metering records. |
eventType - [MeteringRecordEventType]
|
An array of event types to filter metering records by. |
from - DateTime
|
The inclusive from of the window which data should be requested. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [MeteringRecordOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
resolution - MeteringRecordResolution!
|
The resolution of metering records to query. |
to - DateTime
|
The exclusive to of the window which data should be requested |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - MeteringRecordBaseQuery
|
Complex filtering over MeteringRecords. |
Example
Query
query meteringRecords(
$entityType: [MeteringRecordEntityType],
$entityUuid: UUID,
$eventType: [MeteringRecordEventType],
$from: DateTime,
$limit: Int,
$offset: Int,
$orderBy: [MeteringRecordOrderByQuery],
$resolution: MeteringRecordResolution!,
$to: DateTime,
$uuid: [UUID],
$where: MeteringRecordBaseQuery
) {
meteringRecords(
entityType: $entityType,
entityUuid: $entityUuid,
eventType: $eventType,
from: $from,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
resolution: $resolution,
to: $to,
uuid: $uuid,
where: $where
) {
items {
...MeteringRecordFragment
}
limit
offset
totalItems
}
}
Variables
{
"entityType": ["DOMAIN"],
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"eventType": ["DATAPOINT_CREATED"],
"from": "2007-12-03T10:15:30Z",
"limit": 123,
"offset": 987,
"orderBy": [MeteringRecordOrderByQuery],
"resolution": "DAILY",
"to": "2007-12-03T10:15:30Z",
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": MeteringRecordBaseQuery
}
Response
{
"data": {
"meteringRecords": {
"items": [MeteringRecord],
"limit": 123,
"offset": 123,
"totalItems": 123
}
}
}
organization
Description
This endpoint retrieves a single Organization by UUID.
Response
Returns an Organization!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Organization to retrieve. |
Example
Query
query organization($uuid: UUID!) {
organization(uuid: $uuid) {
alias
createdAt
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
owner {
...UserFragment
}
ownerUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
sources {
...PagedOrganizationSourcesFragment
}
status
systems {
...PagedSystemsFragment
}
updatedAt
users {
...PagedUsersFragment
}
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"organization": {
"alias": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"owner": User,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"sources": PagedOrganizationSources,
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"users": PagedUsers,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
organizationSources
Description
Find OrganizationSources by Organization UUIDs and/or DataSource UUIDs. An OrganizationSource is a link to an external system where the Organization was exported from, e.g. an Active Directory.
Response
Returns a PagedOrganizationSources!
Arguments
| Name | Description |
|---|---|
dataSourceUuid - [UUID]
|
The list of UUIDs of DataSources from which the OrganizationSources were exported. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [OrganizationSourceOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
organizationUuid - [UUID]
|
The list of UUIDs of the Organizations to which the fetched items belong to. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - OrganizationSourceQuery
|
Complex filtering over organization sources. |
Example
Query
query organizationSources(
$dataSourceUuid: [UUID],
$limit: Int,
$offset: Int,
$orderBy: [OrganizationSourceOrderByQuery],
$organizationUuid: [UUID],
$uuid: [UUID],
$where: OrganizationSourceQuery
) {
organizationSources(
dataSourceUuid: $dataSourceUuid,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
organizationUuid: $organizationUuid,
uuid: $uuid,
where: $where
) {
items {
...OrganizationSourceFragment
}
limit
offset
totalItems
}
}
Variables
{
"dataSourceUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"limit": 123,
"offset": 123,
"orderBy": [OrganizationSourceOrderByQuery],
"organizationUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": OrganizationSourceQuery
}
Response
{
"data": {
"organizationSources": {
"items": [OrganizationSource],
"limit": 123,
"offset": 123,
"totalItems": 987
}
}
}
organizations
Description
This endpoint returns multiple Organizations based on filter criteria specified as arguments.
Response
Returns a PagedOrganizations!
Arguments
| Name | Description |
|---|---|
alias - String
|
Filter Organizations by alias. |
limit - Int
|
The maximum number of items which should be returned. |
name - String
|
Filter Organizations by name. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [OrganizationOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [Status]
|
The status by which to filter entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - OrganizationQuery
|
Complex filtering over Organizations. |
Example
Query
query organizations(
$alias: String,
$limit: Int,
$name: String,
$offset: Int,
$orderBy: [OrganizationOrderByQuery],
$status: [Status],
$uuid: [UUID],
$where: OrganizationQuery
) {
organizations(
alias: $alias,
limit: $limit,
name: $name,
offset: $offset,
orderBy: $orderBy,
status: $status,
uuid: $uuid,
where: $where
) {
items {
...OrganizationFragment
}
limit
offset
totalItems
}
}
Variables
{
"alias": "abc123",
"limit": 987,
"name": "abc123",
"offset": 987,
"orderBy": [OrganizationOrderByQuery],
"status": ["ACTIVATED"],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": OrganizationQuery
}
Response
{
"data": {
"organizations": {
"items": [Organization],
"limit": 987,
"offset": 123,
"totalItems": 123
}
}
}
role
Description
Retrieve a specific Role by its UUID.
Response
Returns a Role!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Role to be retrieved. |
Example
Query
query role($uuid: UUID!) {
role(uuid: $uuid) {
createdAt
domainUuid
entityType
name
status
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"role": {
"createdAt": "2007-12-03T10:15:30Z",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "DOMAIN",
"name": "abc123",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
roleAssignment
Description
Returns the details of a single RoleAssignment specified by uuid.
Response
Returns a RoleAssignment!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The uuid of the RoleAssignment to retrieve details for. |
Example
Query
query roleAssignment($uuid: UUID!) {
roleAssignment(uuid: $uuid) {
assignee {
... on MachineUser {
...MachineUserFragment
}
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
assigneeUuid
createdAt
entity {
... on Domain {
...DomainFragment
}
... on System {
...SystemFragment
}
}
entityUuid
role {
...RoleFragment
}
roleUuid
sources {
...PagedRoleAssignmentSourcesFragment
}
status
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"roleAssignment": {
"assignee": MachineUser,
"assigneeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"entity": Domain,
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"role": Role,
"roleUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sources": PagedRoleAssignmentSources,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
roleAssignmentSources
Description
Retrieve a list of RoleAssignmentSource entities that match the specified filter criteria, along with contextual metadata.
Response
Returns a PagedRoleAssignmentSources!
Arguments
| Name | Description |
|---|---|
dataSourceUuid - [UUID]
|
A list of DataSource UUIDs used to filter the retrieved RoleAssignmentSource entities. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [RoleAssignmentSourceOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
roleAssignmentUuid - [UUID]
|
A list of RoleAssignment UUIDs used to filter the retrieved RoleAssignmentSource entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - RoleAssignmentSourceQuery
|
RoleAssignmentSourceQuery provides complex filter over RoleAssignmentSource's |
Example
Query
query roleAssignmentSources(
$dataSourceUuid: [UUID],
$limit: Int,
$offset: Int,
$orderBy: [RoleAssignmentSourceOrderByQuery],
$roleAssignmentUuid: [UUID],
$uuid: [UUID],
$where: RoleAssignmentSourceQuery
) {
roleAssignmentSources(
dataSourceUuid: $dataSourceUuid,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
roleAssignmentUuid: $roleAssignmentUuid,
uuid: $uuid,
where: $where
) {
items {
...RoleAssignmentSourceFragment
}
limit
offset
totalItems
}
}
Variables
{
"dataSourceUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"limit": 987,
"offset": 987,
"orderBy": [RoleAssignmentSourceOrderByQuery],
"roleAssignmentUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": RoleAssignmentSourceQuery
}
Response
{
"data": {
"roleAssignmentSources": {
"items": [RoleAssignmentSource],
"limit": 987,
"offset": 123,
"totalItems": 987
}
}
}
roleAssignments
Description
Retrieves a list of RoleAssignment's. Use query parameters to filter results or paginate through results.
Response
Returns a PagedRoleAssignments!
Arguments
| Name | Description |
|---|---|
assigneeUuid - [UUID]
|
The uuid of assignee (User, Organization_ or Identity) for which to retrieve RoleAssignment's. |
entityUuid - [UUID]
|
The uuid of entity (Domain or System) for which to retrieve RoleAssignment's. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [RoleAssignmentOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
roleUuid - [UUID]
|
The uuid of the Role for which to retrieve RoleAssignment's. |
status - [Status]
|
The status by which to filter entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - RoleAssignmentQuery
|
RoleAssignmentQuery provides complex filter over RoleAssignment's |
Example
Query
query roleAssignments(
$assigneeUuid: [UUID],
$entityUuid: [UUID],
$limit: Int,
$offset: Int,
$orderBy: [RoleAssignmentOrderByQuery],
$roleUuid: [UUID],
$status: [Status],
$uuid: [UUID],
$where: RoleAssignmentQuery
) {
roleAssignments(
assigneeUuid: $assigneeUuid,
entityUuid: $entityUuid,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
roleUuid: $roleUuid,
status: $status,
uuid: $uuid,
where: $where
) {
items {
...RoleAssignmentFragment
}
limit
offset
totalItems
}
}
Variables
{
"assigneeUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"entityUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"limit": 987,
"offset": 987,
"orderBy": [RoleAssignmentOrderByQuery],
"roleUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"status": ["ACTIVATED"],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": RoleAssignmentQuery
}
Response
{
"data": {
"roleAssignments": {
"items": [RoleAssignment],
"limit": 123,
"offset": 987,
"totalItems": 987
}
}
}
roles
Description
Retrieves multiple Role objects that match the specified filters.
Response
Returns a PagedRoles!
Arguments
| Name | Description |
|---|---|
domainUuid - UUID
|
The domain UUID associated with the Role object. |
entityType - RoleEntityType
|
The type of entity that the Role object pertains to. |
limit - Int
|
The maximum number of items which should be returned. |
name - String
|
The name of the Role object to be retrieved. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [RoleOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - RoleWhereQuery
|
Complex filtering over Role objects. |
Example
Query
query roles(
$domainUuid: UUID,
$entityType: RoleEntityType,
$limit: Int,
$name: String,
$offset: Int,
$orderBy: [RoleOrderByQuery],
$uuid: [UUID],
$where: RoleWhereQuery
) {
roles(
domainUuid: $domainUuid,
entityType: $entityType,
limit: $limit,
name: $name,
offset: $offset,
orderBy: $orderBy,
uuid: $uuid,
where: $where
) {
items {
...RoleFragment
}
limit
offset
totalItems
}
}
Variables
{
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "DOMAIN",
"limit": 987,
"name": "xyz789",
"offset": 123,
"orderBy": [RoleOrderByQuery],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": RoleWhereQuery
}
Response
{
"data": {
"roles": {
"items": [Role],
"limit": 987,
"offset": 123,
"totalItems": 123
}
}
}
service
Description
Retrieve a single Service object by its UUID.
Response
Returns a Service!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Service to be retrieved. |
Example
Query
query service($uuid: UUID!) {
service(uuid: $uuid) {
characteristics {
...PagedCharacteristicsFragment
}
code
componentModels {
...PagedComponentModelsFragment
}
components {
...PagedComponentsFragment
}
createdAt
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
status
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"service": {
"characteristics": PagedCharacteristics,
"code": "abc123",
"componentModels": PagedComponentModels,
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
services
Description
This endpoint retrieves multiple Services with various filters. It has support for complex filtering over the Services and results are paginated by limit and offset. Requires UUID information for domain and orders the results.
Response
Returns a PagedServices!
Arguments
| Name | Description |
|---|---|
code - [String]
|
The list of Service codes by which to filter. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [ServiceOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [Status]
|
The status by which to filter entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - ServiceQuery
|
Complex filtering over Services. |
Example
Query
query services(
$code: [String],
$limit: Int,
$offset: Int,
$orderBy: [ServiceOrderByQuery],
$status: [Status],
$uuid: [UUID],
$where: ServiceQuery
) {
services(
code: $code,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
status: $status,
uuid: $uuid,
where: $where
) {
items {
...ServiceFragment
}
limit
offset
totalItems
}
}
Variables
{
"code": ["abc123"],
"limit": 987,
"offset": 123,
"orderBy": [ServiceOrderByQuery],
"status": ["ACTIVATED"],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": ServiceQuery
}
Response
{
"data": {
"services": {
"items": [Service],
"limit": 123,
"offset": 123,
"totalItems": 987
}
}
}
setpoints
Description
Retrieve multiple Setpoints.
Response
Returns a PagedSetpoints!
Arguments
| Name | Description |
|---|---|
after - String
|
The cursor after which items should be returned. |
characteristicCode - [String]
|
The list of Characteristic codes by which to filter fetched items. |
characteristicUuid - [UUID]
|
The list of Characteristic UUIDs by which to filter fetched items. |
componentCode - [String]
|
The list of Component codes by which to filter fetched items. |
componentModelCode - [String]
|
The list of Component Model codes by which to filter fetched items. |
componentModelUuid - [UUID]
|
The list of Component Model UUIDs by which to filter fetched items. |
componentUuid - [UUID]
|
The list of Component UUIDs by which to filter fetched items. |
from - DateTime
|
The inclusive start of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the previous possible time. A grid of 1h will snap to the previous full hour A grid of 1d snaps to the previous midnight in the UTC time zone A grid of 1w snaps to the previous midnight on Monday in the UTC time zone All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with a time of 12:12:00 matches to 12:00:00 and returns all elements from 12:00:00 to 12:15:00 in this grid. |
limit - Int
|
The maximum number of items which should be returned. |
orderBy - [SetpointOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
round - Int
|
Optional Integer. Configures the rounding of raw values before being counted. round specifies the number decimals to use when rounding the number. 0 rounds to the nearest integer. Optional, defaults to no rounding applied. |
serviceCode - [String]
|
The list of Service codes by which to filter fetched items. |
serviceIndex - [Int]
|
A list of Service & ComponentModel relationship indices to filter retrieved items. |
serviceUuid - [UUID]
|
A list of Service UUIDs by which to filter retrieved items. |
systemCode - [String]
|
The list of System codes by which to filter fetched items. |
systemUuid - [UUID]
|
The list of System UUIDs by which to filter fetched items. |
timeStreamUuid - [UUID]
|
The list of TimeStream UUIDs by which to filter fetched items. |
to - DateTime
|
The exclusive end of the window which data should be requested If a grid is passed along with this parameter, the value will be adjusted onto the next possible time. A grid of 1h will snap to the next full hour A grid of 1d snaps to next midnight in the UTC time zone A grid of 1w snaps to the next midnight on Monday in the UTC time zone. All grids less than 1h match to the common timespan which is requested. E.g. a grid of 15m with an to time of 12:12:00 matches to 12:15:00 and returns all elements from 12:00:00 to 12:15:00 in the last grid. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - SetpointsWhereQuery
|
Filter Setpoints based on specific criteria. |
Example
Query
query setpoints(
$after: String,
$characteristicCode: [String],
$characteristicUuid: [UUID],
$componentCode: [String],
$componentModelCode: [String],
$componentModelUuid: [UUID],
$componentUuid: [UUID],
$from: DateTime,
$limit: Int,
$orderBy: [SetpointOrderByQuery],
$round: Int,
$serviceCode: [String],
$serviceIndex: [Int],
$serviceUuid: [UUID],
$systemCode: [String],
$systemUuid: [UUID],
$timeStreamUuid: [UUID],
$to: DateTime,
$uuid: [UUID],
$where: SetpointsWhereQuery
) {
setpoints(
after: $after,
characteristicCode: $characteristicCode,
characteristicUuid: $characteristicUuid,
componentCode: $componentCode,
componentModelCode: $componentModelCode,
componentModelUuid: $componentModelUuid,
componentUuid: $componentUuid,
from: $from,
limit: $limit,
orderBy: $orderBy,
round: $round,
serviceCode: $serviceCode,
serviceIndex: $serviceIndex,
serviceUuid: $serviceUuid,
systemCode: $systemCode,
systemUuid: $systemUuid,
timeStreamUuid: $timeStreamUuid,
to: $to,
uuid: $uuid,
where: $where
) {
cursor
items {
...SetpointFragment
}
limit
}
}
Variables
{
"after": "xyz789",
"characteristicCode": ["abc123"],
"characteristicUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentCode": ["abc123"],
"componentModelCode": ["xyz789"],
"componentModelUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"componentUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"from": "2007-12-03T10:15:30Z",
"limit": 123,
"orderBy": [SetpointOrderByQuery],
"round": 987,
"serviceCode": ["xyz789"],
"serviceIndex": [123],
"serviceUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"systemCode": ["abc123"],
"systemUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"timeStreamUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"to": "2007-12-03T10:15:30Z",
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": SetpointsWhereQuery
}
Response
{
"data": {
"setpoints": {
"cursor": "abc123",
"items": [Setpoint],
"limit": 123
}
}
}
system
Description
Retrieves the data of a DRIVR System by UUID.
Response
Returns a System!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the System whose data you want to retrieve. |
Example
Query
query system($uuid: UUID!) {
system(uuid: $uuid) {
certificate {
...CertificateFragment
}
code
components {
...PagedComponentsFragment
}
connectionState
connectionStateUpdatedAt
createdAt
description
domain {
...DomainFragment
}
domainUuid
locationUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
owner {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
ownerUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
status
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"system": {
"certificate": Certificate,
"code": "xyz789",
"components": PagedComponents,
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"locationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
systems
Description
Retrieves a paged list of Systems available in DRIVR.
Response
Returns a PagedSystems!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [SystemOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [Status]
|
The status by which to filter entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - SystemQuery
|
Complex filtering over systems. |
Example
Query
query systems(
$limit: Int,
$offset: Int,
$orderBy: [SystemOrderByQuery],
$status: [Status],
$uuid: [UUID],
$where: SystemQuery
) {
systems(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
status: $status,
uuid: $uuid,
where: $where
) {
items {
...SystemFragment
}
limit
offset
totalItems
}
}
Variables
{
"limit": 123,
"offset": 987,
"orderBy": [SystemOrderByQuery],
"status": ["ACTIVATED"],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": SystemQuery
}
Response
{
"data": {
"systems": {
"items": [System],
"limit": 987,
"offset": 987,
"totalItems": 123
}
}
}
timeStream
Description
Retrieve a single TimeStream by uuid
Response
Returns a TimeStream!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the TimeStream. |
Example
Query
query timeStream($uuid: UUID!) {
timeStream(uuid: $uuid) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
component {
...ComponentFragment
}
componentUuid
createdAt
service {
...ServiceFragment
}
serviceIndex
serviceUuid
status
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"timeStream": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"service": Service,
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
timeStreams
Description
Retrieve a paged list of TimeStream's
Response
Returns a PagedTimeStreams!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [TimeStreamOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [Status]
|
The status by which to filter entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - TimeStreamQuery
|
Complex filtering over TimeStreams. |
Example
Query
query timeStreams(
$limit: Int,
$offset: Int,
$orderBy: [TimeStreamOrderByQuery],
$status: [Status],
$uuid: [UUID],
$where: TimeStreamQuery
) {
timeStreams(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
status: $status,
uuid: $uuid,
where: $where
) {
items {
...TimeStreamFragment
}
limit
offset
totalItems
}
}
Variables
{
"limit": 987,
"offset": 987,
"orderBy": [TimeStreamOrderByQuery],
"status": ["ACTIVATED"],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": TimeStreamQuery
}
Response
{
"data": {
"timeStreams": {
"items": [TimeStream],
"limit": 987,
"offset": 123,
"totalItems": 123
}
}
}
user
Description
This endpoint is used to retrieve a specific User and its information by a given UUID.
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the User whose account you wish to retrieve. |
Example
Query
query user($uuid: UUID!) {
user(uuid: $uuid) {
createdAt
domain {
...DomainFragment
}
domainUuid
email
loginMethods {
...PagedLoginMethodsFragment
}
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
organization {
...OrganizationFragment
}
organizationUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
sources {
...PagedUserSourcesFragment
}
status
systems {
...PagedSystemsFragment
}
updatedAt
uuid
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"user": {
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"email": "xyz789",
"loginMethods": PagedLoginMethods,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"organization": Organization,
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"sources": PagedUserSources,
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
userSources
Description
This endpoint retrieves multiple UserSources, which represent the connection between specific Users in DRIVR and specific DataSources.
Response
Returns a PagedUserSources!
Arguments
| Name | Description |
|---|---|
dataSourceUuid - [UUID]
|
The list of DataSource UUIDs by which to filter fetched items. |
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [UserSourceOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
userUuid - [UUID]
|
The list of User UUIDs by which to filter fetched items. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - UserSourceQuery
|
This where filter is used to narrow down the results of the userSources API endpoint. For example, you can use userSource: {dataSource: {uuid: {eq: "<uuid>"}}} to select all UserSources for a particular DataSource. |
Example
Query
query userSources(
$dataSourceUuid: [UUID],
$limit: Int,
$offset: Int,
$orderBy: [UserSourceOrderByQuery],
$userUuid: [UUID],
$uuid: [UUID],
$where: UserSourceQuery
) {
userSources(
dataSourceUuid: $dataSourceUuid,
limit: $limit,
offset: $offset,
orderBy: $orderBy,
userUuid: $userUuid,
uuid: $uuid,
where: $where
) {
items {
...UserSourceFragment
}
limit
offset
totalItems
}
}
Variables
{
"dataSourceUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"limit": 123,
"offset": 987,
"orderBy": [UserSourceOrderByQuery],
"userUuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": UserSourceQuery
}
Response
{
"data": {
"userSources": {
"items": [UserSource],
"limit": 987,
"offset": 123,
"totalItems": 123
}
}
}
users
Description
This endpoint returns a list of multiple Users in DRIVR that match the specified filters and pagination options.
Response
Returns a PagedUsers!
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum number of items which should be returned. |
offset - Int
|
The offset of items which should be returned. |
orderBy - [UserOrderByQuery]
|
Order fetched items by the given list of fields. Each argument in the list may only contain a single field: direction pair. If multiple fields are provided, the fetched items will be ordered by each field in turn. |
status - [Status]
|
The status by which to filter entities. |
uuid - [UUID]
|
The list of UUIDs by which to filter fetched items. |
where - UserQuery
|
This where filter is used to narrow down the results of the users API endpoint. This filter allows for complex querying over Users using fields. |
Example
Query
query users(
$limit: Int,
$offset: Int,
$orderBy: [UserOrderByQuery],
$status: [Status],
$uuid: [UUID],
$where: UserQuery
) {
users(
limit: $limit,
offset: $offset,
orderBy: $orderBy,
status: $status,
uuid: $uuid,
where: $where
) {
items {
...UserFragment
}
limit
offset
totalItems
}
}
Variables
{
"limit": 123,
"offset": 123,
"orderBy": [UserOrderByQuery],
"status": ["ACTIVATED"],
"uuid": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"where": UserQuery
}
Response
{
"data": {
"users": {
"items": [User],
"limit": 123,
"offset": 987,
"totalItems": 123
}
}
}
Mutations
ackEvent
Description
Acknowledges an Event within DRIVR, given its UUID. This means that it has been marked as "seen" by the user and will not be flagged as a new event again.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Event to be acknowledged. |
Example
Query
mutation ackEvent($uuid: UUID!) {
ackEvent(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"ackEvent": {"ok": Empty}}}
ackSetpoint
Description
Acknowledge a Setpoint.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
message - String
|
An optional message if the Setpoint is rejected. |
receiptId - String!
|
The receipt id of the Setpoint to acknowledge. |
state - SetpointState!
|
The state of the Setpoint. |
Example
Query
mutation ackSetpoint(
$message: String,
$receiptId: String!,
$state: SetpointState!
) {
ackSetpoint(
message: $message,
receiptId: $receiptId,
state: $state
) {
ok
}
}
Variables
{
"message": "xyz789",
"receiptId": "abc123",
"state": "ACCEPTED"
}
Response
{"data": {"ackSetpoint": {"ok": Empty}}}
addCharacteristicToService
Description
Add a Characteristic to a Service. Either codes or uuids for the Characteristic and Service are required.
Response
Returns a CharacteristicServiceLink
Example
Query
mutation addCharacteristicToService(
$characteristicCode: String,
$characteristicUuid: UUID,
$serviceCode: String,
$serviceUuid: UUID
) {
addCharacteristicToService(
characteristicCode: $characteristicCode,
characteristicUuid: $characteristicUuid,
serviceCode: $serviceCode,
serviceUuid: $serviceUuid
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
service {
...ServiceFragment
}
serviceUuid
status
updatedAt
uuid
}
}
Variables
{
"characteristicCode": "xyz789",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"addCharacteristicToService": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
addServiceToComponentModel
Description
Adds a Service to a ComponentModel object. Either UUIDs or Codes for the Service and ComponentModel are required for the operation.
Response
Returns a ServiceComponentModelLink
Arguments
| Name | Description |
|---|---|
componentModelCode - String
|
The code of the ComponentModel object to which to add the Service. |
componentModelUuid - UUID
|
The UUID of the ComponentModel object to which to add the Service. |
index - Int
|
The index value of the Service in the ComponentModel object. |
serviceCode - String
|
The code of the Service to add to the ComponentModel. |
serviceUuid - UUID
|
The UUID of the Service object to add to the ComponentModel. |
Example
Query
mutation addServiceToComponentModel(
$componentModelCode: String,
$componentModelUuid: UUID,
$index: Int,
$serviceCode: String,
$serviceUuid: UUID
) {
addServiceToComponentModel(
componentModelCode: $componentModelCode,
componentModelUuid: $componentModelUuid,
index: $index,
serviceCode: $serviceCode,
serviceUuid: $serviceUuid
) {
componentModel {
...ComponentModelFragment
}
componentModelUuid
createdAt
index
service {
...ServiceFragment
}
serviceUuid
status
updatedAt
uuid
}
}
Variables
{
"componentModelCode": "xyz789",
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"index": 987,
"serviceCode": "xyz789",
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"addServiceToComponentModel": {
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"index": 123,
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createApplicationConsumer
Description
Creates an ApplicationConsumer that acts as an API user or client, for authenticating against DRIVR and accessing its APIs, enabling external applications to interact with DRIVR on behalf of authenticated users, devices, applications, or connectors.
Response
Returns an ApplicationConsumer
Arguments
| Name | Description |
|---|---|
defaultRedirectUri - String
|
If not explicitly set, it defaults to the first element in redirect_uris. |
grantTypes - [GrantType]!
|
An ApplicationConsumer must have a list of grant_types with at least one entry. They represent how the application can authorize users against the API. |
name - String!
|
The name of the ApplicationConsumer. |
noExplicitConsentRequired - Boolean
|
Attribute which verifies if Identity entities which use the Application needs to give explicit consent for API access. |
ownerUuid - UUID
|
The UUID of the Account which owns the ApplicationConsumer. |
redirectUris - [String]
|
The redirect_uris of the ApplicationConsumer. Must have at least one redirect_uris entry if the grant_type=AUTHORIZATION_CODE. Multiple entires are supported. |
scopes - [String]!
|
An ApplicationConsumer must have at least one scopes entry. Multiple entires are supported and they indicate which scopes a certain ApplicationConsumer requires. |
secret - String
|
The secret of the ApplicationConsumer which is used for strengthened security guarantees for certain OAuth2 flows. |
slug - String!
|
The slug of the ApplicationConsumer which must be unique within the Domain. This will be prepended to the Domain's hostname to create the consumer's identifier. |
status - Status
|
The status of the ApplicationConsumer. |
Example
Query
mutation createApplicationConsumer(
$defaultRedirectUri: String,
$grantTypes: [GrantType]!,
$name: String!,
$noExplicitConsentRequired: Boolean,
$ownerUuid: UUID,
$redirectUris: [String],
$scopes: [String]!,
$secret: String,
$slug: String!,
$status: Status
) {
createApplicationConsumer(
defaultRedirectUri: $defaultRedirectUri,
grantTypes: $grantTypes,
name: $name,
noExplicitConsentRequired: $noExplicitConsentRequired,
ownerUuid: $ownerUuid,
redirectUris: $redirectUris,
scopes: $scopes,
secret: $secret,
slug: $slug,
status: $status
) {
createdAt
defaultRedirectUri
domain {
...DomainFragment
}
domainUuid
grantTypes
identifier
name
noExplicitConsentRequired
owner {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
ownerUuid
redirectUris
scopes
secret
slug
status
updatedAt
uuid
}
}
Variables
{
"defaultRedirectUri": "abc123",
"grantTypes": ["AUTHORIZATION_CODE"],
"name": "xyz789",
"noExplicitConsentRequired": false,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"redirectUris": ["abc123"],
"scopes": ["abc123"],
"secret": "xyz789",
"slug": "abc123",
"status": "ACTIVATED"
}
Response
{
"data": {
"createApplicationConsumer": {
"createdAt": "2007-12-03T10:15:30Z",
"defaultRedirectUri": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"grantTypes": ["AUTHORIZATION_CODE"],
"identifier": "abc123",
"name": "xyz789",
"noExplicitConsentRequired": false,
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"redirectUris": ["abc123"],
"scopes": ["abc123"],
"secret": "xyz789",
"slug": "abc123",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createAzureAuthenticationMethod
Description
Create a new DomainAuthenticationMethod for authenticating accounts from the Azure AD. Only one AzureDomainAuthenticationMethod of this type can be ACTIVATED at a time.
Response
Returns an AzureAuthenticationMethod
Arguments
| Name | Description |
|---|---|
configuration - CreateAzureAuthenticationMethodConfiguration
|
The configuration details which should be used to register DRIVR at the Azure Portal in order to allow Azure Accounts to authenticate themselves. |
status - Status
|
The status of the AzureDomainAuthenticationMethod. Can not be ARCHIVED on creation. |
Example
Query
mutation createAzureAuthenticationMethod(
$configuration: CreateAzureAuthenticationMethodConfiguration,
$status: Status
) {
createAzureAuthenticationMethod(
configuration: $configuration,
status: $status
) {
authenticationType
configuration {
...AzureAuthenticationMethodConfigurationFragment
}
createdAt
domain {
...DomainFragment
}
domainUuid
status
updatedAt
uuid
}
}
Variables
{
"configuration": CreateAzureAuthenticationMethodConfiguration,
"status": "ACTIVATED"
}
Response
{
"data": {
"createAzureAuthenticationMethod": {
"authenticationType": "AZURE_AD",
"configuration": AzureAuthenticationMethodConfiguration,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCertificate
Description
Creates a Certificate for an Issuer and a DRIVR Component or System.
Response
Returns a Certificate
Arguments
| Name | Description |
|---|---|
csr - String!
|
The csr for the Certificate as a base64 encoded string. |
duration - Timespan
|
The Certificate validity duration. Can not be a negative duration. |
entityUuid - UUID!
|
The UUID of the Component or System which the Certificate should be assigned to. |
issuerUuid - UUID!
|
The UUID of the Issuer which the Certificate belongs to. |
name - String!
|
The name for the Certificate. Has to be unique within the Domain. A Certificate name must not contain any special characters or white spaces. |
Example
Query
mutation createCertificate(
$csr: String!,
$duration: Timespan,
$entityUuid: UUID!,
$issuerUuid: UUID!,
$name: String!
) {
createCertificate(
csr: $csr,
duration: $duration,
entityUuid: $entityUuid,
issuerUuid: $issuerUuid,
name: $name
) {
certificate
createdAt
csr
domain {
...DomainFragment
}
domainUuid
duration
entity {
... on Component {
...ComponentFragment
}
... on System {
...SystemFragment
}
}
entityType
entityUuid
expiresAt
issuer {
...IssuerFragment
}
issuerUuid
name
updatedAt
uuid
}
}
Variables
{
"csr": "xyz789",
"duration": Timespan,
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"issuerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "xyz789"
}
Response
{
"data": {
"createCertificate": {
"certificate": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csr": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"duration": Timespan,
"entity": Component,
"entityType": "COMPONENT",
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"expiresAt": "2007-12-03T10:15:30Z",
"issuer": Issuer,
"issuerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristic
Description
Create a new Characteristic. A Characteristic groups values of the same kind and has a distinct data type. Refer to the individual Characteristic nodes for a more detailed description.
Response
Returns a Characteristic
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
dataType - CharacteristicDataType!
|
The Characteristic's data type. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristic(
$characteristicType: CharacteristicType,
$code: String,
$dataType: CharacteristicDataType!,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status,
$symbol: String
) {
createCharacteristic(
characteristicType: $characteristicType,
code: $code,
dataType: $dataType,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"dataType": "BLOB",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123"
}
Response
{
"data": {
"createCharacteristic": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicBlob
Description
Create a new blob Characteristic. Refer to the returned CharacteristicBlob node for a more detailed description.
Response
Returns a CharacteristicBlob
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicBlob(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status,
$symbol: String
) {
createCharacteristicBlob(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123"
}
Response
{
"data": {
"createCharacteristicBlob": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicBoolean
Description
Create a new boolean Characteristic. Refer to the returned CharacteristicBoolean node for a more detailed description.
Response
Returns a CharacteristicBoolean
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicBoolean(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status,
$symbol: String
) {
createCharacteristicBoolean(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"symbol": "xyz789"
}
Response
{
"data": {
"createCharacteristicBoolean": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicDate
Description
Create a new date Characteristic. Refer to the returned CharacteristicDate node for a more detailed description.
Response
Returns a CharacteristicDate
Arguments
| Name | Description |
|---|---|
boundaryMax - Date
|
The upper boundary of allowed values. |
boundaryMin - Date
|
The lower boundary of allowed values. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicDate(
$boundaryMax: Date,
$boundaryMin: Date,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status,
$symbol: String
) {
createCharacteristicDate(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol
) {
boundaryMax
boundaryMin
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": "2007-12-03",
"boundaryMin": "2007-12-03",
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123"
}
Response
{
"data": {
"createCharacteristicDate": {
"boundaryMax": "2007-12-03",
"boundaryMin": "2007-12-03",
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicFloat
Description
Create a new float Characteristic. Refer to the returned CharacteristicFloat node for a more detailed description.
Response
Returns a CharacteristicFloat
Arguments
| Name | Description |
|---|---|
boundaryMax - Float
|
The upper boundary of allowed values. |
boundaryMin - Float
|
The lower boundary of allowed values. |
boundaryStep - Float
|
It represents the step size or increment value. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
precision - Int
|
The floating-point precision of values. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicFloat(
$boundaryMax: Float,
$boundaryMin: Float,
$boundaryStep: Float,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$precision: Int,
$status: Status,
$symbol: String
) {
createCharacteristicFloat(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
boundaryStep: $boundaryStep,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
precision: $precision,
status: $status,
symbol: $symbol
) {
boundaryMax
boundaryMin
boundaryStep
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
precision
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": 987.65,
"boundaryMin": 987.65,
"boundaryStep": 987.65,
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"precision": 987,
"status": "ACTIVATED",
"symbol": "abc123"
}
Response
{
"data": {
"createCharacteristicFloat": {
"boundaryMax": 123.45,
"boundaryMin": 987.65,
"boundaryStep": 123.45,
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"precision": 987,
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicInteger
Description
Create a new integer Characteristic. Refer to the returned CharacteristicInteger node for a more detailed description.
Response
Returns a CharacteristicInteger
Arguments
| Name | Description |
|---|---|
boundaryMax - Int
|
The upper boundary of allowed values. |
boundaryMin - Int
|
The lower boundary of allowed values. |
boundaryStep - Int
|
It represents the step size or increment value. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicInteger(
$boundaryMax: Int,
$boundaryMin: Int,
$boundaryStep: Int,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status,
$symbol: String
) {
createCharacteristicInteger(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
boundaryStep: $boundaryStep,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol
) {
boundaryMax
boundaryMin
boundaryStep
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": 123,
"boundaryMin": 987,
"boundaryStep": 987,
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "xyz789"
}
Response
{
"data": {
"createCharacteristicInteger": {
"boundaryMax": 987,
"boundaryMin": 987,
"boundaryStep": 123,
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicJson
Description
Create a new JSON Characteristic. Refer to the returned CharacteristicJson node for a more detailed description.
Response
Returns a CharacteristicJson
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
schema - String
|
JSON schema for valuepoints. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicJson(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$schema: String,
$status: Status,
$symbol: String
) {
createCharacteristicJson(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
schema: $schema,
status: $status,
symbol: $symbol
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
schema
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"schema": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123"
}
Response
{
"data": {
"createCharacteristicJson": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"schema": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicSelect
Description
Create a new SELECT Characteristic. Refer to the returned CharacteristicSelect node for a more detailed description.
Response
Returns a CharacteristicSelect
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
multiple - Boolean
|
Whether the SELECT Characteristic allows multiple options to be selected at the same time. |
name - String!
|
The name of the Characteristic. |
options - [CharacteristicSelectOptionQuery]
|
List of options which can be selected on the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicSelect(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$multiple: Boolean,
$name: String!,
$options: [CharacteristicSelectOptionQuery],
$status: Status,
$symbol: String
) {
createCharacteristicSelect(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
multiple: $multiple,
name: $name,
options: $options,
status: $status,
symbol: $symbol
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
multiple
name
options {
...CharacteristicSelectOptionFragment
}
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"multiple": true,
"name": "abc123",
"options": [CharacteristicSelectOptionQuery],
"status": "ACTIVATED",
"symbol": "xyz789"
}
Response
{
"data": {
"createCharacteristicSelect": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"multiple": true,
"name": "abc123",
"options": [CharacteristicSelectOption],
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicString
Description
Create a new string Characteristic. Refer to the returned CharacteristicString node for a more detailed description.
Response
Returns a CharacteristicString
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
lengthMax - Int
|
The maximum length of allowed values. |
lengthMin - Int
|
The minimum length of allowed values. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicString(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$lengthMax: Int,
$lengthMin: Int,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status,
$symbol: String
) {
createCharacteristicString(
characteristicType: $characteristicType,
code: $code,
description: $description,
lengthMax: $lengthMax,
lengthMin: $lengthMin,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
lengthMax
lengthMin
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"description": "abc123",
"lengthMax": 123,
"lengthMin": 123,
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123"
}
Response
{
"data": {
"createCharacteristicString": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"lengthMax": 987,
"lengthMin": 987,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicTime
Description
Create a new time Characteristic. Refer to the returned CharacteristicTime node for a more detailed description.
Response
Returns a CharacteristicTime
Arguments
| Name | Description |
|---|---|
boundaryMax - Time
|
The upper boundary of allowed values. |
boundaryMin - Time
|
The lower boundary of allowed values. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicTime(
$boundaryMax: Time,
$boundaryMin: Time,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status,
$symbol: String
) {
createCharacteristicTime(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol
) {
boundaryMax
boundaryMin
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": "10:15:30Z",
"boundaryMin": "10:15:30Z",
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123"
}
Response
{
"data": {
"createCharacteristicTime": {
"boundaryMax": "10:15:30Z",
"boundaryMin": "10:15:30Z",
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicTimespan
Description
Create a new timespan Characteristic. Refer to the returned CharacteristicTimespan node for a more detailed description.
Response
Returns a CharacteristicTimespan
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicTimespan(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status,
$symbol: String
) {
createCharacteristicTimespan(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"symbol": "abc123"
}
Response
{
"data": {
"createCharacteristicTimespan": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicTimestamp
Description
Create a new timestamp Characteristic. Refer to the returned CharacteristicTimestamp node for a more detailed description.
Response
Returns a CharacteristicTimestamp
Arguments
| Name | Description |
|---|---|
boundaryMax - DateTime
|
The upper boundary of allowed values. |
boundaryMin - DateTime
|
The lower boundary of allowed values. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
Example
Query
mutation createCharacteristicTimestamp(
$boundaryMax: DateTime,
$boundaryMin: DateTime,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status,
$symbol: String
) {
createCharacteristicTimestamp(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol
) {
boundaryMax
boundaryMin
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": "2007-12-03T10:15:30Z",
"boundaryMin": "2007-12-03T10:15:30Z",
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"symbol": "xyz789"
}
Response
{
"data": {
"createCharacteristicTimestamp": {
"boundaryMax": "2007-12-03T10:15:30Z",
"boundaryMin": "2007-12-03T10:15:30Z",
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createCharacteristicValidValueBoolean
Description
Create a new CharacteristicValidValue of type boolean.
Response
Returns a CharacteristicValidValueBoolean
Example
Query
mutation createCharacteristicValidValueBoolean(
$characteristicUuid: UUID!,
$description: String,
$value: Boolean!
) {
createCharacteristicValidValueBoolean(
characteristicUuid: $characteristicUuid,
description: $description,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "abc123",
"value": false
}
Response
{
"data": {
"createCharacteristicValidValueBoolean": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": false
}
}
}
createCharacteristicValidValueFloat
Description
Create a new CharacteristicValidValue of type float.
Response
Returns a CharacteristicValidValueFloat
Example
Query
mutation createCharacteristicValidValueFloat(
$characteristicUuid: UUID!,
$description: String,
$value: Float!
) {
createCharacteristicValidValueFloat(
characteristicUuid: $characteristicUuid,
description: $description,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "abc123",
"value": 123.45
}
Response
{
"data": {
"createCharacteristicValidValueFloat": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987.65
}
}
}
createCharacteristicValidValueInteger
Description
Create a new CharacteristicValidValue of type integer.
Response
Returns a CharacteristicValidValueInteger
Example
Query
mutation createCharacteristicValidValueInteger(
$characteristicUuid: UUID!,
$description: String,
$value: Int!
) {
createCharacteristicValidValueInteger(
characteristicUuid: $characteristicUuid,
description: $description,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "abc123",
"value": 987
}
Response
{
"data": {
"createCharacteristicValidValueInteger": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987
}
}
}
createCharacteristicValidValueString
Description
Create a new CharacteristicValidValue of type string.
Response
Returns a CharacteristicValidValueString
Example
Query
mutation createCharacteristicValidValueString(
$characteristicUuid: UUID!,
$description: String,
$value: String!
) {
createCharacteristicValidValueString(
characteristicUuid: $characteristicUuid,
description: $description,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "xyz789",
"value": "xyz789"
}
Response
{
"data": {
"createCharacteristicValidValueString": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "abc123"
}
}
}
createCharacteristicValidValueTime
Description
Create a new CharacteristicValidValue of type time.
Response
Returns a CharacteristicValidValueTime
Example
Query
mutation createCharacteristicValidValueTime(
$characteristicUuid: UUID!,
$description: String,
$value: Time!
) {
createCharacteristicValidValueTime(
characteristicUuid: $characteristicUuid,
description: $description,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "abc123",
"value": "10:15:30Z"
}
Response
{
"data": {
"createCharacteristicValidValueTime": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "10:15:30Z"
}
}
}
createCharacteristicValidValueTimespan
Description
Create a new CharacteristicValidValue of type timespan.
Response
Returns a CharacteristicValidValueTimespan
Example
Query
mutation createCharacteristicValidValueTimespan(
$characteristicUuid: UUID!,
$description: String,
$value: Timespan!
) {
createCharacteristicValidValueTimespan(
characteristicUuid: $characteristicUuid,
description: $description,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "abc123",
"value": Timespan
}
Response
{
"data": {
"createCharacteristicValidValueTimespan": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": Timespan
}
}
}
createComponent
Description
Creates a new Component.
Response
Returns a Component
Arguments
| Name | Description |
|---|---|
code - String!
|
A human-readable identifier for the Component. |
componentModelUuid - UUID!
|
The UUID of the ComponentModel from which the Component is created. |
connectionState - ComponentConnectionState
|
The connection state of the Component. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Component. |
status - Status
|
The status of the Component. |
systemUuid - UUID!
|
The UUID of the System to which the Component belongs. |
Example
Query
mutation createComponent(
$code: String!,
$componentModelUuid: UUID!,
$connectionState: ComponentConnectionState,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$systemUuid: UUID!
) {
createComponent(
code: $code,
componentModelUuid: $componentModelUuid,
connectionState: $connectionState,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
systemUuid: $systemUuid
) {
certificate {
...CertificateFragment
}
characteristics {
...PagedCharacteristicsFragment
}
code
componentModel {
...ComponentModelFragment
}
componentModelUuid
connectionState
connectionStateUpdatedAt
createdAt
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesOnComponentFragment
}
status
system {
...SystemFragment
}
systemUuid
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"connectionState": "CONNECTED",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"createComponent": {
"certificate": Certificate,
"characteristics": PagedCharacteristics,
"code": "abc123",
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServicesOnComponent,
"status": "ACTIVATED",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createComponentModel
Description
This endpoint creates a new ComponentModel object.
Response
Returns a ComponentModel
Arguments
| Name | Description |
|---|---|
code - String
|
A human-readable identifier for the ComponentModel. |
componentType - ComponentType!
|
The type of the ComponentModel. Values are restricted to the component-type enum. |
description - String
|
A description of the ComponentModel. |
isConnective - Boolean
|
A setting which allows instantiated Component to report their connection state. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the ComponentModel. |
status - Status
|
The status of the ComponentModel. Values are restricted to the status enum. |
Example
Query
mutation createComponentModel(
$code: String,
$componentType: ComponentType!,
$description: String,
$isConnective: Boolean,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status
) {
createComponentModel(
code: $code,
componentType: $componentType,
description: $description,
isConnective: $isConnective,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status
) {
code
componentType
components {
...PagedComponentsFragment
}
createdAt
description
domain {
...DomainFragment
}
domainUuid
isConnective
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesOnComponentModelFragment
}
status
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"componentType": "DEVICE",
"description": "abc123",
"isConnective": false,
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED"
}
Response
{
"data": {
"createComponentModel": {
"code": "abc123",
"componentType": "DEVICE",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"isConnective": false,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServicesOnComponentModel,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createDataSource
Description
Create a new DataSource.
Response
Returns a DataSource
Example
Query
mutation createDataSource(
$code: String!,
$description: String,
$name: String,
$reference: String
) {
createDataSource(
code: $code,
description: $description,
name: $name,
reference: $reference
) {
code
createdAt
description
domain {
...DomainFragment
}
domainUuid
name
reference
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"description": "abc123",
"name": "abc123",
"reference": "xyz789"
}
Response
{
"data": {
"createDataSource": {
"code": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "xyz789",
"reference": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createDatapointBlob
Description
Create Datapoints of type blob.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputBlob]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointBlob($datapoints: [DatapointInputBlob]!) {
createDatapointBlob(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputBlob]}
Response
{"data": {"createDatapointBlob": {"ok": Empty}}}
createDatapointBoolean
Description
Create Datapoints of type boolean.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputBoolean]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointBoolean($datapoints: [DatapointInputBoolean]!) {
createDatapointBoolean(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputBoolean]}
Response
{"data": {"createDatapointBoolean": {"ok": Empty}}}
createDatapointDate
Description
Create Datapoints of type date.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputDate]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointDate($datapoints: [DatapointInputDate]!) {
createDatapointDate(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputDate]}
Response
{"data": {"createDatapointDate": {"ok": Empty}}}
createDatapointFloat
Description
Create Datapoints of type float.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputFloat]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointFloat($datapoints: [DatapointInputFloat]!) {
createDatapointFloat(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputFloat]}
Response
{"data": {"createDatapointFloat": {"ok": Empty}}}
createDatapointInteger
Description
Create Datapoints of type integer.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputInteger]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointInteger($datapoints: [DatapointInputInteger]!) {
createDatapointInteger(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputInteger]}
Response
{"data": {"createDatapointInteger": {"ok": Empty}}}
createDatapointJson
Description
Create Datapoints of type json.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputJson]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointJson($datapoints: [DatapointInputJson]!) {
createDatapointJson(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputJson]}
Response
{"data": {"createDatapointJson": {"ok": Empty}}}
createDatapointSelect
Description
Create Datapoints of type select.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputSelect]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointSelect($datapoints: [DatapointInputSelect]!) {
createDatapointSelect(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputSelect]}
Response
{"data": {"createDatapointSelect": {"ok": Empty}}}
createDatapointString
Description
Create Datapoints of type string.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputString]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointString($datapoints: [DatapointInputString]!) {
createDatapointString(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputString]}
Response
{"data": {"createDatapointString": {"ok": Empty}}}
createDatapointTime
Description
Create Datapoints of type time.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputTime]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointTime($datapoints: [DatapointInputTime]!) {
createDatapointTime(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputTime]}
Response
{"data": {"createDatapointTime": {"ok": Empty}}}
createDatapointTimespan
Description
Create Datapoints of type timespan.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputTimespan]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointTimespan($datapoints: [DatapointInputTimespan]!) {
createDatapointTimespan(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputTimespan]}
Response
{"data": {"createDatapointTimespan": {"ok": Empty}}}
createDatapointTimestamp
Description
Create Datapoints of type timestamp.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
datapoints - [DatapointInputTimestamp]!
|
The Datapoints to create. |
Example
Query
mutation createDatapointTimestamp($datapoints: [DatapointInputTimestamp]!) {
createDatapointTimestamp(datapoints: $datapoints) {
ok
}
}
Variables
{"datapoints": [DatapointInputTimestamp]}
Response
{"data": {"createDatapointTimestamp": {"ok": Empty}}}
createDefaultAuthenticationMethod
Description
Create an DomainAuthenticationMethod of type DEFAULT. This is used to setup DRIVR's internal OAuth2 authentication and allows DRIVR User with a password authenticate themselves. Only one DomainAuthenticationMethod of this type can be ACTIVATED at a time.
Response
Returns a DefaultAuthenticationMethod
Arguments
| Name | Description |
|---|---|
status - Status
|
The status of the DefaultDomainAuthenticationMethod. |
Example
Query
mutation createDefaultAuthenticationMethod($status: Status) {
createDefaultAuthenticationMethod(status: $status) {
authenticationType
createdAt
domain {
...DomainFragment
}
domainUuid
status
updatedAt
uuid
}
}
Variables
{"status": "ACTIVATED"}
Response
{
"data": {
"createDefaultAuthenticationMethod": {
"authenticationType": "AZURE_AD",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createEvent
Description
Creates a new Event within DRIVR, given the UUIDs of the Entity and EventModel, and optionally, the start and end timestamps of the event.
Response
Returns an Event
Arguments
| Name | Description |
|---|---|
endTime - DateTime
|
The end date and time for the Event. If no value is passed, the current timestamp is used. |
entityUuid - UUID!
|
The UUID of the Entity to which the Event belongs. |
eventModelUuid - UUID!
|
The UUID of the EventModel which the Event is created from. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
time - DateTime
|
The start date and time for the Event. If no value is passed, the current timestamp is used. |
Example
Query
mutation createEvent(
$endTime: DateTime,
$entityUuid: UUID!,
$eventModelUuid: UUID!,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$time: DateTime
) {
createEvent(
endTime: $endTime,
entityUuid: $entityUuid,
eventModelUuid: $eventModelUuid,
metadataKeyValueStore: $metadataKeyValueStore,
time: $time
) {
acknowledged
acks {
...PagedEventAcksFragment
}
createdAt
endTime
entity {
... on Component {
...ComponentFragment
}
... on System {
...SystemFragment
}
}
entityUuid
eventModel {
...EventModelFragment
}
eventModelUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
status
time
updatedAt
uuid
}
}
Variables
{
"endTime": "2007-12-03T10:15:30Z",
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"time": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"createEvent": {
"acknowledged": true,
"acks": PagedEventAcks,
"createdAt": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"entity": Component,
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"eventModel": EventModel,
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"status": "ACTIVE",
"time": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createEventModel
Description
Create a new EventModel based on the arguments provided.
Response
Returns an EventModel
Arguments
| Name | Description |
|---|---|
code - String
|
Defines a human-readable identifier for the EventModel. |
entityType - EventEntityType!
|
Describes the type of DRIVR entity an Event can correspond to e.g. Component, System, …. |
eventLevel - EventLevel
|
The event level of the EventModel. |
eventType - EventType!
|
Determines if the Events are of type SINGLE_POINT or RANGED. SINGLE_POINT Events are emitted for a single point in time. RANGED Events are emitted for a range of time. |
limitToPrototypes - Boolean
|
Whether Events may be emitted for all instances of a specific EntityType or only certain DRIVR entity prototypes (e.g. whether an Event can be emitted for all Components or only for Components that correspond to certain ComponentModels). This can be set by creating EventModelLinks. Can't be true if entity type is System. |
message - String
|
An optional message which can provide more detail about the derived Events. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
status - Status
|
The status of the EventModel which can be ACTIVATED or DEACTIVATED. ARCHIVED is not allowed for newly created EventModels. |
Example
Query
mutation createEventModel(
$code: String,
$entityType: EventEntityType!,
$eventLevel: EventLevel,
$eventType: EventType!,
$limitToPrototypes: Boolean,
$message: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$status: Status
) {
createEventModel(
code: $code,
entityType: $entityType,
eventLevel: $eventLevel,
eventType: $eventType,
limitToPrototypes: $limitToPrototypes,
message: $message,
metadataKeyValueStore: $metadataKeyValueStore,
status: $status
) {
code
createdAt
domain {
...DomainFragment
}
domainUuid
entityType
eventLevel
eventModelLinks {
...PagedEventModelLinksFragment
}
eventType
limitToPrototypes
message
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
status
updatedAt
uuid
}
}
Variables
{
"code": "xyz789",
"entityType": "COMPONENT",
"eventLevel": "ERROR",
"eventType": "RANGED",
"limitToPrototypes": false,
"message": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"status": "ACTIVATED"
}
Response
{
"data": {
"createEventModel": {
"code": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "COMPONENT",
"eventLevel": "ERROR",
"eventModelLinks": PagedEventModelLinks,
"eventType": "RANGED",
"limitToPrototypes": true,
"message": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePair],
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createEventModelLink
Description
This endpoint creates a new EventModelLink.
Response
Returns an EventModelLink
Example
Query
mutation createEventModelLink(
$eventModelUuid: UUID!,
$prototypeUuid: UUID!,
$status: Status
) {
createEventModelLink(
eventModelUuid: $eventModelUuid,
prototypeUuid: $prototypeUuid,
status: $status
) {
createdAt
eventModel {
...EventModelFragment
}
eventModelUuid
prototype {
... on ComponentModel {
...ComponentModelFragment
}
}
prototypeUuid
status
updatedAt
uuid
}
}
Variables
{
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"prototypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED"
}
Response
{
"data": {
"createEventModelLink": {
"createdAt": "2007-12-03T10:15:30Z",
"eventModel": EventModel,
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"prototype": ComponentModel,
"prototypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createGoogleAuthenticationMethod
Description
Create a new DomainAuthenticationMethod which allows authentication with Google Accounts. Only one GoogleAuthenticationMethod of this type can be ACTIVATED at a time.
Response
Returns a GoogleAuthenticationMethod
Arguments
| Name | Description |
|---|---|
configuration - CreateGoogleAuthenticationMethodConfiguration
|
The configuration settings of the DomainAuthenticationMethod for Google Account authentication. |
status - Status
|
The status of the GoogleAuthenticationMethod. This can not be ARCHIVED on creation. |
Example
Query
mutation createGoogleAuthenticationMethod(
$configuration: CreateGoogleAuthenticationMethodConfiguration,
$status: Status
) {
createGoogleAuthenticationMethod(
configuration: $configuration,
status: $status
) {
authenticationType
configuration {
...GoogleAuthenticationMethodConfigurationFragment
}
createdAt
domain {
...DomainFragment
}
domainUuid
status
updatedAt
uuid
}
}
Variables
{
"configuration": CreateGoogleAuthenticationMethodConfiguration,
"status": "ACTIVATED"
}
Response
{
"data": {
"createGoogleAuthenticationMethod": {
"authenticationType": "AZURE_AD",
"configuration": GoogleAuthenticationMethodConfiguration,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createMachineUser
Description
Creates a MachineUser with the provided parameters.
Response
Returns a MachineUser
Arguments
| Name | Description |
|---|---|
password - String!
|
The password of the MachineUser to be created. This is used to login to DRIVR with the machine user's rights. |
status - Status
|
The status of the MachineUser. Defaults to ACTIVATED. |
username - String!
|
The name of the MachineUser to be created. This is used to login to DRIVR with the machine user's rights. |
Example
Query
mutation createMachineUser(
$password: String!,
$status: Status,
$username: String!
) {
createMachineUser(
password: $password,
status: $status,
username: $username
) {
createdAt
domain {
...DomainFragment
}
domainUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
status
updatedAt
username
uuid
}
}
Variables
{
"password": "abc123",
"status": "ACTIVATED",
"username": "xyz789"
}
Response
{
"data": {
"createMachineUser": {
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"username": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createMetadataTypeBoolean
Description
Creates a new MetadataType for storing boolean values.
Response
Returns a MetadataTypeBoolean
Arguments
| Name | Description |
|---|---|
default - Boolean
|
The default value for this metadata field. |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
Example
Query
mutation createMetadataTypeBoolean(
$default: Boolean,
$description: String,
$entityType: MetadataTypeEntityTypes!,
$key: String!
) {
createMetadataTypeBoolean(
default: $default,
description: $description,
entityType: $entityType,
key: $key
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
updatedAt
uuid
}
}
Variables
{
"default": false,
"description": "xyz789",
"entityType": "CHARACTERISTIC",
"key": "abc123"
}
Response
{
"data": {
"createMetadataTypeBoolean": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": true,
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createMetadataTypeFloat
Description
Creates a new MetadataType for storing float values.
Response
Returns a MetadataTypeFloat
Arguments
| Name | Description |
|---|---|
default - Float
|
The default value for this metadata field. |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
Example
Query
mutation createMetadataTypeFloat(
$default: Float,
$description: String,
$entityType: MetadataTypeEntityTypes!,
$key: String!
) {
createMetadataTypeFloat(
default: $default,
description: $description,
entityType: $entityType,
key: $key
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
updatedAt
uuid
}
}
Variables
{
"default": 123.45,
"description": "abc123",
"entityType": "CHARACTERISTIC",
"key": "xyz789"
}
Response
{
"data": {
"createMetadataTypeFloat": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": 987.65,
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createMetadataTypeInteger
Description
Creates a new MetadataType for storing integer values.
Response
Returns a MetadataTypeInteger
Arguments
| Name | Description |
|---|---|
default - Int
|
The default value for this metadata field. |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
unique - Boolean
|
Specifies the individual value within the entities of this metadata type to must be unique. |
Example
Query
mutation createMetadataTypeInteger(
$default: Int,
$description: String,
$entityType: MetadataTypeEntityTypes!,
$key: String!,
$unique: Boolean
) {
createMetadataTypeInteger(
default: $default,
description: $description,
entityType: $entityType,
key: $key,
unique: $unique
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
unique
updatedAt
uuid
}
}
Variables
{
"default": 123,
"description": "xyz789",
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"unique": true
}
Response
{
"data": {
"createMetadataTypeInteger": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": 987,
"description": "abc123",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"unique": true,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createMetadataTypeString
Description
Creates a new MetadataType for storing string values.
Response
Returns a MetadataTypeString
Arguments
| Name | Description |
|---|---|
default - String
|
The default value for this metadata field. |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
unique - Boolean
|
Specifies the individual value within the entities of this metadata type to must be unique. |
Example
Query
mutation createMetadataTypeString(
$default: String,
$description: String,
$entityType: MetadataTypeEntityTypes!,
$key: String!,
$unique: Boolean
) {
createMetadataTypeString(
default: $default,
description: $description,
entityType: $entityType,
key: $key,
unique: $unique
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
unique
updatedAt
uuid
}
}
Variables
{
"default": "abc123",
"description": "abc123",
"entityType": "CHARACTERISTIC",
"key": "abc123",
"unique": false
}
Response
{
"data": {
"createMetadataTypeString": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": "abc123",
"description": "abc123",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"unique": true,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createMetadataTypeTimestamp
Description
Creates a new MetadataType for storing timestamp values.
Response
Returns a MetadataTypeTimestamp
Arguments
| Name | Description |
|---|---|
default - DateTime
|
The default value for this metadata field. |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
Example
Query
mutation createMetadataTypeTimestamp(
$default: DateTime,
$description: String,
$entityType: MetadataTypeEntityTypes!,
$key: String!
) {
createMetadataTypeTimestamp(
default: $default,
description: $description,
entityType: $entityType,
key: $key
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
updatedAt
uuid
}
}
Variables
{
"default": "2007-12-03T10:15:30Z",
"description": "xyz789",
"entityType": "CHARACTERISTIC",
"key": "abc123"
}
Response
{
"data": {
"createMetadataTypeTimestamp": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": "2007-12-03T10:15:30Z",
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createMetadataTypeUuid
Description
Creates a new MetadataType for storing UUID values.
Response
Returns a MetadataTypeUuid
Arguments
| Name | Description |
|---|---|
default - UUID
|
The default value for this metadata field. |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
Example
Query
mutation createMetadataTypeUuid(
$default: UUID,
$description: String,
$entityType: MetadataTypeEntityTypes!,
$key: String!
) {
createMetadataTypeUuid(
default: $default,
description: $description,
entityType: $entityType,
key: $key
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
updatedAt
uuid
}
}
Variables
{
"default": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "xyz789",
"entityType": "CHARACTERISTIC",
"key": "xyz789"
}
Response
{
"data": {
"createMetadataTypeUuid": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createOpenIdDelegatedAuthenticationMethod
Description
Create a new OpenID Bearer token delegation DomainAuthenticationMethod. The OpenIdDelegatedAuthenticationMethod is used to authenticate accounts from a third party OpenID Provider with a provided bearer token. Only one OpenIdDelegatedAuthenticationMethod of this type can be ACTIVATED at a time.
Response
Returns an OpenIdDelegatedAuthenticationMethod
Arguments
| Name | Description |
|---|---|
configuration - CreateOpenIdDelegatedAuthenticationMethodConfiguration
|
The configuration of the DomainAuthenticationMethod in order to setup validation of provided bearer tokens for authentication. |
status - Status
|
The status of the Authentication Method. |
Example
Query
mutation createOpenIdDelegatedAuthenticationMethod(
$configuration: CreateOpenIdDelegatedAuthenticationMethodConfiguration,
$status: Status
) {
createOpenIdDelegatedAuthenticationMethod(
configuration: $configuration,
status: $status
) {
authenticationType
configuration {
...OpenIdDelegatedAuthenticationMethodConfigurationFragment
}
createdAt
domain {
...DomainFragment
}
domainUuid
status
updatedAt
uuid
}
}
Variables
{
"configuration": CreateOpenIdDelegatedAuthenticationMethodConfiguration,
"status": "ACTIVATED"
}
Response
{
"data": {
"createOpenIdDelegatedAuthenticationMethod": {
"authenticationType": "AZURE_AD",
"configuration": OpenIdDelegatedAuthenticationMethodConfiguration,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createOrganization
Description
Creates a new Organization in the system. An Organization is a company or department which can own Systems. An Organization can be owned by a User.
Response
Returns an Organization
Arguments
| Name | Description |
|---|---|
alias - String
|
The alias name of the Organization. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the Organization. |
ownerUuid - UUID
|
The UUID of the User which owns the entity. |
status - Status
|
The status of the Organization. |
Example
Query
mutation createOrganization(
$alias: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$ownerUuid: UUID,
$status: Status
) {
createOrganization(
alias: $alias,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
ownerUuid: $ownerUuid,
status: $status
) {
alias
createdAt
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
owner {
...UserFragment
}
ownerUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
sources {
...PagedOrganizationSourcesFragment
}
status
systems {
...PagedSystemsFragment
}
updatedAt
users {
...PagedUsersFragment
}
uuid
}
}
Variables
{
"alias": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED"
}
Response
{
"data": {
"createOrganization": {
"alias": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"owner": User,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"sources": PagedOrganizationSources,
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"users": PagedUsers,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createPasswordLoginMethod
Description
Creates a PasswordLoginMethod with the provided parameters.
Response
Returns a PasswordLoginMethod
Arguments
| Name | Description |
|---|---|
password - String!
|
The password of the PasswordLoginMethod to be created. This is used to login to DRIVR with the password login user's rights. |
userUuid - UUID!
|
The uuid of the User to be associated with the PasswordLoginMethod. |
username - String!
|
The name of the PasswordLoginMethod to be created. This is used to login to DRIVR with the password login user's rights. |
Example
Query
mutation createPasswordLoginMethod(
$password: String!,
$userUuid: UUID!,
$username: String!
) {
createPasswordLoginMethod(
password: $password,
userUuid: $userUuid,
username: $username
) {
createdAt
domain {
...DomainFragment
}
domainAuthenticationMethod {
... on AzureAuthenticationMethod {
...AzureAuthenticationMethodFragment
}
... on DefaultAuthenticationMethod {
...DefaultAuthenticationMethodFragment
}
... on GoogleAuthenticationMethod {
...GoogleAuthenticationMethodFragment
}
... on OpenIdDelegatedAuthenticationMethod {
...OpenIdDelegatedAuthenticationMethodFragment
}
}
domainAuthenticationMethodUuid
domainUuid
type
updatedAt
user {
...UserFragment
}
userUuid
username
uuid
}
}
Variables
{
"password": "xyz789",
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"username": "xyz789"
}
Response
{
"data": {
"createPasswordLoginMethod": {
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainAuthenticationMethod": AzureAuthenticationMethod,
"domainAuthenticationMethodUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "OAUTH_AZURE",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"username": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createRole
Description
Creates a new Role that can be assigned to User or Organization entities, as well as other entities within DRIVR.
Response
Returns a Role
Arguments
| Name | Description |
|---|---|
entityType - RoleEntityType!
|
The type of the entity that the Role pertains to. |
name - String!
|
The name of the Role to be created. |
status - Status
|
The status of the Role. Default to active if not provided. |
Example
Query
mutation createRole(
$entityType: RoleEntityType!,
$name: String!,
$status: Status
) {
createRole(
entityType: $entityType,
name: $name,
status: $status
) {
createdAt
domainUuid
entityType
name
status
updatedAt
uuid
}
}
Variables
{
"entityType": "DOMAIN",
"name": "abc123",
"status": "ACTIVATED"
}
Response
{
"data": {
"createRole": {
"createdAt": "2007-12-03T10:15:30Z",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "DOMAIN",
"name": "xyz789",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createRoleAssignment
Description
Creates a new RoleAssignment.
Response
Returns a RoleAssignment
Arguments
| Name | Description |
|---|---|
assigneeUuid - UUID!
|
The uuid of the assignee (User, Organization or Identity) to whom the Role is assigned. |
entityUuid - UUID!
|
The uuid of the entity (Domain, System) provided access to. |
roleUuid - UUID!
|
The uuid of the Role to assign. |
status - Status
|
The status of the RoleAssignment. |
Example
Query
mutation createRoleAssignment(
$assigneeUuid: UUID!,
$entityUuid: UUID!,
$roleUuid: UUID!,
$status: Status
) {
createRoleAssignment(
assigneeUuid: $assigneeUuid,
entityUuid: $entityUuid,
roleUuid: $roleUuid,
status: $status
) {
assignee {
... on MachineUser {
...MachineUserFragment
}
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
assigneeUuid
createdAt
entity {
... on Domain {
...DomainFragment
}
... on System {
...SystemFragment
}
}
entityUuid
role {
...RoleFragment
}
roleUuid
sources {
...PagedRoleAssignmentSourcesFragment
}
status
updatedAt
uuid
}
}
Variables
{
"assigneeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED"
}
Response
{
"data": {
"createRoleAssignment": {
"assignee": MachineUser,
"assigneeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"entity": Domain,
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"role": Role,
"roleUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sources": PagedRoleAssignmentSources,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createService
Description
Create a new Service based on the arguments provided. A Service can't be CREATED with status=ARCHIVED.
Response
Returns a Service
Arguments
| Name | Description |
|---|---|
code - String
|
Defines a human-readable identifier for the Service. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
Defines the name for a Service. |
status - Status
|
The status of the Service which can be ACTIVATED or DEACTIVATED. ARCHIVED is not allowed for newly created Services. |
Example
Query
mutation createService(
$code: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$status: Status
) {
createService(
code: $code,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status
) {
characteristics {
...PagedCharacteristicsFragment
}
code
componentModels {
...PagedComponentModelsFragment
}
components {
...PagedComponentsFragment
}
createdAt
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
status
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED"
}
Response
{
"data": {
"createService": {
"characteristics": PagedCharacteristics,
"code": "xyz789",
"componentModels": PagedComponentModels,
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createSetpointBlob
Description
Add Setpoints of type blob
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputBlob]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointBlob($setpoints: [SetpointInputBlob]!) {
createSetpointBlob(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputBlob]}
Response
{
"data": {
"createSetpointBlob": {"receiptIds": [ReceiptId]}
}
}
createSetpointBoolean
Description
Add Setpoints of type boolean
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputBoolean]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointBoolean($setpoints: [SetpointInputBoolean]!) {
createSetpointBoolean(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputBoolean]}
Response
{
"data": {
"createSetpointBoolean": {"receiptIds": [ReceiptId]}
}
}
createSetpointDate
Description
Add Setpoints of type date
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputDate]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointDate($setpoints: [SetpointInputDate]!) {
createSetpointDate(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputDate]}
Response
{
"data": {
"createSetpointDate": {"receiptIds": [ReceiptId]}
}
}
createSetpointFloat
Description
Add Setpoints of type float
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputFloat]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointFloat($setpoints: [SetpointInputFloat]!) {
createSetpointFloat(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputFloat]}
Response
{
"data": {
"createSetpointFloat": {"receiptIds": [ReceiptId]}
}
}
createSetpointInteger
Description
Add Setpoints of type integer
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputInteger]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointInteger($setpoints: [SetpointInputInteger]!) {
createSetpointInteger(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputInteger]}
Response
{
"data": {
"createSetpointInteger": {"receiptIds": [ReceiptId]}
}
}
createSetpointJson
Description
Add Setpoints of type json
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputJson]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointJson($setpoints: [SetpointInputJson]!) {
createSetpointJson(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputJson]}
Response
{
"data": {
"createSetpointJson": {"receiptIds": [ReceiptId]}
}
}
createSetpointSelect
Description
Add Setpoints of type select
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputSelect]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointSelect($setpoints: [SetpointInputSelect]!) {
createSetpointSelect(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputSelect]}
Response
{
"data": {
"createSetpointSelect": {"receiptIds": [ReceiptId]}
}
}
createSetpointString
Description
Add Setpoints of type string.
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputString]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointString($setpoints: [SetpointInputString]!) {
createSetpointString(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputString]}
Response
{
"data": {
"createSetpointString": {"receiptIds": [ReceiptId]}
}
}
createSetpointTime
Description
Add Setpoints of type time.
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputTime]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointTime($setpoints: [SetpointInputTime]!) {
createSetpointTime(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputTime]}
Response
{
"data": {
"createSetpointTime": {"receiptIds": [ReceiptId]}
}
}
createSetpointTimespan
Description
Add Setpoints of type date and timespan.
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputTimespan]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointTimespan($setpoints: [SetpointInputTimespan]!) {
createSetpointTimespan(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputTimespan]}
Response
{
"data": {
"createSetpointTimespan": {"receiptIds": [ReceiptId]}
}
}
createSetpointTimestamp
Description
Add Setpoints of type date and time.
Response
Returns a SetpointReceipts
Arguments
| Name | Description |
|---|---|
setpoints - [SetpointInputTimestamp]!
|
The Setpoints to add. |
Example
Query
mutation createSetpointTimestamp($setpoints: [SetpointInputTimestamp]!) {
createSetpointTimestamp(setpoints: $setpoints) {
receiptIds {
...ReceiptIdFragment
}
}
}
Variables
{"setpoints": [SetpointInputTimestamp]}
Response
{
"data": {
"createSetpointTimestamp": {"receiptIds": [ReceiptId]}
}
}
createSystem
Description
Creates a new System in DRIVR.
Response
Returns a System
Arguments
| Name | Description |
|---|---|
code - String!
|
The unique code of the System within all activated Systems belonging to the same Domain. |
description - String
|
The description of the System. |
locationUuid - UUID
|
The UUID of the Location where the System is located. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String!
|
The name of the System. |
ownerUuid - UUID
|
The UUID of the Account which owns the System. |
status - Status
|
The status of the System. |
Example
Query
mutation createSystem(
$code: String!,
$description: String,
$locationUuid: UUID,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String!,
$ownerUuid: UUID,
$status: Status
) {
createSystem(
code: $code,
description: $description,
locationUuid: $locationUuid,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
ownerUuid: $ownerUuid,
status: $status
) {
certificate {
...CertificateFragment
}
code
components {
...PagedComponentsFragment
}
connectionState
connectionStateUpdatedAt
createdAt
description
domain {
...DomainFragment
}
domainUuid
locationUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
owner {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
ownerUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
status
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"description": "xyz789",
"locationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED"
}
Response
{
"data": {
"createSystem": {
"certificate": Certificate,
"code": "abc123",
"components": PagedComponents,
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"locationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
createUser
Description
This endpoint is used to create a new User account in DRIVR. A User is typically created for an individual person who requires authorization to access the DRIVR API.
Response
Returns a User
Arguments
| Name | Description |
|---|---|
email - String
|
The email address of the User. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the User account. |
organizationUuid - UUID
|
The UUID of the Organization to which the User belongs. |
status - Status
|
The status of the User. Creation of a User with an ARCHIVED status is not allowed. |
Example
Query
mutation createUser(
$email: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$organizationUuid: UUID,
$status: Status
) {
createUser(
email: $email,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
organizationUuid: $organizationUuid,
status: $status
) {
createdAt
domain {
...DomainFragment
}
domainUuid
email
loginMethods {
...PagedLoginMethodsFragment
}
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
organization {
...OrganizationFragment
}
organizationUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
sources {
...PagedUserSourcesFragment
}
status
systems {
...PagedSystemsFragment
}
updatedAt
uuid
}
}
Variables
{
"email": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED"
}
Response
{
"data": {
"createUser": {
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"email": "abc123",
"loginMethods": PagedLoginMethods,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"organization": Organization,
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"sources": PagedUserSources,
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
deleteApplicationConsumer
Description
Delete an existing ApplicationConsumer. This mutation is used to remove an ApplicationConsumer from the system by specifying its UUID.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the ApplicationConsumer that needs to be deleted. |
Example
Query
mutation deleteApplicationConsumer($uuid: UUID!) {
deleteApplicationConsumer(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteApplicationConsumer": {"ok": Empty}}}
deleteAuthenticationMethod
Description
Delete a DomainAuthenticationMethod by a provided UUID. This operation can be used for AuthenticationMethods of all types.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the DomainAuthenticationMethod which should be deleted. |
Example
Query
mutation deleteAuthenticationMethod($uuid: UUID!) {
deleteAuthenticationMethod(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteAuthenticationMethod": {"ok": Empty}}}
deleteCertificate
Description
Delete a Certificate.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The uuid of the Certificate. |
Example
Query
mutation deleteCertificate($uuid: UUID!) {
deleteCertificate(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteCertificate": {"ok": Empty}}}
deleteCharacteristic
Description
Delete a Characteristic.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The uuid of the Characteristic. |
Example
Query
mutation deleteCharacteristic($uuid: UUID!) {
deleteCharacteristic(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteCharacteristic": {"ok": Empty}}}
deleteCharacteristicValidValue
Description
Delete a CharacteristicValidValue.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the CharacteristicValidValue. |
Example
Query
mutation deleteCharacteristicValidValue($uuid: UUID!) {
deleteCharacteristicValidValue(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"deleteCharacteristicValidValue": {"ok": Empty}
}
}
deleteComponent
Description
Deletes a Component and all its associated ComponentLinks.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Component to be deleted. |
Example
Query
mutation deleteComponent($uuid: UUID!) {
deleteComponent(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteComponent": {"ok": Empty}}}
deleteComponentModel
Description
This endpoint deletes an existing ComponentModel object by its UUID. Deletion of a ComponentModel will fail if it has associated Components.
Response
Returns an EmptyResult
Example
Query
mutation deleteComponentModel(
$force: Boolean,
$uuid: UUID!
) {
deleteComponentModel(
force: $force,
uuid: $uuid
) {
ok
}
}
Variables
{
"force": false,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteComponentModel": {"ok": Empty}}}
deleteDataSource
Description
Delete a DataSource by its UUID.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the DataSource to be deleted. |
Example
Query
mutation deleteDataSource($uuid: UUID!) {
deleteDataSource(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteDataSource": {"ok": Empty}}}
deleteEvent
Description
Deletes an Event from DRIVR given the UUID. When an Event is deleted, all its associated data is removed from DRIVR.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Event to be deleted. |
Example
Query
mutation deleteEvent($uuid: UUID!) {
deleteEvent(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteEvent": {"ok": Empty}}}
deleteEventModel
Description
Deletes an EventModel and all its Events and EventModelLinks. An EventModel can't be deleted if there are ACTIVATED or DEACTIVATED Event references.
Response
Returns an EmptyResult
Example
Query
mutation deleteEventModel(
$force: Boolean,
$uuid: UUID!
) {
deleteEventModel(
force: $force,
uuid: $uuid
) {
ok
}
}
Variables
{
"force": false,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteEventModel": {"ok": Empty}}}
deleteEventModelLink
Description
This endpoint deletes an existing EventModelLink.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the EventModelLink to be deleted. |
Example
Query
mutation deleteEventModelLink($uuid: UUID!) {
deleteEventModelLink(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteEventModelLink": {"ok": Empty}}}
deleteMachineUser
Description
Deletes the MachineUser with the provided uuid.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The uuid of the MachineUser to be deleted. |
Example
Query
mutation deleteMachineUser($uuid: UUID!) {
deleteMachineUser(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteMachineUser": {"ok": Empty}}}
deleteMetadataType
Description
Deletes a MetadataType.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the MetadataType to delete. |
Example
Query
mutation deleteMetadataType($uuid: UUID!) {
deleteMetadataType(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteMetadataType": {"ok": Empty}}}
deleteOrganization
Description
Deletes an Organization and all its associated user assignments. Cannot delete an Organization if it is the owner of a Domain.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The unique identifier of the Organization to be deleted. |
Example
Query
mutation deleteOrganization($uuid: UUID!) {
deleteOrganization(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteOrganization": {"ok": Empty}}}
deleteOrganizationSource
Description
Deletes an OrganizationSource. An OrganizationSource represents a link to another third party application and describes the unique ID of the Organization in that application.
Response
Returns an EmptyResult
Example
Query
mutation deleteOrganizationSource(
$dataSourceUuid: UUID!,
$organizationUuid: UUID!
) {
deleteOrganizationSource(
dataSourceUuid: $dataSourceUuid,
organizationUuid: $organizationUuid
) {
ok
}
}
Variables
{
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteOrganizationSource": {"ok": Empty}}}
deletePasswordLoginMethod
Description
Deletes the PasswordLoginMethod with the provided uuid.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The uuid of the PasswordLoginMethod to be deleted. |
Example
Query
mutation deletePasswordLoginMethod($uuid: UUID!) {
deletePasswordLoginMethod(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deletePasswordLoginMethod": {"ok": Empty}}}
deleteRole
Description
Deletes a specific Role.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Role to be deleted. |
Example
Query
mutation deleteRole($uuid: UUID!) {
deleteRole(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteRole": {"ok": Empty}}}
deleteRoleAssignment
Description
Deletes the specified RoleAssignment.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The uuid of the RoleAssignment to delete. |
Example
Query
mutation deleteRoleAssignment($uuid: UUID!) {
deleteRoleAssignment(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteRoleAssignment": {"ok": Empty}}}
deleteRoleAssignmentSource
Description
Deletes the specified RoleAssignment's association with the specified DataSource.
Response
Returns an EmptyResult
Example
Query
mutation deleteRoleAssignmentSource(
$dataSourceUuid: UUID!,
$roleAssignmentUuid: UUID!
) {
deleteRoleAssignmentSource(
dataSourceUuid: $dataSourceUuid,
roleAssignmentUuid: $roleAssignmentUuid
) {
ok
}
}
Variables
{
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignmentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteRoleAssignmentSource": {"ok": Empty}}}
deleteService
Description
Deletes a Service and all its dependencies like CharacteristicServiceLink and ServiceComponentModelLinks.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the Service. |
Example
Query
mutation deleteService($uuid: UUID!) {
deleteService(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteService": {"ok": Empty}}}
deleteSystem
Description
Deletes a System and all its Components and ComponentLinks in DRIVR.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the System to be deleted. |
Example
Query
mutation deleteSystem($uuid: UUID!) {
deleteSystem(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteSystem": {"ok": Empty}}}
deleteUser
Description
Irreversibly deletes a User. If the User is the owner of the Domain, they cannot be deleted.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
uuid - UUID!
|
The UUID of the User to delete. |
Example
Query
mutation deleteUser($uuid: UUID!) {
deleteUser(uuid: $uuid) {
ok
}
}
Variables
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteUser": {"ok": Empty}}}
deleteUserSource
Description
This is irreversible change. This endpoint is used to delete a UserSource associated with a specific User and a specific DataSource in DRIVR by UUID.
Response
Returns an EmptyResult
Example
Query
mutation deleteUserSource(
$dataSourceUuid: UUID!,
$userUuid: UUID!
) {
deleteUserSource(
dataSourceUuid: $dataSourceUuid,
userUuid: $userUuid
) {
ok
}
}
Variables
{
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{"data": {"deleteUserSource": {"ok": Empty}}}
removeCharacteristicFromService
Description
Remove a Characteristic from a Service. For each Service or Characteristic a code or uuid is required.
Response
Returns an EmptyResult
Example
Query
mutation removeCharacteristicFromService(
$characteristicCode: String,
$characteristicUuid: UUID,
$serviceCode: String,
$serviceUuid: UUID
) {
removeCharacteristicFromService(
characteristicCode: $characteristicCode,
characteristicUuid: $characteristicUuid,
serviceCode: $serviceCode,
serviceUuid: $serviceUuid
) {
ok
}
}
Variables
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"removeCharacteristicFromService": {"ok": Empty}
}
}
removeServiceFromComponentModel
Description
Removes a Service from a ComponentModel object.
Response
Returns an EmptyResult
Arguments
| Name | Description |
|---|---|
componentModelCode - String
|
The unique code of the ComponentModel object from which to remove the Service. |
componentModelUuid - UUID
|
The UUID of the ComponentModel object from which to remove the Service. |
index - Int
|
The index value of the Service to remove from the ComponentModel. |
serviceCode - String
|
The unique code of the Service to remove from the ComponentModel. |
serviceUuid - UUID
|
The UUID of the Service object to remove from the ComponentModel. |
Example
Query
mutation removeServiceFromComponentModel(
$componentModelCode: String,
$componentModelUuid: UUID,
$index: Int,
$serviceCode: String,
$serviceUuid: UUID
) {
removeServiceFromComponentModel(
componentModelCode: $componentModelCode,
componentModelUuid: $componentModelUuid,
index: $index,
serviceCode: $serviceCode,
serviceUuid: $serviceUuid
) {
ok
}
}
Variables
{
"componentModelCode": "xyz789",
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"index": 987,
"serviceCode": "xyz789",
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"removeServiceFromComponentModel": {"ok": Empty}
}
}
setOrganizationSource
Description
Creates a new OrganizationSource or updates an existing one.
Response
Returns an OrganizationSource
Arguments
| Name | Description |
|---|---|
dataSourceCode - String
|
The code of the DataSource associated with the Organization. |
dataSourceUuid - UUID
|
The unique identifier of the DataSource associated with the Organization. |
organizationUuid - UUID!
|
The unique identifier of the Organization that this source belongs to. |
sourceId - String!
|
The identifier of the Organization in the external system. |
Example
Query
mutation setOrganizationSource(
$dataSourceCode: String,
$dataSourceUuid: UUID,
$organizationUuid: UUID!,
$sourceId: String!
) {
setOrganizationSource(
dataSourceCode: $dataSourceCode,
dataSourceUuid: $dataSourceUuid,
organizationUuid: $organizationUuid,
sourceId: $sourceId
) {
createdAt
dataSource {
...DataSourceFragment
}
dataSourceUuid
domain {
...DomainFragment
}
domainUuid
organization {
...OrganizationFragment
}
organizationUuid
sourceId
updatedAt
uuid
}
}
Variables
{
"dataSourceCode": "abc123",
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sourceId": "xyz789"
}
Response
{
"data": {
"setOrganizationSource": {
"createdAt": "2007-12-03T10:15:30Z",
"dataSource": DataSource,
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"organization": Organization,
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sourceId": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
setRoleAssignmentSource
Description
Updates the specified RoleAssignment's associated DataSource.
Response
Returns a RoleAssignmentSource
Example
Query
mutation setRoleAssignmentSource(
$dataSourceCode: String,
$dataSourceUuid: UUID,
$roleAssignmentUuid: UUID!,
$sourceId: String!
) {
setRoleAssignmentSource(
dataSourceCode: $dataSourceCode,
dataSourceUuid: $dataSourceUuid,
roleAssignmentUuid: $roleAssignmentUuid,
sourceId: $sourceId
) {
createdAt
dataSource {
...DataSourceFragment
}
dataSourceUuid
domain {
...DomainFragment
}
domainUuid
roleAssignment {
...RoleAssignmentFragment
}
roleAssignmentUuid
sourceId
updatedAt
uuid
}
}
Variables
{
"dataSourceCode": "xyz789",
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignmentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sourceId": "abc123"
}
Response
{
"data": {
"setRoleAssignmentSource": {
"createdAt": "2007-12-03T10:15:30Z",
"dataSource": DataSource,
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignment": RoleAssignment,
"roleAssignmentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sourceId": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
setUserSource
Description
A UserSource connects a User inside DRIVR to a DataSource and stores the id the User has in the external System. The set-user-source API operation creates a new UserSource or updates an existing UserSource.
Response
Returns a UserSource
Example
Query
mutation setUserSource(
$dataSourceCode: String,
$dataSourceUuid: UUID,
$sourceId: String!,
$userUuid: UUID!
) {
setUserSource(
dataSourceCode: $dataSourceCode,
dataSourceUuid: $dataSourceUuid,
sourceId: $sourceId,
userUuid: $userUuid
) {
createdAt
dataSource {
...DataSourceFragment
}
dataSourceUuid
domain {
...DomainFragment
}
domainUuid
sourceId
updatedAt
user {
...UserFragment
}
userUuid
uuid
}
}
Variables
{
"dataSourceCode": "xyz789",
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sourceId": "xyz789",
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"setUserSource": {
"createdAt": "2007-12-03T10:15:30Z",
"dataSource": DataSource,
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sourceId": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateApplicationConsumer
Description
Update an existing ApplicationConsumer. If an ApplicationConsumer is archived, it cannot be updated. This mutation is used to modify the properties of an existing ApplicationConsumer.
Response
Returns an ApplicationConsumer
Arguments
| Name | Description |
|---|---|
defaultRedirectUri - String
|
If not explicitly set, it defaults to the first element in redirect_uris. |
grantTypes - [GrantType]
|
An ApplicationConsumer must have a list of grant_types with at least one entry. They represent how the application can authorize users against the API. |
name - String
|
The name of the ApplicationConsumer. |
noExplicitConsentRequired - Boolean
|
Attribute which verifies if Identity entities which use the Application needs to give explicit consent for API access. |
ownerUuid - UUID
|
The UUID of the Account which owns the ApplicationConsumer. |
redirectUris - [String]
|
The redirect_uris of the ApplicationConsumer. Must have at least one redirect_uris entry if the grant_type=AUTHORIZATION_CODE. Multiple entires are supported. |
scopes - [String]
|
An ApplicationConsumer must have at least one scopes entry. Multiple entires are supported and they indicate which scopes a certain ApplicationConsumer requires. |
secret - String
|
The secret of the ApplicationConsumer which is used for strengthened security guarantees for certain OAuth2 flows. |
slug - String
|
The slug of the ApplicationConsumer which must be unique within the Domain. This will be prepended to the Domain's hostname to create the consumer's identifier. |
status - Status
|
The status of the ApplicationConsumer. |
uuid - UUID!
|
The UUID of the ApplicationConsumer. |
Example
Query
mutation updateApplicationConsumer(
$defaultRedirectUri: String,
$grantTypes: [GrantType],
$name: String,
$noExplicitConsentRequired: Boolean,
$ownerUuid: UUID,
$redirectUris: [String],
$scopes: [String],
$secret: String,
$slug: String,
$status: Status,
$uuid: UUID!
) {
updateApplicationConsumer(
defaultRedirectUri: $defaultRedirectUri,
grantTypes: $grantTypes,
name: $name,
noExplicitConsentRequired: $noExplicitConsentRequired,
ownerUuid: $ownerUuid,
redirectUris: $redirectUris,
scopes: $scopes,
secret: $secret,
slug: $slug,
status: $status,
uuid: $uuid
) {
createdAt
defaultRedirectUri
domain {
...DomainFragment
}
domainUuid
grantTypes
identifier
name
noExplicitConsentRequired
owner {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
ownerUuid
redirectUris
scopes
secret
slug
status
updatedAt
uuid
}
}
Variables
{
"defaultRedirectUri": "xyz789",
"grantTypes": ["AUTHORIZATION_CODE"],
"name": "xyz789",
"noExplicitConsentRequired": false,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"redirectUris": ["abc123"],
"scopes": ["abc123"],
"secret": "abc123",
"slug": "abc123",
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateApplicationConsumer": {
"createdAt": "2007-12-03T10:15:30Z",
"defaultRedirectUri": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"grantTypes": ["AUTHORIZATION_CODE"],
"identifier": "xyz789",
"name": "abc123",
"noExplicitConsentRequired": true,
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"redirectUris": ["xyz789"],
"scopes": ["abc123"],
"secret": "abc123",
"slug": "abc123",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateAuthenticationMethod
Description
Update an existing DomainAuthenticationMethod by its UUID. This operation can be used for updating common fields on all DomainAuthenticationMethods types.
Response
Returns an AuthenticationMethod
Arguments
| Name | Description |
|---|---|
status - Status
|
The status of the DomainAuthenticationMethod which should be updated. Only one DomainAuthenticationMethod of the same configuration type can be ACTIVATED at a time. E.g. only one DomainAuthenticationMethod of type Azure AD can have an ACTIVATED status. Multiple DomainAuthenticationMethods of different configuration types can be ACTIVATED at the same time. |
uuid - UUID!
|
The UUID of the DomainAuthenticationMethod which should be updated. |
Example
Query
mutation updateAuthenticationMethod(
$status: Status,
$uuid: UUID!
) {
updateAuthenticationMethod(
status: $status,
uuid: $uuid
) {
... on AzureAuthenticationMethod {
...AzureAuthenticationMethodFragment
}
... on DefaultAuthenticationMethod {
...DefaultAuthenticationMethodFragment
}
... on GoogleAuthenticationMethod {
...GoogleAuthenticationMethodFragment
}
... on OpenIdDelegatedAuthenticationMethod {
...OpenIdDelegatedAuthenticationMethodFragment
}
}
}
Variables
{
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateAuthenticationMethod": AzureAuthenticationMethod
}
}
updateAzureAuthenticationMethod
Description
Update an existing DomainAuthenticationMethod which allows authentication with accounts from the Azure AD. Only one DomainAuthenticationMethod of this type can be ACTIVATED at a time.
Response
Returns an AzureAuthenticationMethod
Arguments
| Name | Description |
|---|---|
configuration - UpdateAzureAuthenticationMethodConfiguration
|
The updated configuration details which should be used to register DRIVR at the Azure Portal in order to allow Azure Accounts to authenticate themselves. |
status - Status
|
The status of the AzureDomainAuthenticationMethod which should be changed. |
uuid - UUID!
|
The UUID of the AzureDomainAuthenticationMethod to be updated. |
Example
Query
mutation updateAzureAuthenticationMethod(
$configuration: UpdateAzureAuthenticationMethodConfiguration,
$status: Status,
$uuid: UUID!
) {
updateAzureAuthenticationMethod(
configuration: $configuration,
status: $status,
uuid: $uuid
) {
authenticationType
configuration {
...AzureAuthenticationMethodConfigurationFragment
}
createdAt
domain {
...DomainFragment
}
domainUuid
status
updatedAt
uuid
}
}
Variables
{
"configuration": UpdateAzureAuthenticationMethodConfiguration,
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateAzureAuthenticationMethod": {
"authenticationType": "AZURE_AD",
"configuration": AzureAuthenticationMethodConfiguration,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCertificate
Description
Update a Certificate.
Response
Returns a Certificate
Arguments
| Name | Description |
|---|---|
csr - String
|
The csr for the Certificate as a base64 encoded string. |
duration - Timespan
|
The Certificate validity duration. Can not be a negative duration. |
name - String
|
The name for the Certificate. Has to be unique within the Domain. A Certificate name must not contain any special characters or white spaces. |
uuid - UUID!
|
The UUID of the Certificate to update. |
Example
Query
mutation updateCertificate(
$csr: String,
$duration: Timespan,
$name: String,
$uuid: UUID!
) {
updateCertificate(
csr: $csr,
duration: $duration,
name: $name,
uuid: $uuid
) {
certificate
createdAt
csr
domain {
...DomainFragment
}
domainUuid
duration
entity {
... on Component {
...ComponentFragment
}
... on System {
...SystemFragment
}
}
entityType
entityUuid
expiresAt
issuer {
...IssuerFragment
}
issuerUuid
name
updatedAt
uuid
}
}
Variables
{
"csr": "abc123",
"duration": Timespan,
"name": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCertificate": {
"certificate": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csr": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"duration": Timespan,
"entity": Component,
"entityType": "COMPONENT",
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"expiresAt": "2007-12-03T10:15:30Z",
"issuer": Issuer,
"issuerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristic
Description
Update a Characteristic. Archived Characteristic's can't be updated.
Response
Returns a Characteristic
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristic(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristic(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"symbol": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristic": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicBlob
Description
Update a blob Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicBlob
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicBlob(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicBlob(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"symbol": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicBlob": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicBoolean
Description
Update a boolean Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicBoolean
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicBoolean(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicBoolean(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicBoolean": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicDate
Description
Update a date Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicDate
Arguments
| Name | Description |
|---|---|
boundaryMax - Date
|
The upper boundary of allowed values. |
boundaryMin - Date
|
The lower boundary of allowed values. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicDate(
$boundaryMax: Date,
$boundaryMin: Date,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicDate(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
boundaryMax
boundaryMin
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": "2007-12-03",
"boundaryMin": "2007-12-03",
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicDate": {
"boundaryMax": "2007-12-03",
"boundaryMin": "2007-12-03",
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicFloat
Description
Update a float Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicFloat
Arguments
| Name | Description |
|---|---|
boundaryMax - Float
|
The upper boundary of allowed values. |
boundaryMin - Float
|
The lower boundary of allowed values. |
boundaryStep - Float
|
It represents the step size or increment value. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
precision - Int
|
The floating-point precision of values. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicFloat(
$boundaryMax: Float,
$boundaryMin: Float,
$boundaryStep: Float,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$precision: Int,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicFloat(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
boundaryStep: $boundaryStep,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
precision: $precision,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
boundaryMax
boundaryMin
boundaryStep
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
precision
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": 123.45,
"boundaryMin": 987.65,
"boundaryStep": 987.65,
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"precision": 123,
"status": "ACTIVATED",
"symbol": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicFloat": {
"boundaryMax": 987.65,
"boundaryMin": 987.65,
"boundaryStep": 123.45,
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"precision": 987,
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicInteger
Description
Update a integer Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicInteger
Arguments
| Name | Description |
|---|---|
boundaryMax - Int
|
The upper boundary of allowed values. |
boundaryMin - Int
|
The lower boundary of allowed values. |
boundaryStep - Int
|
It represents the step size or increment value. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicInteger(
$boundaryMax: Int,
$boundaryMin: Int,
$boundaryStep: Int,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicInteger(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
boundaryStep: $boundaryStep,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
boundaryMax
boundaryMin
boundaryStep
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": 123,
"boundaryMin": 987,
"boundaryStep": 123,
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"symbol": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicInteger": {
"boundaryMax": 987,
"boundaryMin": 987,
"boundaryStep": 987,
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicJson
Description
Update a JSON Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicJson
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
schema - String
|
JSON schema for valuepoints. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicJson(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$schema: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicJson(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
schema: $schema,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
schema
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"schema": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicJson": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"schema": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicSelect
Description
Update a SELECT Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicSelect
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
multiple - Boolean
|
Whether the SELECT Characteristic allows multiple options to be selected at the same time. |
name - String
|
The name of the Characteristic. |
options - [CharacteristicSelectOptionQuery]
|
List of options which can be selected on the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicSelect(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$multiple: Boolean,
$name: String,
$options: [CharacteristicSelectOptionQuery],
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicSelect(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
multiple: $multiple,
name: $name,
options: $options,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
multiple
name
options {
...CharacteristicSelectOptionFragment
}
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"multiple": true,
"name": "abc123",
"options": [CharacteristicSelectOptionQuery],
"status": "ACTIVATED",
"symbol": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicSelect": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"multiple": false,
"name": "xyz789",
"options": [CharacteristicSelectOption],
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicString
Description
Update a string Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicString
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
lengthMax - Int
|
The maximum length of allowed values. |
lengthMin - Int
|
The minimum length of allowed values. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicString(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$lengthMax: Int,
$lengthMin: Int,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicString(
characteristicType: $characteristicType,
code: $code,
description: $description,
lengthMax: $lengthMax,
lengthMin: $lengthMin,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
lengthMax
lengthMin
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"description": "abc123",
"lengthMax": 123,
"lengthMin": 123,
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicString": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"lengthMax": 987,
"lengthMin": 123,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicTime
Description
Update a time Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicTime
Arguments
| Name | Description |
|---|---|
boundaryMax - Time
|
The upper boundary of allowed values. |
boundaryMin - Time
|
The lower boundary of allowed values. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicTime(
$boundaryMax: Time,
$boundaryMin: Time,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicTime(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
boundaryMax
boundaryMin
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": "10:15:30Z",
"boundaryMin": "10:15:30Z",
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"symbol": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicTime": {
"boundaryMax": "10:15:30Z",
"boundaryMin": "10:15:30Z",
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicTimespan
Description
Update a timespan Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicTimespan
Arguments
| Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicTimespan(
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicTimespan(
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"characteristicType": "MEASUREMENT",
"code": "xyz789",
"description": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicTimespan": {
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicTimestamp
Description
Update a timestamp Characteristic. Archived Characteristic's can't be updated.
Response
Returns a CharacteristicTimestamp
Arguments
| Name | Description |
|---|---|
boundaryMax - DateTime
|
The upper boundary of allowed values. |
boundaryMin - DateTime
|
The lower boundary of allowed values. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
code - String
|
The Characteristic's code. |
description - String
|
The description of the Characteristic. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Characteristic. |
status - Status
|
The status of the Characteristic. |
symbol - String
|
The Characteristic's symbol. |
uuid - UUID!
|
The UUID of the Characteristic. |
Example
Query
mutation updateCharacteristicTimestamp(
$boundaryMax: DateTime,
$boundaryMin: DateTime,
$characteristicType: CharacteristicType,
$code: String,
$description: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$symbol: String,
$uuid: UUID!
) {
updateCharacteristicTimestamp(
boundaryMax: $boundaryMax,
boundaryMin: $boundaryMin,
characteristicType: $characteristicType,
code: $code,
description: $description,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
symbol: $symbol,
uuid: $uuid
) {
boundaryMax
boundaryMin
characteristicType
characteristicValidValues {
...PagedCharacteristicValidValuesFragment
}
code
components {
...PagedComponentsFragment
}
createdAt
dataType
description
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesFragment
}
status
symbol
updatedAt
uuid
}
}
Variables
{
"boundaryMax": "2007-12-03T10:15:30Z",
"boundaryMin": "2007-12-03T10:15:30Z",
"characteristicType": "MEASUREMENT",
"code": "abc123",
"description": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"symbol": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateCharacteristicTimestamp": {
"boundaryMax": "2007-12-03T10:15:30Z",
"boundaryMin": "2007-12-03T10:15:30Z",
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateCharacteristicValidValueBoolean
Description
Update an existing CharacteristicValidValue of type boolean. Archived CharacteristicValidValues cannot be updated.
Response
Returns a CharacteristicValidValueBoolean
Example
Query
mutation updateCharacteristicValidValueBoolean(
$description: String,
$uuid: UUID!,
$value: Boolean
) {
updateCharacteristicValidValueBoolean(
description: $description,
uuid: $uuid,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"description": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": false
}
Response
{
"data": {
"updateCharacteristicValidValueBoolean": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": true
}
}
}
updateCharacteristicValidValueFloat
Description
Update an existing CharacteristicValidValue of type float. Archived CharacteristicValidValues cannot be updated.
Response
Returns a CharacteristicValidValueFloat
Example
Query
mutation updateCharacteristicValidValueFloat(
$description: String,
$uuid: UUID!,
$value: Float
) {
updateCharacteristicValidValueFloat(
description: $description,
uuid: $uuid,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"description": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 123.45
}
Response
{
"data": {
"updateCharacteristicValidValueFloat": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987.65
}
}
}
updateCharacteristicValidValueInteger
Description
Update an existing CharacteristicValidValue of type integer. Archived CharacteristicValidValues cannot be updated.
Response
Returns a CharacteristicValidValueInteger
Example
Query
mutation updateCharacteristicValidValueInteger(
$description: String,
$uuid: UUID!,
$value: Int
) {
updateCharacteristicValidValueInteger(
description: $description,
uuid: $uuid,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"description": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 123
}
Response
{
"data": {
"updateCharacteristicValidValueInteger": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987
}
}
}
updateCharacteristicValidValueString
Description
Update an existing CharacteristicValidValue of type string. Archived CharacteristicValidValues cannot be updated.
Response
Returns a CharacteristicValidValueString
Example
Query
mutation updateCharacteristicValidValueString(
$description: String,
$uuid: UUID!,
$value: String
) {
updateCharacteristicValidValueString(
description: $description,
uuid: $uuid,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"description": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "xyz789"
}
Response
{
"data": {
"updateCharacteristicValidValueString": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "abc123"
}
}
}
updateCharacteristicValidValueTime
Description
Update an existing CharacteristicValidValue of type time. Archived CharacteristicValidValues cannot be updated.
Response
Returns a CharacteristicValidValueTime
Example
Query
mutation updateCharacteristicValidValueTime(
$description: String,
$uuid: UUID!,
$value: Time
) {
updateCharacteristicValidValueTime(
description: $description,
uuid: $uuid,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"description": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "10:15:30Z"
}
Response
{
"data": {
"updateCharacteristicValidValueTime": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "10:15:30Z"
}
}
}
updateCharacteristicValidValueTimespan
Description
Update an existing CharacteristicValidValue of type timespan. Archived CharacteristicValidValues cannot be updated.
Response
Returns a CharacteristicValidValueTimespan
Example
Query
mutation updateCharacteristicValidValueTimespan(
$description: String,
$uuid: UUID!,
$value: Timespan
) {
updateCharacteristicValidValueTimespan(
description: $description,
uuid: $uuid,
value: $value
) {
characteristic {
...CharacteristicFragment
}
characteristicUuid
createdAt
dataType
description
updatedAt
uuid
value
}
}
Variables
{
"description": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": Timespan
}
Response
{
"data": {
"updateCharacteristicValidValueTimespan": {
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": Timespan
}
}
}
updateComponent
Description
Update a Component. Archived Components cannot be updated.
Response
Returns a Component
Arguments
| Name | Description |
|---|---|
code - String
|
A human-readable identifier for the Component. |
connectionState - ComponentConnectionState
|
The connection state of the Component. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Component. |
status - Status
|
The status of the Component. |
uuid - UUID!
|
The UUID of the Component to update. |
Example
Query
mutation updateComponent(
$code: String,
$connectionState: ComponentConnectionState,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$uuid: UUID!
) {
updateComponent(
code: $code,
connectionState: $connectionState,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
uuid: $uuid
) {
certificate {
...CertificateFragment
}
characteristics {
...PagedCharacteristicsFragment
}
code
componentModel {
...ComponentModelFragment
}
componentModelUuid
connectionState
connectionStateUpdatedAt
createdAt
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesOnComponentFragment
}
status
system {
...SystemFragment
}
systemUuid
updatedAt
uuid
}
}
Variables
{
"code": "xyz789",
"connectionState": "CONNECTED",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateComponent": {
"certificate": Certificate,
"characteristics": PagedCharacteristics,
"code": "xyz789",
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServicesOnComponent,
"status": "ACTIVATED",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateComponentModel
Description
This endpoint updates an existing ComponentModel object by modifying its properties. Only non-archived ComponentModel can be updated.
Response
Returns a ComponentModel
Arguments
| Name | Description |
|---|---|
code - String
|
A human-readable identifier for the ComponentModel. |
componentType - ComponentType
|
The type of the ComponentModel. Values are restricted to the component-type enum. |
description - String
|
A description of the ComponentModel. |
isConnective - Boolean
|
A setting which allows instantiated Component to report their connection state. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the ComponentModel. |
status - Status
|
The status of the ComponentModel. Values are restricted to the status enum. |
uuid - UUID!
|
The UUID of the ComponentModel. |
Example
Query
mutation updateComponentModel(
$code: String,
$componentType: ComponentType,
$description: String,
$isConnective: Boolean,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$uuid: UUID!
) {
updateComponentModel(
code: $code,
componentType: $componentType,
description: $description,
isConnective: $isConnective,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
uuid: $uuid
) {
code
componentType
components {
...PagedComponentsFragment
}
createdAt
description
domain {
...DomainFragment
}
domainUuid
isConnective
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
services {
...PagedServicesOnComponentModelFragment
}
status
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"componentType": "DEVICE",
"description": "xyz789",
"isConnective": false,
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "xyz789",
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateComponentModel": {
"code": "xyz789",
"componentType": "DEVICE",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"isConnective": false,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServicesOnComponentModel,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateDataSource
Description
Update a DataSource by its UUID.
Response
Returns a DataSource
Example
Query
mutation updateDataSource(
$code: String,
$description: String,
$name: String,
$reference: String,
$uuid: UUID!
) {
updateDataSource(
code: $code,
description: $description,
name: $name,
reference: $reference,
uuid: $uuid
) {
code
createdAt
description
domain {
...DomainFragment
}
domainUuid
name
reference
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"description": "abc123",
"name": "abc123",
"reference": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateDataSource": {
"code": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "xyz789",
"reference": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateDefaultAuthenticationMethod
Description
Update an existing DomainAuthenticationMethod of type DEFAULT. This is used to enable or disable DRIVR's internal OAuth2 authentication and allows DRIVR User with a password to be authenticated. Only one DomainAuthenticationMethod of this type can be ACTIVATED at a time.
Response
Returns a DefaultAuthenticationMethod
Example
Query
mutation updateDefaultAuthenticationMethod(
$status: Status,
$uuid: UUID!
) {
updateDefaultAuthenticationMethod(
status: $status,
uuid: $uuid
) {
authenticationType
createdAt
domain {
...DomainFragment
}
domainUuid
status
updatedAt
uuid
}
}
Variables
{
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateDefaultAuthenticationMethod": {
"authenticationType": "AZURE_AD",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateDomainFeature
Description
Update the setting of a DomainFeature by a given slug.
Response
Returns a DomainFeature
Arguments
| Name | Description |
|---|---|
enabled - Boolean
|
Set this value to true if the DomainFeature should be enabled or false if it should be disabled. |
slug - DomainFeatureSlug!
|
Provide the slug of the DomainFeature to be updated. |
Example
Query
mutation updateDomainFeature(
$enabled: Boolean,
$slug: DomainFeatureSlug!
) {
updateDomainFeature(
enabled: $enabled,
slug: $slug
) {
domain {
...DomainFragment
}
domainUuid
enabled
slug
}
}
Variables
{"enabled": true, "slug": "DELETE_ARCHIVE_ORGANIZATION_USERS"}
Response
{
"data": {
"updateDomainFeature": {
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"enabled": true,
"slug": "DELETE_ARCHIVE_ORGANIZATION_USERS"
}
}
}
updateEvent
Description
Updates an Event within DRIVR, given its UUID and start and end timestamps. Events associated with archived entities cannot be modified.
Response
Returns an Event
Arguments
| Name | Description |
|---|---|
endTime - DateTime
|
The end date and time for the Event. If not passed, the current timestamp is used. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
time - DateTime
|
The start date and time for the Event. If not passed, the current timestamp is used. |
uuid - UUID!
|
The UUID of the Event to be updated. |
Example
Query
mutation updateEvent(
$endTime: DateTime,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$time: DateTime,
$uuid: UUID!
) {
updateEvent(
endTime: $endTime,
metadataKeyValueStore: $metadataKeyValueStore,
time: $time,
uuid: $uuid
) {
acknowledged
acks {
...PagedEventAcksFragment
}
createdAt
endTime
entity {
... on Component {
...ComponentFragment
}
... on System {
...SystemFragment
}
}
entityUuid
eventModel {
...EventModelFragment
}
eventModelUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
status
time
updatedAt
uuid
}
}
Variables
{
"endTime": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"time": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateEvent": {
"acknowledged": false,
"acks": PagedEventAcks,
"createdAt": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"entity": Component,
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"eventModel": EventModel,
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"status": "ACTIVE",
"time": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateEventModel
Description
Update an EventModel within DRIVR. EventModels which have a status ARCHIVED can't be updated.
Response
Returns an EventModel
Arguments
| Name | Description |
|---|---|
code - String
|
Defines a human-readable identifier for the EventModel. |
eventLevel - EventLevel
|
The event level of the EventModel. |
eventType - EventType
|
Describes the type of DRIVR entity an Event can correspond to e.g. Component or System |
limitToPrototypes - Boolean
|
Whether Events may be emitted for all instances of a specific entity type or only certain DRIVR Entity prototypes (e.g. whether an Event can be emitted for all Components or only for Components that correspond to certain ComponentModels). This can be set by creating EventModelLinks. Can't be true if entity type is System. |
message - String
|
An optional message which can provide more detail about the derived Events. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
status - Status
|
The status of the EventModel which can be ACTIVATED, DEACTIVATED, or ARCHIVED. Updating an EventModel to ARCHIVED is irreversible and does not allow further updates of this entity. |
uuid - UUID!
|
The UUID of the EventModel which should be altered. |
Example
Query
mutation updateEventModel(
$code: String,
$eventLevel: EventLevel,
$eventType: EventType,
$limitToPrototypes: Boolean,
$message: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$status: Status,
$uuid: UUID!
) {
updateEventModel(
code: $code,
eventLevel: $eventLevel,
eventType: $eventType,
limitToPrototypes: $limitToPrototypes,
message: $message,
metadataKeyValueStore: $metadataKeyValueStore,
status: $status,
uuid: $uuid
) {
code
createdAt
domain {
...DomainFragment
}
domainUuid
entityType
eventLevel
eventModelLinks {
...PagedEventModelLinksFragment
}
eventType
limitToPrototypes
message
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
status
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"eventLevel": "ERROR",
"eventType": "RANGED",
"limitToPrototypes": false,
"message": "xyz789",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateEventModel": {
"code": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "COMPONENT",
"eventLevel": "ERROR",
"eventModelLinks": PagedEventModelLinks,
"eventType": "RANGED",
"limitToPrototypes": true,
"message": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePair],
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateEventModelLink
Description
This endpoint updates an existing EventModelLink, provided it is not archived.
Response
Returns an EventModelLink
Example
Query
mutation updateEventModelLink(
$status: Status,
$uuid: UUID!
) {
updateEventModelLink(
status: $status,
uuid: $uuid
) {
createdAt
eventModel {
...EventModelFragment
}
eventModelUuid
prototype {
... on ComponentModel {
...ComponentModelFragment
}
}
prototypeUuid
status
updatedAt
uuid
}
}
Variables
{
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateEventModelLink": {
"createdAt": "2007-12-03T10:15:30Z",
"eventModel": EventModel,
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"prototype": ComponentModel,
"prototypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateGoogleAuthenticationMethod
Description
Update an existing DomainAuthenticationMethod which allows authentication with Google Accounts. Only one DomainAuthenticationMethod of this type can be ACTIVATED at a time.
Response
Returns a GoogleAuthenticationMethod
Arguments
| Name | Description |
|---|---|
configuration - UpdateGoogleAuthenticationMethodConfiguration
|
The configuration of the DomainAuthenticationMethod for Google Account authentication. |
status - Status
|
The status of the DomainAuthenticationMethod. |
uuid - UUID!
|
The UUID of DomainAuthenticationMethod for authenticating with Google Accounts. |
Example
Query
mutation updateGoogleAuthenticationMethod(
$configuration: UpdateGoogleAuthenticationMethodConfiguration,
$status: Status,
$uuid: UUID!
) {
updateGoogleAuthenticationMethod(
configuration: $configuration,
status: $status,
uuid: $uuid
) {
authenticationType
configuration {
...GoogleAuthenticationMethodConfigurationFragment
}
createdAt
domain {
...DomainFragment
}
domainUuid
status
updatedAt
uuid
}
}
Variables
{
"configuration": UpdateGoogleAuthenticationMethodConfiguration,
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateGoogleAuthenticationMethod": {
"authenticationType": "AZURE_AD",
"configuration": GoogleAuthenticationMethodConfiguration,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateMachineUser
Description
Updates the MachineUser with the provided uuid.
Response
Returns a MachineUser
Arguments
| Name | Description |
|---|---|
password - String
|
The updated password of the MachineUser. This is used to login to DRIVR with the machine user's rights. Will not be modified if kept empty. |
status - Status
|
The status of the MachineUser. Will not be modified if kept empty. |
username - String
|
The updated name of the MachineUser. This is used to login to DRIVR with the machine user's rights. Will not be modified if kept empty. |
uuid - UUID!
|
The uuid of the MachineUser to be updated. |
Example
Query
mutation updateMachineUser(
$password: String,
$status: Status,
$username: String,
$uuid: UUID!
) {
updateMachineUser(
password: $password,
status: $status,
username: $username,
uuid: $uuid
) {
createdAt
domain {
...DomainFragment
}
domainUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
status
updatedAt
username
uuid
}
}
Variables
{
"password": "xyz789",
"status": "ACTIVATED",
"username": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateMachineUser": {
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"username": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateMetadataTypeBoolean
Description
Update a Boolean MetadataType.
Response
Returns a MetadataTypeBoolean
Arguments
| Name | Description |
|---|---|
default - Boolean
|
The default value for this metadata field |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
uuid - UUID!
|
The uuid of the metadata type which should be updated |
Example
Query
mutation updateMetadataTypeBoolean(
$default: Boolean,
$description: String,
$entityType: MetadataTypeEntityTypes,
$key: String,
$uuid: UUID!
) {
updateMetadataTypeBoolean(
default: $default,
description: $description,
entityType: $entityType,
key: $key,
uuid: $uuid
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
updatedAt
uuid
}
}
Variables
{
"default": true,
"description": "abc123",
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateMetadataTypeBoolean": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": false,
"description": "abc123",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateMetadataTypeFloat
Description
Update a Float MetadataType.
Response
Returns a MetadataTypeFloat
Arguments
| Name | Description |
|---|---|
default - Float
|
The default value for this metadata field |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
uuid - UUID!
|
The uuid of the metadata type which should be updated |
Example
Query
mutation updateMetadataTypeFloat(
$default: Float,
$description: String,
$entityType: MetadataTypeEntityTypes,
$key: String,
$uuid: UUID!
) {
updateMetadataTypeFloat(
default: $default,
description: $description,
entityType: $entityType,
key: $key,
uuid: $uuid
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
updatedAt
uuid
}
}
Variables
{
"default": 123.45,
"description": "xyz789",
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateMetadataTypeFloat": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": 123.45,
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateMetadataTypeInteger
Description
Update an Integer MetadataType.
Response
Returns a MetadataTypeInteger
Arguments
| Name | Description |
|---|---|
default - Int
|
The default value for this metadata field |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
unique - Boolean
|
Specifies the individual value within the entities of this metadata type to must be unique. |
uuid - UUID!
|
The uuid of the metadata type which should be updated |
Example
Query
mutation updateMetadataTypeInteger(
$default: Int,
$description: String,
$entityType: MetadataTypeEntityTypes,
$key: String,
$unique: Boolean,
$uuid: UUID!
) {
updateMetadataTypeInteger(
default: $default,
description: $description,
entityType: $entityType,
key: $key,
unique: $unique,
uuid: $uuid
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
unique
updatedAt
uuid
}
}
Variables
{
"default": 987,
"description": "abc123",
"entityType": "CHARACTERISTIC",
"key": "abc123",
"unique": true,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateMetadataTypeInteger": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": 987,
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"unique": true,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateMetadataTypeString
Description
Update a String MetadataType.
Response
Returns a MetadataTypeString
Arguments
| Name | Description |
|---|---|
default - String
|
The default value for this metadata field |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
unique - Boolean
|
Specifies the individual value within the entities of this metadata type to must be unique. |
uuid - UUID!
|
The uuid of the metadata type which should be updated |
Example
Query
mutation updateMetadataTypeString(
$default: String,
$description: String,
$entityType: MetadataTypeEntityTypes,
$key: String,
$unique: Boolean,
$uuid: UUID!
) {
updateMetadataTypeString(
default: $default,
description: $description,
entityType: $entityType,
key: $key,
unique: $unique,
uuid: $uuid
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
unique
updatedAt
uuid
}
}
Variables
{
"default": "abc123",
"description": "abc123",
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"unique": true,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateMetadataTypeString": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": "xyz789",
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"unique": false,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateMetadataTypeTimestamp
Description
Update a Timestamp MetadataType.
Response
Returns a MetadataTypeTimestamp
Arguments
| Name | Description |
|---|---|
default - DateTime
|
The default value for this metadata field |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
uuid - UUID!
|
The uuid of the metadata type which should be updated |
Example
Query
mutation updateMetadataTypeTimestamp(
$default: DateTime,
$description: String,
$entityType: MetadataTypeEntityTypes,
$key: String,
$uuid: UUID!
) {
updateMetadataTypeTimestamp(
default: $default,
description: $description,
entityType: $entityType,
key: $key,
uuid: $uuid
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
updatedAt
uuid
}
}
Variables
{
"default": "2007-12-03T10:15:30Z",
"description": "xyz789",
"entityType": "CHARACTERISTIC",
"key": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateMetadataTypeTimestamp": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": "2007-12-03T10:15:30Z",
"description": "abc123",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateMetadataTypeUuid
Description
Update a UUID MetadataType.
Response
Returns a MetadataTypeUuid
Arguments
| Name | Description |
|---|---|
default - UUID
|
The default value for this metadata field |
description - String
|
The description of the field this metadata type represents. |
entityType - MetadataTypeEntityTypes
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
uuid - UUID!
|
The uuid of the metadata type which should be updated |
Example
Query
mutation updateMetadataTypeUuid(
$default: UUID,
$description: String,
$entityType: MetadataTypeEntityTypes,
$key: String,
$uuid: UUID!
) {
updateMetadataTypeUuid(
default: $default,
description: $description,
entityType: $entityType,
key: $key,
uuid: $uuid
) {
createdAt
dataType
default
description
distinctValues {
...PagedDistinctMetadataValuesFragment
}
entityType
key
updatedAt
uuid
}
}
Variables
{
"default": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "abc123",
"entityType": "CHARACTERISTIC",
"key": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateMetadataTypeUuid": {
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateOpenIdDelegatedAuthenticationMethod
Description
Update an existing OpenID Bearer token delegation DomainAuthenticationMethod. Only one DomainAuthenticationMethod of this type can be ACTIVATED at a time.
Response
Returns an OpenIdDelegatedAuthenticationMethod
Arguments
| Name | Description |
|---|---|
configuration - UpdateOpenIdDelegatedAuthenticationMethodConfiguration
|
The updated configuration of the OpenID Bearer token delegation DomainAuthenticationMethod. |
status - Status
|
The new status of the OpenID Bearer token delegation DomainAuthenticationMethod. |
uuid - UUID!
|
The UUID of the OpenID Bearer token delegation DomainAuthenticationMethod which should be updated. |
Example
Query
mutation updateOpenIdDelegatedAuthenticationMethod(
$configuration: UpdateOpenIdDelegatedAuthenticationMethodConfiguration,
$status: Status,
$uuid: UUID!
) {
updateOpenIdDelegatedAuthenticationMethod(
configuration: $configuration,
status: $status,
uuid: $uuid
) {
authenticationType
configuration {
...OpenIdDelegatedAuthenticationMethodConfigurationFragment
}
createdAt
domain {
...DomainFragment
}
domainUuid
status
updatedAt
uuid
}
}
Variables
{
"configuration": UpdateOpenIdDelegatedAuthenticationMethodConfiguration,
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateOpenIdDelegatedAuthenticationMethod": {
"authenticationType": "AZURE_AD",
"configuration": OpenIdDelegatedAuthenticationMethodConfiguration,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateOrganization
Description
Updates an Organization. Archived Organizations cannot be updated.
Response
Returns an Organization
Arguments
| Name | Description |
|---|---|
alias - String
|
The alias of the Organization. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Organization. |
ownerUuid - UUID
|
The UUID of the User which owns the entity. |
status - Status
|
The status of the Organization. |
uuid - UUID!
|
The UUID of the Organization. |
Example
Query
mutation updateOrganization(
$alias: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$ownerUuid: UUID,
$status: Status,
$uuid: UUID!
) {
updateOrganization(
alias: $alias,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
ownerUuid: $ownerUuid,
status: $status,
uuid: $uuid
) {
alias
createdAt
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
owner {
...UserFragment
}
ownerUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
sources {
...PagedOrganizationSourcesFragment
}
status
systems {
...PagedSystemsFragment
}
updatedAt
users {
...PagedUsersFragment
}
uuid
}
}
Variables
{
"alias": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateOrganization": {
"alias": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"owner": User,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"sources": PagedOrganizationSources,
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"users": PagedUsers,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updatePasswordLoginMethod
Description
Updates the PasswordLoginMethod with the provided uuid.
Response
Returns a PasswordLoginMethod
Arguments
| Name | Description |
|---|---|
password - String!
|
The password of the PasswordLoginMethod to be created. This is used to login to DRIVR with the password login user's rights. |
username - String!
|
The name of the PasswordLoginMethod to be created. This is used to login to DRIVR with the password login user's rights. |
uuid - UUID!
|
The uuid of the PasswordLoginMethod to be updated. |
Example
Query
mutation updatePasswordLoginMethod(
$password: String!,
$username: String!,
$uuid: UUID!
) {
updatePasswordLoginMethod(
password: $password,
username: $username,
uuid: $uuid
) {
createdAt
domain {
...DomainFragment
}
domainAuthenticationMethod {
... on AzureAuthenticationMethod {
...AzureAuthenticationMethodFragment
}
... on DefaultAuthenticationMethod {
...DefaultAuthenticationMethodFragment
}
... on GoogleAuthenticationMethod {
...GoogleAuthenticationMethodFragment
}
... on OpenIdDelegatedAuthenticationMethod {
...OpenIdDelegatedAuthenticationMethodFragment
}
}
domainAuthenticationMethodUuid
domainUuid
type
updatedAt
user {
...UserFragment
}
userUuid
username
uuid
}
}
Variables
{
"password": "abc123",
"username": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updatePasswordLoginMethod": {
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainAuthenticationMethod": AzureAuthenticationMethod,
"domainAuthenticationMethodUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "OAUTH_AZURE",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"username": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateRole
Description
Updates a specific Role. An archived Role cannot be updated.
Response
Returns a Role
Arguments
| Name | Description |
|---|---|
entityType - RoleEntityType
|
The type of the entity that the Role pertains to. |
name - String
|
The name of the Role. |
status - Status
|
The status of the Role. |
uuid - UUID!
|
The UUID of the Role to be updated. |
Example
Query
mutation updateRole(
$entityType: RoleEntityType,
$name: String,
$status: Status,
$uuid: UUID!
) {
updateRole(
entityType: $entityType,
name: $name,
status: $status,
uuid: $uuid
) {
createdAt
domainUuid
entityType
name
status
updatedAt
uuid
}
}
Variables
{
"entityType": "DOMAIN",
"name": "abc123",
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateRole": {
"createdAt": "2007-12-03T10:15:30Z",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "DOMAIN",
"name": "xyz789",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateRoleAssignment
Description
Updates the selected RoleAssignment
Response
Returns a RoleAssignment
Example
Query
mutation updateRoleAssignment(
$entityUuid: UUID,
$roleUuid: UUID,
$status: Status,
$uuid: UUID!
) {
updateRoleAssignment(
entityUuid: $entityUuid,
roleUuid: $roleUuid,
status: $status,
uuid: $uuid
) {
assignee {
... on MachineUser {
...MachineUserFragment
}
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
assigneeUuid
createdAt
entity {
... on Domain {
...DomainFragment
}
... on System {
...SystemFragment
}
}
entityUuid
role {
...RoleFragment
}
roleUuid
sources {
...PagedRoleAssignmentSourcesFragment
}
status
updatedAt
uuid
}
}
Variables
{
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateRoleAssignment": {
"assignee": MachineUser,
"assigneeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"entity": Domain,
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"role": Role,
"roleUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sources": PagedRoleAssignmentSources,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateService
Description
This endpoint updates a Service. Archived Service can't be updated.
Response
Returns a Service
Arguments
| Name | Description |
|---|---|
code - String
|
The code of the Service. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the Service. |
status - Status
|
The status of the Service can be updated to ACTIVATED, DEACTIVATED or ARCHIVED. |
uuid - UUID!
|
The UUID of the Service. |
Example
Query
mutation updateService(
$code: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$status: Status,
$uuid: UUID!
) {
updateService(
code: $code,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
status: $status,
uuid: $uuid
) {
characteristics {
...PagedCharacteristicsFragment
}
code
componentModels {
...PagedComponentModelsFragment
}
components {
...PagedComponentsFragment
}
createdAt
domain {
...DomainFragment
}
domainUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
status
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateService": {
"characteristics": PagedCharacteristics,
"code": "xyz789",
"componentModels": PagedComponentModels,
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateSystem
Description
Update a System in DRIVR. Archived Systems cannot be updated.
Response
Returns a System
Arguments
| Name | Description |
|---|---|
code - String
|
The code of the System. |
description - String
|
The description of the System. |
locationUuid - UUID
|
The UUID of the Location where the System is located. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the System. |
ownerUuid - UUID
|
The UUID of the Entity which owns the System. |
status - Status
|
The status of the System. |
uuid - UUID!
|
The UUID of the System. |
Example
Query
mutation updateSystem(
$code: String,
$description: String,
$locationUuid: UUID,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$ownerUuid: UUID,
$status: Status,
$uuid: UUID!
) {
updateSystem(
code: $code,
description: $description,
locationUuid: $locationUuid,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
ownerUuid: $ownerUuid,
status: $status,
uuid: $uuid
) {
certificate {
...CertificateFragment
}
code
components {
...PagedComponentsFragment
}
connectionState
connectionStateUpdatedAt
createdAt
description
domain {
...DomainFragment
}
domainUuid
locationUuid
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
owner {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
ownerUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
status
updatedAt
uuid
}
}
Variables
{
"code": "abc123",
"description": "xyz789",
"locationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateSystem": {
"certificate": Certificate,
"code": "xyz789",
"components": PagedComponents,
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"locationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
updateUser
Description
This endpoint is used to update an existing User in DRIVR by its UUID. The User must not be in an ARCHIVED state.
Response
Returns a User
Arguments
| Name | Description |
|---|---|
email - String
|
The email address of the User. |
metadataKeyValueStore - [MetadataKeyValuePairInput]
|
The metadata key-value pair to set. |
name - String
|
The name of the User. |
organizationUuid - UUID
|
The UUID of the Organization to which the User belongs. |
status - Status
|
The current status of the User account, which can be either ACTIVATED, DEACTIVATED, or ARCHIVED. Updating a User to ARCHIVED is irreversible. |
uuid - UUID!
|
The UUID of the User whose account you wish to update. |
Example
Query
mutation updateUser(
$email: String,
$metadataKeyValueStore: [MetadataKeyValuePairInput],
$name: String,
$organizationUuid: UUID,
$status: Status,
$uuid: UUID!
) {
updateUser(
email: $email,
metadataKeyValueStore: $metadataKeyValueStore,
name: $name,
organizationUuid: $organizationUuid,
status: $status,
uuid: $uuid
) {
createdAt
domain {
...DomainFragment
}
domainUuid
email
loginMethods {
...PagedLoginMethodsFragment
}
metadataKeyValueStore {
...MetadataKeyValuePairFragment
}
name
organization {
...OrganizationFragment
}
organizationUuid
roleAssignments {
...PagedRoleAssignmentsFragment
}
sources {
...PagedUserSourcesFragment
}
status
systems {
...PagedSystemsFragment
}
updatedAt
uuid
}
}
Variables
{
"email": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePairInput],
"name": "abc123",
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Response
{
"data": {
"updateUser": {
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"email": "abc123",
"loginMethods": PagedLoginMethods,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"organization": Organization,
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"sources": PagedUserSources,
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
}
}
Types
Account
Description
An account represents either an Organization or a User within DRIVR.
Types
| Union Types |
|---|
Example
Organization
AggregateValueField
Fields
| Input Field | Description |
|---|---|
blob - BlobAggregates
|
|
boolean - BooleanAggregates
|
|
count - IntQueryField
|
|
date - DateAggregates
|
|
float - FloatAggregates
|
|
integer - IntegerAggregates
|
|
string - StringAggregates
|
|
time - TimeAggregates
|
|
timespan - TimespanAggregates
|
|
timestamp - TimestampAggregates
|
Example
{
"blob": BlobAggregates,
"boolean": BooleanAggregates,
"count": IntQueryField,
"date": DateAggregates,
"float": FloatAggregates,
"integer": IntegerAggregates,
"string": StringAggregates,
"time": TimeAggregates,
"timespan": TimespanAggregates,
"timestamp": TimestampAggregates
}
AggregatedDatapoint
Description
An AggregatedDatapoint is an aggregation of datapoints of a single type. It provides access to type-dependant computed fields of the aggregation.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 123,
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointBlob
Description
An AggregatedDatapoint of type blob.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
first - String
|
The earliest datapoint in the aggregation. |
last - String
|
The latest datapoint in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 123,
"first": "abc123",
"last": "xyz789",
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointBoolean
Description
An AggregatedDatapoint of type boolean.
Fields
| Field Name | Description |
|---|---|
avg - Float
|
The average of datapoints in the aggregation. |
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
first - Boolean
|
The earliest datapoint in the aggregation. |
last - Boolean
|
The latest datapoint in the aggregation. |
max - Boolean
|
The maximal datapoint in the aggregation. |
min - Boolean
|
The minimal datapoint in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
sum - Int
|
The sum of datapoints in the aggregation. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"avg": 987.65,
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 987,
"first": true,
"last": false,
"max": false,
"min": false,
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sum": 123,
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointDate
Description
An AggregatedDatapoint of type date.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
first - Date
|
The earliest datapoint in the aggregation. |
last - Date
|
The latest datapoint in the aggregation. |
max - Date
|
The maximal datapoint in the aggregation. |
min - Date
|
The minimal datapoint in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 987,
"first": "2007-12-03",
"last": "2007-12-03",
"max": "2007-12-03",
"min": "2007-12-03",
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointFloat
Description
An AggregatedDatapoint of type float.
Fields
| Field Name | Description |
|---|---|
avg - Float
|
The average of datapoints in the aggregation. |
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
first - Float
|
The earliest datapoint in the aggregation. |
last - Float
|
The latest datapoint in the aggregation. |
max - Float
|
The maximal datapoint in the aggregation. |
min - Float
|
The minimal datapoint in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
sum - Float
|
The sum of datapoints in the aggregation. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"avg": 123.45,
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 123,
"first": 123.45,
"last": 987.65,
"max": 123.45,
"min": 987.65,
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sum": 123.45,
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointGroup
Description
The entity type which aggregated datapoints are grouped by.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHARACTERISTIC"
AggregatedDatapointInteger
Description
An AggregatedDatapoint of type integer.
Fields
| Field Name | Description |
|---|---|
avg - Float
|
The average of datapoints in the aggregation. |
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
first - Int
|
The earliest datapoint in the aggregation. |
last - Int
|
The latest datapoint in the aggregation. |
max - Int
|
The maximal datapoint in the aggregation. |
min - Int
|
The minimal datapoint in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
sum - Int
|
The sum of datapoints in the aggregation. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"avg": 987.65,
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 123,
"first": 123,
"last": 123,
"max": 987,
"min": 123,
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sum": 123,
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointString
Description
An AggregatedDatapoint of type string.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
first - String
|
The earliest datapoint in the aggregation. |
last - String
|
The latest datapoint in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 987,
"first": "xyz789",
"last": "xyz789",
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointTime
Description
An AggregatedDatapoint of type time.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
first - Time
|
The earliest datapoint in the aggregation. |
last - Time
|
The latest datapoint in the aggregation. |
max - Time
|
The maximal datapoint in the aggregation. |
min - Time
|
The minimal datapoint in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 123,
"first": "10:15:30Z",
"last": "10:15:30Z",
"max": "10:15:30Z",
"min": "10:15:30Z",
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointTimespan
Description
An AggregatedDatapoint of type timespan.
Fields
| Field Name | Description |
|---|---|
avg - Timespan
|
The average of datapoints in the aggregation. |
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
first - Timespan
|
The earliest datapoint in the aggregation. |
last - Timespan
|
The latest datapoint in the aggregation. |
max - Timespan
|
The maximal datapoint in the aggregation. |
min - Timespan
|
The minimal datapoint in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
sum - Timespan
|
The sum of datapoints in the aggregation. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"avg": Timespan,
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 123,
"first": Timespan,
"last": Timespan,
"max": Timespan,
"min": Timespan,
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sum": Timespan,
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointTimestamp
Description
An AggregatedDatapoint of type timestamp.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic
|
The entity's Characteristic. |
characteristicUuid - UUID
|
The UUID of the entity's Characteristic. |
component - Component
|
The entity's Component. |
componentModel - ComponentModel
|
The entity's ComponentModel. |
componentModelUuid - UUID
|
The UUID of the entity's ComponentModel. |
componentUuid - UUID
|
The UUID of the entity's Component. |
count - Int!
|
The number of datapoints in the aggregation. |
first - DateTime
|
The earliest datapoint in the aggregation. |
last - DateTime
|
The latest datapoint in the aggregation. |
max - DateTime
|
The maximal datapoint in the aggregation. |
min - DateTime
|
The minimal datapoint in the aggregation. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
system - System
|
The entity's System. |
systemUuid - UUID
|
The UUID of the entity's System. |
time - DateTime
|
|
timeStream - TimeStream
|
The entity's TimeStream. |
timeStreamUuid - UUID
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of the AggregatedDatapoint. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"count": 987,
"first": "2007-12-03T10:15:30Z",
"last": "2007-12-03T10:15:30Z",
"max": "2007-12-03T10:15:30Z",
"min": "2007-12-03T10:15:30Z",
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB"
}
AggregatedDatapointsWhereQuery
Description
AggregatedDatapointsWhereQuery provides complex filter over AggregatedDatapoints
Fields
| Input Field | Description |
|---|---|
_and - [AggregatedDatapointsWhereQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [AggregatedDatapointsWhereQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
|
characteristicUuid - UuidQueryField
|
Filter by Characteristic UUID. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
componentModelUuid - UuidQueryField
|
Filter by ComponentModel UUID. |
componentUuid - UuidQueryField
|
Filter by Component UUID. |
domainUuid - UuidQueryField
|
Filter by Domain UUID. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
grid - Timespan
|
The timespan based chunk size by which datapoints are aggregated. Requires from and to to be set. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service & ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
Filter by Service UUID. |
system - NestedSystemQuery
|
|
systemUuid - UuidQueryField
|
Filter by System UUID. |
timeStream - NestedTimeStreamQuery
|
|
timeStreamUuid - UuidQueryField
|
Filter by TimeStream UUID. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
value - AggregateValueField
|
Example
{
"_and": [AggregatedDatapointsWhereQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [AggregatedDatapointsWhereQuery],
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"componentModelUuid": UuidQueryField,
"componentUuid": UuidQueryField,
"domainUuid": UuidQueryField,
"from": "2007-12-03T10:15:30Z",
"grid": Timespan,
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"system": NestedSystemQuery,
"systemUuid": UuidQueryField,
"timeStream": NestedTimeStreamQuery,
"timeStreamUuid": UuidQueryField,
"to": "2007-12-03T10:15:30Z",
"value": AggregateValueField
}
AggregatedEvent
Description
A aggregation result for an aggregation query.
Fields
| Field Name | Description |
|---|---|
groupingEntity - AggregatedEventGroupingEntity
|
The entity which this aggregation item is grouped by. |
sum - Int!
|
The amount of items in this group. |
Example
{"groupingEntity": Component, "sum": 987}
AggregatedEventGroupingEntity
Description
All possible entities which an event aggregation can be grouped by.
Types
| Union Types |
|---|
Example
Component
AggregatedEventGroupingEntityType
Description
The entity type by which Events are aggregated for reporting purposes. This enumeration specifies the entity types that are allowed for aggregation.
Values
| Enum Value | Description |
|---|---|
|
|
Group events by the Component |
|
|
Group the events by the ComponentModel of the attached Components |
|
|
Group events by the EventModel |
|
|
Group events by EventModel codes |
|
|
Group events by the System |
Example
"COMPONENT"
AggregatedEventOrderByQuery
Description
Sorting and ordering options for AggregatedEvents.
Fields
| Input Field | Description |
|---|---|
grouping - OrderByDirection
|
Order AggregatedEvent by grouping field. |
sum - OrderByDirection
|
Order AggregatedEvent by sum field. |
Example
{"grouping": "ASC", "sum": "ASC"}
AggregatedEventQuery
Description
The AggregatedEventQuery is a WHERE query that allows you to specify filtersfor retrieving aggregated Event objects based on their attributes.
Fields
| Input Field | Description |
|---|---|
_and - [AggregatedEventQuery]
|
All passed queries must match |
_or - [AggregatedEventQuery]
|
One of the passed entities must match |
acknowledged - BoolQueryField
|
Filter by the acknowledged status of the Event. |
component - NestedComponentQuery
|
Filters that can be used to filter and retrieve Component associated with the Event. |
createdAt - DateTimeQueryField
|
|
endTime - DateTimeQueryField
|
Filter by the end time of the Event. |
entity - EventEntities
|
|
entityUuid - UuidQueryField
|
Filter by the UUID of the entity associated with the Event. |
eventModel - NestedEventModelQuery
|
Filters that can be used to filter and retrieve EventModel associated with the Event. |
eventType - EventTypeQueryField
|
Filter by the type of the Event. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
status - EventStatusQueryField
|
Filter by the status of the Event. |
system - NestedSystemQuery
|
Filters that can be used to filter and retrieve System associated with the Event. It does not matter if the Event is directly connected to the System or to a Component which is connected to the System. This query will resolve both. |
time - DateTimeQueryField
|
Filter by the start time of the Event. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the Event. |
Example
{
"_and": [AggregatedEventQuery],
"_or": [AggregatedEventQuery],
"acknowledged": BoolQueryField,
"component": NestedComponentQuery,
"createdAt": DateTimeQueryField,
"endTime": DateTimeQueryField,
"entity": EventEntities,
"entityUuid": UuidQueryField,
"eventModel": NestedEventModelQuery,
"eventType": EventTypeQueryField,
"from": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"status": EventStatusQueryField,
"system": NestedSystemQuery,
"time": DateTimeQueryField,
"to": "2007-12-03T10:15:30Z",
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
ApplicationConsumer
Description
An ApplicationConsumer represents an application that uses DRIVR to authenticate users against the API. This node manages the security of OAuth2 flows.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
defaultRedirectUri - String
|
If not explicitly set, this field defaults to the first element in redirect_uris. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
grantTypes - [GrantType!]!
|
A list of grant_types for the ApplicationConsumer that specifies how it can authorize users against the API. The supported grant types are AUTHORIZATION_CODE, REFRESH_TOKEN, and PASSWORD. Must contain at least one entry. |
identifier - String!
|
The identifier used for the client. This is generated on creation and consists of the Domain hostname and the slug. The format is slug.application-consumer.oem.drivr.cloud. If multiple host_names are defined on a Domain, the identifier uses the first host_name in the array. If no host_names are defined, the name of the domain is used. |
name - String!
|
A non-unique, human-readable identifier for the ApplicationConsumer. |
noExplicitConsentRequired - Boolean
|
If true, then explicit consent is not required for Identity entities using the ApplicationConsumer to access the API. |
owner - Account
|
The Account which owns the entity. |
ownerUuid - UUID
|
The UUID of the Account which owns the entity. |
redirectUris - [String!]
|
The redirect_uris of the ApplicationConsumer. Must have at least one entry if the grant_type is AUTHORIZATION_CODE. Multiple entries are supported. |
scopes - [String!]!
|
A list of scopes that an ApplicationConsumer requires. Must contain at least one entry. |
secret - String
|
The secret of the ApplicationConsumer that can be used to strengthen security guarantees for certain OAuth2 flows. |
slug - String!
|
A unique, human and machine-readable identifier for the ApplicationConsumer. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"defaultRedirectUri": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"grantTypes": ["AUTHORIZATION_CODE"],
"identifier": "abc123",
"name": "abc123",
"noExplicitConsentRequired": false,
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"redirectUris": ["xyz789"],
"scopes": ["abc123"],
"secret": "xyz789",
"slug": "abc123",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
ApplicationConsumerOrderByQuery
Description
Sorting and ordering options for ApplicationConsumers.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
|
defaultRedirectUri - OrderByDirection
|
Order ApplicationConsumer by default_redirect_uri field. |
identifier - OrderByDirection
|
Order ApplicationConsumer by identifier field. |
name - OrderByDirection
|
Order ApplicationConsumer by name field. |
noExplicitConsentRequired - OrderByDirection
|
Order ApplicationConsumer by no_explicit_consent_required field. |
ownerUuid - OrderByDirection
|
Order ApplicationConsumer by uuid field of associated owner. |
secret - OrderByDirection
|
Order ApplicationConsumer by secret field. |
slug - OrderByDirection
|
Order ApplicationConsumer by slug field. |
status - OrderByDirection
|
|
updatedAt - OrderByDirection
|
|
uuid - OrderByDirection
|
Example
{
"createdAt": "ASC",
"defaultRedirectUri": "ASC",
"identifier": "ASC",
"name": "ASC",
"noExplicitConsentRequired": "ASC",
"ownerUuid": "ASC",
"secret": "ASC",
"slug": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
ApplicationConsumerQuery
Description
ApplicationConsumerQuery provides complex filter over ApplicationConsumers
Fields
| Input Field | Description |
|---|---|
_and - [ApplicationConsumerQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ApplicationConsumerQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
defaultRedirectUri - StringQueryField
|
Filter by default_redirect_uri of the ApplicationConsumer. |
identifier - StringQueryField
|
Filter by identifier of the ApplicationConsumer. |
name - StringQueryField
|
Filter by name of the ApplicationConsumer. |
noExplicitConsentRequired - BoolQueryField
|
Filter by no_explicit_consent_required of the ApplicationConsumer. |
owner - ResourceOwners
|
|
ownerUuid - UuidQueryField
|
Filter by owner UUID associated with the ApplicationConsumer. |
secret - StringQueryField
|
Filter by secret of the ApplicationConsumer. |
slug - StringQueryField
|
Filter by slug of the ApplicationConsumer. |
status - StatusQueryField
|
Filter by status of the ApplicationConsumer. |
updatedAt - DateTimeQueryField
|
Example
{
"_and": [ApplicationConsumerQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ApplicationConsumerQuery],
"createdAt": DateTimeQueryField,
"defaultRedirectUri": StringQueryField,
"identifier": StringQueryField,
"name": StringQueryField,
"noExplicitConsentRequired": BoolQueryField,
"owner": ResourceOwners,
"ownerUuid": UuidQueryField,
"secret": StringQueryField,
"slug": StringQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField
}
AuthenticationMethod
Description
Returns the different types of DomainAuthenticationMethods within DRIVR.
Example
AzureAuthenticationMethod
AzureAuthenticationMethod
Description
DomainAuthenticationMethod for authenticating against Azure's AD service.
Fields
| Field Name | Description |
|---|---|
authenticationType - DomainAuthenticationMethod
|
The type of authentication method. |
configuration - AzureAuthenticationMethodConfiguration
|
Configuration options for authentication DRIVR against the Azure AD service. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"authenticationType": "AZURE_AD",
"configuration": AzureAuthenticationMethodConfiguration,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
AzureAuthenticationMethodConfiguration
Description
Configuration options for Azure's AD service.
Example
{
"clientId": "abc123",
"clientSecret": "xyz789",
"tenant": "abc123"
}
AzureLoginMethod
Description
A LoginMethod is a method of authentication that a User can use to authenticate against DRIVR. This indicates the User to be able to authenticate against an Azure AD OAuth Server.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainAuthenticationMethod - AuthenticationMethod
|
The entity's DomainAuthenticationMethod. |
domainAuthenticationMethodUuid - UUID
|
The UUID of the entity's DomainAuthenticationMethod. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
externalId - String
|
The ID the entity is known for on the referenced third party system. |
preferredUsername - String
|
The username which is the name indicated by another OAuth server the user should ideally have. |
type - LoginMethod
|
The login method type of the entity. Describes the type of authentication which can be used with this Entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
user - User
|
The User linked to the entity. This field provides more information about the User linked to the entity. |
userUuid - UUID
|
The UUID of the User linked to the entity. This is usually the owner or person who created the entity. They also could have been assigned to it after creation by another User. |
username - String
|
The name of the User used for login against DRIVR. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainAuthenticationMethod": AzureAuthenticationMethod,
"domainAuthenticationMethodUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"externalId": "abc123",
"preferredUsername": "xyz789",
"type": "OAUTH_AZURE",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"username": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
BaseLoginMethod
Description
The interface representing any LoginMethod the User has to authenticate against DRIVR.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainAuthenticationMethod - AuthenticationMethod
|
The entity's DomainAuthenticationMethod. |
domainAuthenticationMethodUuid - UUID
|
The UUID of the entity's DomainAuthenticationMethod. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
type - LoginMethod
|
The login method type of the entity. Describes the type of authentication which can be used with this Entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
user - User
|
The User linked to the entity. This field provides more information about the User linked to the entity. |
userUuid - UUID
|
The UUID of the User linked to the entity. This is usually the owner or person who created the entity. They also could have been assigned to it after creation by another User. |
username - String
|
The name of the User used for login against DRIVR. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Possible Types
| BaseLoginMethod Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainAuthenticationMethod": AzureAuthenticationMethod,
"domainAuthenticationMethodUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "OAUTH_AZURE",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"username": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
BlobAggregates
Fields
| Input Field | Description |
|---|---|
count - IntQueryField
|
|
first - BlobQueryField
|
|
last - BlobQueryField
|
Example
{
"count": IntQueryField,
"first": BlobQueryField,
"last": BlobQueryField
}
BlobQueryField
Description
Apply the filter operation to Blob value.
Example
{
"_eq": "abc123",
"_in": ["abc123"],
"_neq": "abc123",
"_nin": ["xyz789"],
"_null": true
}
BoolQueryField
Description
Apply the filter operation to Boolean value.
Example
{"_eq": false, "_in": [true], "_neq": false, "_nin": [true], "_null": false}
Boolean
Description
The Boolean scalar type represents true or false.
BooleanAggregates
Fields
| Input Field | Description |
|---|---|
avg - FloatQueryField
|
|
count - IntQueryField
|
|
first - BoolQueryField
|
|
last - BoolQueryField
|
|
max - FloatQueryField
|
|
min - FloatQueryField
|
|
sum - IntQueryField
|
Example
{
"avg": FloatQueryField,
"count": IntQueryField,
"first": BoolQueryField,
"last": BoolQueryField,
"max": FloatQueryField,
"min": FloatQueryField,
"sum": IntQueryField
}
Certificate
Description
A Certificate is a digital document that is issued by a trusted entity called a Certificate Authority (CA) (see: Issuer). It serves as a form of identification and is used to verify the authenticity and integrity of a device (System or Component) against the DRIVR MQTT Broker and enables secure communication.
Fields
| Field Name | Description |
|---|---|
certificate - String
|
The certificate for this Certificate as a base64 encoded string. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
csr - String!
|
The Certificate csr (certificate signing request) as a base64 encoded string. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
duration - Timespan
|
The Certificate validity duration. |
entity - CertificateEntity!
|
The Certificate's Entity. |
entityType - CertificateEntityType!
|
Describes the type of DRIVR entity an Certificate corresponds to e.g. Component or System |
entityUuid - UUID!
|
The UUID of the Certificate's Entity. |
expiresAt - DateTime
|
The Certificate expiration time. |
issuer - Issuer!
|
The Certificate's Issuer. |
issuerUuid - UUID!
|
The UUID of the Certificate's Issuer. |
name - String!
|
The unique name of the Certificate. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"certificate": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csr": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"duration": Timespan,
"entity": Component,
"entityType": "COMPONENT",
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"expiresAt": "2007-12-03T10:15:30Z",
"issuer": Issuer,
"issuerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CertificateEntities
Fields
| Input Field | Description |
|---|---|
component - NestedComponentQuery
|
Filters that can be used to filter and retrieve Component associated with the Certificate. |
system - NestedSystemQuery
|
Filters that can be used to filter and retrieve System associated with the Certificate. |
Example
{
"component": NestedComponentQuery,
"system": NestedSystemQuery
}
CertificateEntity
CertificateEntityType
Description
The type of entity associated with the Certificate.
Values
| Enum Value | Description |
|---|---|
|
|
A Component of DRIVR the Certificate is used for. |
|
|
A System of DRIVR the Certificate is used for. |
Example
"COMPONENT"
CertificateEntityTypeQueryField
Description
Apply the filter operation to certificate-entity-type value.
Fields
| Input Field | Description |
|---|---|
_eq - CertificateEntityType
|
Equals |
_in - [CertificateEntityType]
|
Is in the list |
_neq - CertificateEntityType
|
Does NOT equal |
_nin - [CertificateEntityType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "COMPONENT",
"_in": ["COMPONENT"],
"_neq": "COMPONENT",
"_nin": ["COMPONENT"],
"_null": false
}
CertificateOrderByQuery
Description
Defines the fields by which Certificates can be ordered.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
Order Certificate by createdAt field. |
entityType - OrderByDirection
|
Order Certificate by entityType field. |
entityUuid - OrderByDirection
|
Order Certificate by uuid field of associated entity. |
expiresAt - OrderByDirection
|
Order Certificate by expiresAt field. |
issuerUuid - OrderByDirection
|
Order Certificate by uuid field of associated issuer. |
name - OrderByDirection
|
Order Certificate by name field. |
updatedAt - OrderByDirection
|
Order Certificate by updatedAt field. |
uuid - OrderByDirection
|
Order Certificate by uuid field. |
Example
{
"createdAt": "ASC",
"entityType": "ASC",
"entityUuid": "ASC",
"expiresAt": "ASC",
"issuerUuid": "ASC",
"name": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
CertificateQuery
Description
Retrieves matching Certificates based on specified criteria.
Fields
| Input Field | Description |
|---|---|
_and - [CertificateQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [CertificateQuery]
|
One of the passed entities must match |
certificate - StringQueryField
|
The actual base64 encoded certificate of the Certificate. |
createdAt - DateTimeQueryField
|
|
csr - StringQueryField
|
The base64 encoded CSR of the Certificate. |
duration - TimespanQueryField
|
The duration of the Certificate. |
entity - CertificateEntities
|
|
entityType - CertificateEntityTypeQueryField
|
The entity type of the Certificate. |
expiresAt - DateTimeQueryField
|
The expiration date of the Certificate. |
issuer - NestedIssuerQuery
|
The issuer of the Certificate. |
name - StringQueryField
|
The name of the Certificate. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the Certificate. |
Example
{
"_and": [CertificateQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [CertificateQuery],
"certificate": StringQueryField,
"createdAt": DateTimeQueryField,
"csr": StringQueryField,
"duration": TimespanQueryField,
"entity": CertificateEntities,
"entityType": CertificateEntityTypeQueryField,
"expiresAt": DateTimeQueryField,
"issuer": NestedIssuerQuery,
"name": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
Characteristic
Description
A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicBlob
Description
A Characteristic of a Service of type blob. Blob types store binary data, in GraphQL sent via Base64 encoded strings. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicBoolean
Description
A Characteristic of a Service of type boolean. A boolean value is a binary switch / state. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicDataType
Description
The data type associated with a Characteristic.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BLOB"
CharacteristicDataTypeQueryField
Description
Apply the filter operation to characteristic-data-type value.
Fields
| Input Field | Description |
|---|---|
_eq - CharacteristicDataType
|
Equals |
_in - [CharacteristicDataType]
|
Is in the list |
_neq - CharacteristicDataType
|
Does NOT equal |
_nin - [CharacteristicDataType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "BLOB",
"_in": ["BLOB"],
"_neq": "BLOB",
"_nin": ["BLOB"],
"_null": false
}
CharacteristicDate
Description
A Characteristic of a Service of type date. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
boundaryMax - Date
|
The upper boundary of allowed values. |
boundaryMin - Date
|
The lower boundary of allowed values. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"boundaryMax": "2007-12-03",
"boundaryMin": "2007-12-03",
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicFloat
Description
A Characteristic of a Service of type float. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
boundaryMax - Float
|
The upper boundary of allowed values. |
boundaryMin - Float
|
The lower boundary of allowed values. |
boundaryStep - Float
|
It represents the step size or increment value. If 'boundary_step' is defined, the 'value' for datapoint or setpoint should be multiple of it. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
precision - Int
|
The floating-point precision of values. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"boundaryMax": 987.65,
"boundaryMin": 987.65,
"boundaryStep": 987.65,
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"precision": 987,
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicInteger
Description
A Characteristic of a Service of type integer. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
boundaryMax - Int
|
The upper boundary of allowed values. |
boundaryMin - Int
|
The lower boundary of allowed values. |
boundaryStep - Int
|
It represents the step size or increment value. If 'boundary_step' is defined, the 'value' for datapoint or setpoint should be multiple of it. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"boundaryMax": 987,
"boundaryMin": 123,
"boundaryStep": 123,
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicJson
Description
A Characteristic of a Service of type JSON. A JSON Characteristic can have a schema which validates the sent Setpoints or Datapoints to comply to the specific schema. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
schema - String
|
JSON schema for valuepoints. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"schema": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicOrderByQuery
Description
Defines the sorting order for Characteristic's
Fields
| Input Field | Description |
|---|---|
characteristicType - OrderByDirection
|
Order Characteristic by characteristicType field. |
code - OrderByDirection
|
Order Characteristic by code field. |
createdAt - OrderByDirection
|
Order Characteristic by createdAt field. |
dataType - OrderByDirection
|
Order Characteristic by dataType field. |
description - OrderByDirection
|
Order Characteristic by description field. |
multiple - OrderByDirection
|
|
name - OrderByDirection
|
Order Characteristic by name field. |
schema - OrderByDirection
|
Order Characteristic by schema field. |
status - OrderByDirection
|
Order Characteristic by status field. |
symbol - OrderByDirection
|
Order Characteristic by symbol field. |
updatedAt - OrderByDirection
|
Order Characteristic by updatedAt field. |
uuid - OrderByDirection
|
Order Characteristic by uuid field. |
Example
{
"characteristicType": "ASC",
"code": "ASC",
"createdAt": "ASC",
"dataType": "ASC",
"description": "ASC",
"multiple": "ASC",
"name": "ASC",
"schema": "ASC",
"status": "ASC",
"symbol": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
CharacteristicQuery
Description
CharacteristicQuery provides complex filters over Characteristic's
Fields
| Input Field | Description |
|---|---|
_and - [CharacteristicQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [CharacteristicQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by aggregated DataPoints. |
characteristicType - CharacteristicTypeQueryField
|
Filter by characteristic_type. |
code - StringQueryField
|
Filter by code. |
component - NestedComponentQuery
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by current DataPoints. |
dataType - CharacteristicDataTypeQueryField
|
Filter by data_type. |
datapoints - NestedDatapointsWhereQuery
|
Filter by DataPoints. |
description - StringQueryField
|
Filter by description. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
multiple - BoolQueryField
|
Filter by multiple. |
name - StringQueryField
|
Filter by name. |
service - NestedServiceQuery
|
|
status - StatusQueryField
|
Filter by status. |
symbol - StringQueryField
|
Filter by symbol. |
timeStreams - NestedTimeStreamQuery
|
Filter by TimeStream. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [CharacteristicQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [CharacteristicQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristicType": CharacteristicTypeQueryField,
"code": StringQueryField,
"component": NestedComponentQuery,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"dataType": CharacteristicDataTypeQueryField,
"datapoints": NestedDatapointsWhereQuery,
"description": StringQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"multiple": BoolQueryField,
"name": StringQueryField,
"service": NestedServiceQuery,
"status": StatusQueryField,
"symbol": StringQueryField,
"timeStreams": NestedTimeStreamQuery,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
CharacteristicSelect
Description
A Characteristic of a Service of type SELECT. A SELECT field has multiple options which the Datapoints in a Characteristic can have. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
multiple - Boolean
|
Whether the SELECT Characteristic allows multiple options to be selected at the same time. |
name - String!
|
A human-readable name representing the entity. |
options - [CharacteristicSelectOption!]
|
List of options which can be selected on the Characteristic. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"multiple": true,
"name": "xyz789",
"options": [CharacteristicSelectOption],
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicSelectMeta
CharacteristicSelectMetaQuery
CharacteristicSelectOption
Description
An option to select Characteristic's by.
Fields
| Field Name | Description |
|---|---|
id - Int
|
The option's autogenerated, serial ID. |
key - String
|
The option's key. |
label - String
|
A descriptive label for the option. |
meta - [CharacteristicSelectMeta!]
|
Additional key-value information. |
Example
{
"id": 123,
"key": "abc123",
"label": "xyz789",
"meta": [CharacteristicSelectMeta]
}
CharacteristicSelectOptionQuery
Fields
| Input Field | Description |
|---|---|
key - String!
|
The option's key. |
label - String!
|
A descriptive label for the option. |
meta - [CharacteristicSelectMetaQuery]
|
Additional metadata in the form of key-value pairs. |
Example
{
"key": "abc123",
"label": "abc123",
"meta": [CharacteristicSelectMetaQuery]
}
CharacteristicServiceLink
Description
A link between a Service and a Characteristic.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicString
Description
A Characteristic of a Service of type string. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
lengthMax - Int
|
The maximum length of allowed values. |
lengthMin - Int
|
The minimum length of allowed values. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"lengthMax": 987,
"lengthMin": 987,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicTime
Description
A Characteristic of a Service of type time. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
boundaryMax - Time
|
The upper boundary of allowed values. |
boundaryMin - Time
|
The lower boundary of allowed values. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"boundaryMax": "10:15:30Z",
"boundaryMin": "10:15:30Z",
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicTimespan
Description
A Characteristic of a Service of type timespan. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicTimestamp
Description
A Characteristic of a Service of type timestamp. A Characteristic can be attached to one or multiple Services via the addCharacteristicToService mutation. In DRIVR, a Characteristic models a specific measurement or setting which is sent and received from connected devices. Characteristics of type MEASUREMENT describe things like temperature, current voltage or open/closed status of a window. Characteristics of type SETTING describe target values / user-changeable values like target temperature, a virtual switch or a dial. SETTING Characteristics can be changed with Setpoints. The current set state from the connected Devices is sent via Datapoints. MEASUREMENTs only receive DataPoints. Characteristics can be used to model DataPoints which can track and monitor the performance of Components and Systems.
Fields
| Field Name | Description |
|---|---|
boundaryMax - DateTime
|
The upper boundary of allowed values. |
boundaryMin - DateTime
|
The lower boundary of allowed values. |
characteristicType - CharacteristicType
|
The type of the Characteristic. |
characteristicValidValues - PagedCharacteristicValidValues!
|
A paged list of valid values for the Characteristic. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A paged list of Components linked to the Characteristic. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
A human-readable name representing the entity. |
services - PagedServices!
|
A paged list of Services linked to the Characteristic. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
symbol - String
|
The symbol associated with the Characteristic. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"boundaryMax": "2007-12-03T10:15:30Z",
"boundaryMin": "2007-12-03T10:15:30Z",
"characteristicType": "MEASUREMENT",
"characteristicValidValues": PagedCharacteristicValidValues,
"code": "xyz789",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"services": PagedServices,
"status": "ACTIVATED",
"symbol": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicType
Description
The type of a Characteristic.
Values
| Enum Value | Description |
|---|---|
|
|
A value sent from a device. |
|
|
A value sent to a device. |
Example
"MEASUREMENT"
CharacteristicTypeQueryField
Description
Apply the filter operation to characteristic-type value.
Fields
| Input Field | Description |
|---|---|
_eq - CharacteristicType
|
Equals |
_in - [CharacteristicType]
|
Is in the list |
_neq - CharacteristicType
|
Does NOT equal |
_nin - [CharacteristicType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "MEASUREMENT",
"_in": ["MEASUREMENT"],
"_neq": "MEASUREMENT",
"_nin": ["MEASUREMENT"],
"_null": false
}
CharacteristicValidValue
Description
A valid value definition for a Characteristic.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Possible Types
| CharacteristicValidValue Types |
|---|
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
CharacteristicValidValueBoolean
Description
A valid value definition for a Characteristic of type boolean.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
value - Boolean!
|
The boolean value representing the valid data for the associated Characteristic instance. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": false
}
CharacteristicValidValueFloat
Description
A valid value definition for a Characteristic of type float.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
value - Float!
|
The float value representing the valid data for the associated Characteristic instance. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987.65
}
CharacteristicValidValueInteger
Description
A valid value definition for a Characteristic of type integer.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
value - Int!
|
The integer value representing the valid data for the associated Characteristic instance. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 123
}
CharacteristicValidValueOrderByQuery
Description
Defines the fields by which CharacteristicValidValue can be ordered.
Fields
| Input Field | Description |
|---|---|
characteristicUuid - OrderByDirection
|
Orders CharacteristicValidValues by UUID of the associated Characteristic entity. |
createdAt - OrderByDirection
|
Orders CharacteristicValidValues by their creation time. |
dataType - OrderByDirection
|
Orders CharacteristicValidValues by their data type. |
description - OrderByDirection
|
Orders CharacteristicValidValues by their description. |
updatedAt - OrderByDirection
|
Orders CharacteristicValidValues by their update time. |
uuid - OrderByDirection
|
Orders CharacteristicValidValues by their UUID. |
value - OrderByDirection
|
Orders CharacteristicValidValues by their value. |
Example
{
"characteristicUuid": "ASC",
"createdAt": "ASC",
"dataType": "ASC",
"description": "ASC",
"updatedAt": "ASC",
"uuid": "ASC",
"value": "ASC"
}
CharacteristicValidValueString
Description
A valid value definition for a Characteristic of type string.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
value - String!
|
The string value representing the valid data for the associated Characteristic instance. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "xyz789"
}
CharacteristicValidValueTime
Description
A valid value definition for a Characteristic of type time.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
value - Time!
|
The timestamp value representing the valid data for the associated Characteristic instance. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "10:15:30Z"
}
CharacteristicValidValueTimespan
Description
A valid value definition for a Characteristic of type timespan.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - CharacteristicDataType!
|
The data type associated with the entity. |
description - String
|
A description of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
value - Timespan!
|
The timespan/duration value representing the valid data for the associated Characteristic instance. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BLOB",
"description": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": Timespan
}
Component
Description
A single Component belonging to a System. Examples of components are devices, gateways, modules, parts or virtual devices. Components can form ComponentLinks and therefore contain other Components, or have connective or logical links to other Components.
Fields
| Field Name | Description |
|---|---|
certificate - Certificate
|
The entity's Certificate. |
characteristics - PagedCharacteristics!
|
A list of Characteristics linked to the Component. |
Arguments
|
|
code - String!
|
A human-readable identifier for the Component. |
componentModel - ComponentModel!
|
The entity's ComponentModel. |
componentModelUuid - UUID!
|
The UUID of the entity's ComponentModel. |
connectionState - ComponentConnectionState!
|
The connection state of the Component. |
connectionStateUpdatedAt - DateTime
|
The time when the connection state has been set. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String
|
The name of the Component. |
services - PagedServicesOnComponent!
|
A list of Services linked to the Component. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
system - System!
|
The entity's System. |
systemUuid - UUID!
|
The UUID of the entity's System. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"certificate": Certificate,
"characteristics": PagedCharacteristics,
"code": "abc123",
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServicesOnComponent,
"status": "ACTIVATED",
"system": System,
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
ComponentConnectionState
Description
The connection states that a Component can be in.
Values
| Enum Value | Description |
|---|---|
|
|
The device has an active connection to DRIVR. |
|
|
The device has been disconnected from DRIVR. |
|
|
The device does not support reporting its connection state. |
|
|
The connection state for this device is unknown. |
Example
"CONNECTED"
ComponentConnectionStateQueryField
Description
Apply the filter operation to component-connection-state value.
Fields
| Input Field | Description |
|---|---|
_eq - ComponentConnectionState
|
Equals |
_in - [ComponentConnectionState]
|
Is in the list |
_neq - ComponentConnectionState
|
Does NOT equal |
_nin - [ComponentConnectionState]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "CONNECTED",
"_in": ["CONNECTED"],
"_neq": "CONNECTED",
"_nin": ["CONNECTED"],
"_null": false
}
ComponentModel
Description
A ComponentModel serves as a template for a Component.
Fields
| Field Name | Description |
|---|---|
code - String
|
A human-readable identifier. |
componentType - ComponentType!
|
Specify the type of the ComponentModel. |
components - PagedComponents!
|
A paged list of Component linked to the ComponentModel. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
description - String
|
A brief description of the ComponentModel. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
isConnective - Boolean!
|
A toggle setting that allows instantiated Components to report their connection state. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
The name of the ComponentModel. |
services - PagedServicesOnComponentModel!
|
A paged list of Services linked to the ComponentModel. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"code": "abc123",
"componentType": "DEVICE",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"isConnective": true,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"services": PagedServicesOnComponentModel,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
ComponentModelOrderByQuery
Description
ComponentModelOrderByQuery provides complex filters over ComponentModel's
Fields
| Input Field | Description |
|---|---|
code - OrderByDirection
|
Order ComponentModel by code field. |
componentType - OrderByDirection
|
Order ComponentModel by componentType field. |
createdAt - OrderByDirection
|
Order ComponentModel by createdAt field. |
description - OrderByDirection
|
Order ComponentModel by description field. |
isConnective - OrderByDirection
|
Order ComponentModel by isConnective field. |
name - OrderByDirection
|
Order ComponentModel by name field. |
status - OrderByDirection
|
Order ComponentModel by status field. |
updatedAt - OrderByDirection
|
Order ComponentModel by updatedAt field. |
uuid - OrderByDirection
|
Order ComponentModel by uuid field. |
Example
{
"code": "ASC",
"componentType": "ASC",
"createdAt": "ASC",
"description": "ASC",
"isConnective": "ASC",
"name": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
ComponentModelQuery
Description
ComponentModelQuery provides complex filters over Component's
Fields
| Input Field | Description |
|---|---|
_and - [ComponentModelQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ComponentModelQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by aggregated Datapoints. |
code - StringQueryField
|
Filter by code. |
componentType - ComponentTypeQueryField
|
Filter by component_type. |
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by current Datapoints. |
datapoints - NestedDatapointsWhereQuery
|
Filter by Datapoints. |
description - StringQueryField
|
Filter by description. |
isConnective - BoolQueryField
|
Filter by is_connective. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name. |
service - NestedServiceOnComponentModelQuery
|
|
status - StatusQueryField
|
Filter by status. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [ComponentModelQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ComponentModelQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"code": StringQueryField,
"componentType": ComponentTypeQueryField,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"description": StringQueryField,
"isConnective": BoolQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"service": NestedServiceOnComponentModelQuery,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
ComponentOrderByQuery
Description
Defines the fields by which Components can be ordered.
Fields
| Input Field | Description |
|---|---|
code - OrderByDirection
|
Order Component by code field. |
componentModelUuid - OrderByDirection
|
Order Component by uuid field of associated ComponentModel. |
connectionState - OrderByDirection
|
Order Component by connectionState field. |
connectionStateUpdatedAt - OrderByDirection
|
Order Component by the time at which the Component's connectionState was last updated. |
createdAt - OrderByDirection
|
Order Component by createdAt field. |
name - OrderByDirection
|
Order Component by name field. |
status - OrderByDirection
|
Order Component by status field. |
systemUuid - OrderByDirection
|
Order Component by uuid field of associated System. |
updatedAt - OrderByDirection
|
Order Component by updatedAt field. |
uuid - OrderByDirection
|
Order Component by uuid field. |
Example
{
"code": "ASC",
"componentModelUuid": "ASC",
"connectionState": "ASC",
"connectionStateUpdatedAt": "ASC",
"createdAt": "ASC",
"name": "ASC",
"status": "ASC",
"systemUuid": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
ComponentQuery
Description
Retrieves matching Components based on specified criteria.
Fields
| Input Field | Description |
|---|---|
_and - [ComponentQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ComponentQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
The aggregated datapoints associated with the Component. |
characteristic - NestedCharacteristicQuery
|
|
code - StringQueryField
|
A human-readable identifier for the Component. |
componentModel - NestedComponentModelQuery
|
The model of the Component. |
connectionState - ComponentConnectionStateQueryField
|
The connection state of the Component. |
connectionStateUpdatedAt - DateTimeQueryField
|
The time at which the Component's connection state was last updated. |
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
The current datapoints associated with the Component. |
datapoints - NestedDatapointsWhereQuery
|
The datapoints associated with the Component. |
events - NestedEventFilterQuery
|
Filters that can be used to filter and retrieve Events associated with the Component. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
The name of the Component. |
service - NestedServiceOnComponentQuery
|
|
status - StatusQueryField
|
The status of the Component. |
system - NestedSystemQuery
|
The System that the Component belongs to. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the Component. |
Example
{
"_and": [ComponentQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ComponentQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"code": StringQueryField,
"componentModel": NestedComponentModelQuery,
"connectionState": ComponentConnectionStateQueryField,
"connectionStateUpdatedAt": DateTimeQueryField,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"events": NestedEventFilterQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"service": NestedServiceOnComponentQuery,
"status": StatusQueryField,
"system": NestedSystemQuery,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
ComponentType
Description
Enumerates the types of Components that can be associated with a System.
Values
| Enum Value | Description |
|---|---|
|
|
A standalone physical device. |
|
|
A physical device that connects other devices to DRIVR. |
|
|
A logical entity, such as a data source or software. |
Example
"DEVICE"
ComponentTypeQueryField
Description
Apply the filter operation to component-type value.
Fields
| Input Field | Description |
|---|---|
_eq - ComponentType
|
Equals |
_in - [ComponentType]
|
Is in the list |
_neq - ComponentType
|
Does NOT equal |
_nin - [ComponentType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "DEVICE",
"_in": ["DEVICE"],
"_neq": "DEVICE",
"_nin": ["DEVICE"],
"_null": true
}
CreateAzureAuthenticationMethodConfiguration
Example
{
"clientId": "xyz789",
"clientSecret": "abc123",
"tenant": "xyz789"
}
CreateGoogleAuthenticationMethodConfiguration
Fields
| Input Field | Description |
|---|---|
clientId - String!
|
The client id used to authenticate DRIVR against the authentication service. |
clientSecret - String!
|
The secret used to authenticate DRIVR against the authentication service. |
scopes - [String]
|
The list of authentication scopes for the authentication service. |
Example
{
"clientId": "abc123",
"clientSecret": "abc123",
"scopes": ["abc123"]
}
CreateOpenIdDelegatedAuthenticationMethodConfiguration
CurrentDatapointsWhereQuery
Fields
| Input Field | Description |
|---|---|
_and - [CurrentDatapointsWhereQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [CurrentDatapointsWhereQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
|
characteristicUuid - UuidQueryField
|
Filter by Characteristic UUID. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
componentModelUuid - UuidQueryField
|
Filter by ComponentModel UUID. |
componentUuid - UuidQueryField
|
Filter by Component UUID. |
domainUuid - UuidQueryField
|
Filter by Domain UUID. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service & ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
Filter by Service UUID. |
system - NestedSystemQuery
|
|
systemUuid - UuidQueryField
|
Filter by System UUID. |
time - DateTimeQueryField
|
Filter by Datapoint occurrence. |
timeStream - NestedTimeStreamQuery
|
|
timeStreamUuid - UuidQueryField
|
Filter by TimeStream UUID. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
value - ValueQueryField
|
Example
{
"_and": [CurrentDatapointsWhereQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [CurrentDatapointsWhereQuery],
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"componentModelUuid": UuidQueryField,
"componentUuid": UuidQueryField,
"domainUuid": UuidQueryField,
"from": "2007-12-03T10:15:30Z",
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"system": NestedSystemQuery,
"systemUuid": UuidQueryField,
"time": DateTimeQueryField,
"timeStream": NestedTimeStreamQuery,
"timeStreamUuid": UuidQueryField,
"to": "2007-12-03T10:15:30Z",
"value": ValueQueryField
}
DataSource
Description
An entity that represents a data source.
Fields
| Field Name | Description |
|---|---|
code - String!
|
A human or machine-readable code representing the entity. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
description - String
|
A description of the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
name - String
|
A human-readable name representing the entity. |
reference - String
|
An additional ID for the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"code": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "abc123",
"reference": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
DataSourceOrderByQuery
Description
A DataSourceOrderByQuery allows sorting of DataSource objects. The available fields for sorting are code, created_at, name, description, reference, updatedAt and uuid.
Fields
| Input Field | Description |
|---|---|
code - OrderByDirection
|
The code of the DataSource. |
createdAt - OrderByDirection
|
The date and time at which the DataSource was created. |
description - OrderByDirection
|
A brief description of the DataSource. |
name - OrderByDirection
|
The name of the DataSource. |
reference - OrderByDirection
|
A reference to another system that the DataSource connects to. |
updatedAt - OrderByDirection
|
The date and time at which the DataSource was last updated. |
uuid - OrderByDirection
|
The unique identifier for the DataSource. |
Example
{
"code": "ASC",
"createdAt": "ASC",
"description": "ASC",
"name": "ASC",
"reference": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
DataSourceQuery
Description
A DataSourceQuery allows searching for DataSources. The available fields for filtering and sorting by are uuid, name, description, reference and code.
Fields
| Input Field | Description |
|---|---|
_and - [DataSourceQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [DataSourceQuery]
|
One of the passed entities must match |
code - StringQueryField
|
Code of the DataSources. |
createdAt - DateTimeQueryField
|
|
description - StringQueryField
|
A brief description of the DataSources. |
name - StringQueryField
|
The name of the DataSources. |
reference - StringQueryField
|
A reference to another system that the DataSources connects to. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The unique identifier for the DataSources. |
Example
{
"_and": [DataSourceQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [DataSourceQuery],
"code": StringQueryField,
"createdAt": DateTimeQueryField,
"description": StringQueryField,
"name": StringQueryField,
"reference": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
Datapoint
Description
A Datapoint in the system.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
Possible Types
| Datapoint Types |
|---|
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
DatapointBlob
Description
A Datapoint of type blob.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - String!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "xyz789"
}
DatapointBoolean
Description
A Datapoint of type boolean.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - Boolean!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": false
}
DatapointDate
Description
A Datapoint of type date.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - Date!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "2007-12-03"
}
DatapointFloat
Description
A Datapoint of type float.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - Float!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987.65
}
DatapointInputBlob
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - String!
|
The base64-encoded binary data which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "abc123"
}
DatapointInputBoolean
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Boolean!
|
The boolean value which should be stored into DRIVR. |
Example
{
"characteristicCode": "xyz789",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": false
}
DatapointInputDate
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Date!
|
The date value which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "2007-12-03"
}
DatapointInputFloat
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Float!
|
The value must be within the boundary range, and if a boundary_step is specified in the connected Characteristic, it must be a multiple of that step. For example, if boundary_min is 2.5, boundary_max is 7.75, and boundary_step is 1.5, valid values would be 2.5, 4.0, 5.5, and 7.0. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 123.45
}
DatapointInputInteger
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Int!
|
The value must be within the boundary range, and if a boundary_step is specified in the connected Characteristic,it must be a multiple of that step. For example, if boundary_min is 2, boundary_max is 7, and boundary_step is 2, valid values would be 2, 4 and 6. |
Example
{
"characteristicCode": "xyz789",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 123
}
DatapointInputJson
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - String!
|
The string representation of JSON data which should be stored into DRIVR. |
Example
{
"characteristicCode": "xyz789",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "abc123"
}
DatapointInputSelect
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - [String]!
|
The selected option or options which should be added. |
Example
{
"characteristicCode": "xyz789",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": ["abc123"]
}
DatapointInputString
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - String!
|
The length of string 'value' needs to be given between defined 'length_min' and 'length_max' range of Characteristic. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "xyz789"
}
DatapointInputTime
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Time!
|
The time value which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "10:15:30Z"
}
DatapointInputTimespan
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Timespan!
|
The timespan value which should be stored into DRIVR. |
Example
{
"characteristicCode": "xyz789",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": Timespan
}
DatapointInputTimestamp
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
time - DateTime
|
The date time for the datapoint. If none is passed the current timestamp is used. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - DateTime!
|
The timestamp value which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "2007-12-03T10:15:30Z"
}
DatapointInteger
Description
A Datapoint of type integer.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - Int!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987
}
DatapointJson
Description
A Datapoint of type json.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - String!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "xyz789"
}
DatapointOrderByQuery
Fields
| Input Field | Description |
|---|---|
characteristicUuid - OrderByDirection
|
|
componentUuid - OrderByDirection
|
|
serviceUuid - OrderByDirection
|
|
systemUuid - OrderByDirection
|
|
time - OrderByDirection
|
|
timeStreamUuid - OrderByDirection
|
Example
{
"characteristicUuid": "ASC",
"componentUuid": "ASC",
"serviceUuid": "ASC",
"systemUuid": "ASC",
"time": "ASC",
"timeStreamUuid": "ASC"
}
DatapointSelect
Description
A Datapoint of type select. It describes one or multiple options selected from the referenced Characteristic.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - [String!]!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": ["abc123"]
}
DatapointString
Description
A Datapoint of type string.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - String!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "xyz789"
}
DatapointTime
Description
A Datapoint of type time.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - Time!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "10:15:30Z"
}
DatapointTimespan
Description
A Datapoint of type timespan.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - Timespan!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": Timespan
}
DatapointTimestamp
Description
A Datapoint of type timestamp.
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Datapoint contains. |
uuid - UUID!
|
The unique ID for referencing the Datapoint. |
value - DateTime!
|
The Datapoint value. |
Example
{
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "2007-12-03T10:15:30Z"
}
DatapointsWhereQuery
Description
DatapointsWhereQuery provides complex filter over datapoints_
Fields
| Input Field | Description |
|---|---|
_and - [DatapointsWhereQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [DatapointsWhereQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
|
characteristicUuid - UuidQueryField
|
Filter by Characteristic UUID. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
componentModelUuid - UuidQueryField
|
Filter by ComponentModel UUID. |
componentUuid - UuidQueryField
|
Filter by Component UUID. |
domainUuid - UuidQueryField
|
Filter by Domain UUID. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service & ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
Filter by Service UUID. |
system - NestedSystemQuery
|
|
systemUuid - UuidQueryField
|
Filter by System UUID. |
time - DateTimeQueryField
|
Filter by Datapoint occurrence. |
timeStream - NestedTimeStreamQuery
|
|
timeStreamUuid - UuidQueryField
|
Filter by TimeStream UUID. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
value - ValueQueryField
|
Example
{
"_and": [DatapointsWhereQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [DatapointsWhereQuery],
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"componentModelUuid": UuidQueryField,
"componentUuid": UuidQueryField,
"domainUuid": UuidQueryField,
"from": "2007-12-03T10:15:30Z",
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"system": NestedSystemQuery,
"systemUuid": UuidQueryField,
"time": DateTimeQueryField,
"timeStream": NestedTimeStreamQuery,
"timeStreamUuid": UuidQueryField,
"to": "2007-12-03T10:15:30Z",
"value": ValueQueryField
}
Date
Description
The Date type represents a Date value as specified by iso8601.
Example
"2007-12-03"
DateAggregates
Fields
| Input Field | Description |
|---|---|
count - IntQueryField
|
|
first - DateQueryField
|
|
last - DateQueryField
|
|
max - DateQueryField
|
|
min - DateQueryField
|
Example
{
"count": IntQueryField,
"first": DateQueryField,
"last": DateQueryField,
"max": DateQueryField,
"min": DateQueryField
}
DateQueryField
Description
Apply the filter operation to Date value.
Example
{
"_eq": "2007-12-03",
"_gt": "2007-12-03",
"_gte": "2007-12-03",
"_in": ["2007-12-03"],
"_lt": "2007-12-03",
"_lte": "2007-12-03",
"_neq": "2007-12-03",
"_nin": ["2007-12-03"],
"_null": false
}
DateTime
Description
The DateTime type represents a DateTime value as specified by iso8601.
Example
"2007-12-03T10:15:30Z"
DateTimeQueryField
Description
Apply the filter operation to DataTime value.
Fields
| Input Field | Description |
|---|---|
_eq - DateTime
|
Equals |
_gt - DateTime
|
Greater than |
_gte - DateTime
|
Greater than or equal |
_in - [DateTime]
|
Is in the list |
_lt - DateTime
|
Less than |
_lte - DateTime
|
Less than or equal |
_neq - DateTime
|
Does NOT equal |
_nin - [DateTime]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "2007-12-03T10:15:30Z",
"_gt": "2007-12-03T10:15:30Z",
"_gte": "2007-12-03T10:15:30Z",
"_in": ["2007-12-03T10:15:30Z"],
"_lt": "2007-12-03T10:15:30Z",
"_lte": "2007-12-03T10:15:30Z",
"_neq": "2007-12-03T10:15:30Z",
"_nin": ["2007-12-03T10:15:30Z"],
"_null": true
}
DefaultAuthenticationMethod
Description
Default DomainAuthenticationMethod for authenticating against DRIVR's internal authentication.
Fields
| Field Name | Description |
|---|---|
authenticationType - DomainAuthenticationMethod
|
The type of authentication method. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"authenticationType": "AZURE_AD",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
DefaultValueQueryField
Description
Filter by the default value of datapoints and setpoints
Fields
| Input Field | Description |
|---|---|
boolean - BoolQueryField
|
|
float - FloatQueryField
|
|
integer - IntQueryField
|
|
string - StringQueryField
|
|
timestamp - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"boolean": BoolQueryField,
"float": FloatQueryField,
"integer": IntQueryField,
"string": StringQueryField,
"timestamp": DateTimeQueryField,
"uuid": UuidQueryField
}
DistinctAggregatedDatapoint
Description
Represents a specific AggregatedDistinctDatapoint with its metadata. It provides a summary of _Datapoint_s that have been aggregated by a specific Characteristic or linked TimeStream.
Fields
| Field Name | Description |
|---|---|
count - Int!
|
Specifies the number of times this datapoint appeared in the group. |
Possible Types
| DistinctAggregatedDatapoint Types |
|---|
Example
{"count": 123}
DistinctAggregatedDatapointBlobCount
Description
Returns the count of values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 987, "value": 987}
DistinctAggregatedDatapointBlobFirst
Description
Returns the oldest value based on the timestamp from a DistinctAggregatedDatapoint as a string.
Example
{"count": 987, "value": "xyz789"}
DistinctAggregatedDatapointBlobLast
Description
Returns the newest value based on the timestamp from a DistinctAggregatedDatapoint as a string.
Example
{"count": 123, "value": "abc123"}
DistinctAggregatedDatapointBooleanAvg
Description
Returns the arithmetic average value from a DistinctAggregatedDatapoint as a float.| Example - avg(true, true, true, false, true) = (1+1+1+0+1)/5 = 0.8
Example
{"count": 123, "value": 987.65}
DistinctAggregatedDatapointBooleanCount
Description
Returns the count of values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 987, "value": 987}
DistinctAggregatedDatapointBooleanFirst
Description
Returns the oldest value based on the timestamp from a DistinctAggregatedDatapoint as a boolean.
Example
{"count": 987, "value": true}
DistinctAggregatedDatapointBooleanLast
Description
Returns the newest value based on the timestamp from a DistinctAggregatedDatapoint as a boolean.
Example
{"count": 123, "value": false}
DistinctAggregatedDatapointBooleanMax
Description
Returns the maximum value from a DistinctAggregatedDatapoint as a boolean.
Example
{"count": 123, "value": false}
DistinctAggregatedDatapointBooleanMin
Description
Returns the smallest value from a DistinctAggregatedDatapoint as a boolean.
Example
{"count": 123, "value": false}
DistinctAggregatedDatapointBooleanSum
Description
Returns the sum of the values from a DistinctAggregatedDatapoint as an integer. Example - sum(true, true, true, true, false) = 1+1+1+1+0 = 4
Example
{"count": 987, "value": 987}
DistinctAggregatedDatapointDateCount
Description
Returns the count of values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 123, "value": 987}
DistinctAggregatedDatapointDateFirst
Description
Returns the oldest value based on the timestamp from a DistinctAggregatedDatapoint as a date.
Example
{"count": 123, "value": "2007-12-03"}
DistinctAggregatedDatapointDateLast
Description
Returns the newest value based on the timestamp from a DistinctAggregatedDatapoint as a date.
Example
{"count": 987, "value": "2007-12-03"}
DistinctAggregatedDatapointDateMax
Description
Returns the newest value based on the value's data from a DistinctAggregatedDatapoint as a date.
Example
{"count": 987, "value": "2007-12-03"}
DistinctAggregatedDatapointDateMin
Description
Returns the oldest value based on the value's data from a DistinctAggregatedDatapoint as a date.
Example
{"count": 987, "value": "2007-12-03"}
DistinctAggregatedDatapointFloatAvg
Description
Returns the arithmetic average value from a DistinctAggregatedDatapoint as a float.
Example
{"count": 123, "value": 987.65}
DistinctAggregatedDatapointFloatCount
Description
Returns the count of values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 123, "value": 123}
DistinctAggregatedDatapointFloatFirst
Description
Returns the oldest value based on the timestamp from a DistinctAggregatedDatapoint as a float.
Example
{"count": 123, "value": 987.65}
DistinctAggregatedDatapointFloatLast
Description
Returns the newest value based on the timestamp from a DistinctAggregatedDatapoint as a float.
Example
{"count": 123, "value": 123.45}
DistinctAggregatedDatapointFloatMax
Description
Returns the maximum value from a DistinctAggregatedDatapoint as a float.
Example
{"count": 123, "value": 987.65}
DistinctAggregatedDatapointFloatMin
Description
Returns the smallest value from a DistinctAggregatedDatapoint as a float.
Example
{"count": 987, "value": 123.45}
DistinctAggregatedDatapointFloatSum
Description
Returns the sum of the values from a DistinctAggregatedDatapoint as a float.
Example
{"count": 123, "value": 987.65}
DistinctAggregatedDatapointIntegerAvg
Description
Returns the arithmetic average value from a DistinctAggregatedDatapoint as a float.
Example
{"count": 987, "value": 987.65}
DistinctAggregatedDatapointIntegerCount
Description
Returns the count of values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 987, "value": 987}
DistinctAggregatedDatapointIntegerFirst
Description
Returns the oldest value based on the timestamp from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 123, "value": 123}
DistinctAggregatedDatapointIntegerLast
Description
Returns the newest value based on the timestamp from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 987, "value": 123}
DistinctAggregatedDatapointIntegerMax
Description
Returns the maximum value from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 123, "value": 987}
DistinctAggregatedDatapointIntegerMin
Description
Returns the smallest value from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 123, "value": 123}
DistinctAggregatedDatapointIntegerSum
Description
Returns the sum of the values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 123, "value": 987}
DistinctAggregatedDatapointStringCount
Description
Returns the count of values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 987, "value": 987}
DistinctAggregatedDatapointStringFirst
Description
Returns the oldest value based on the timestamp from a DistinctAggregatedDatapoint as a string.
Example
{"count": 987, "value": "xyz789"}
DistinctAggregatedDatapointStringLast
Description
Returns the newest value based on the timestamp from a DistinctAggregatedDatapoint as a string.
Example
{"count": 123, "value": "abc123"}
DistinctAggregatedDatapointTimeCount
Description
Returns the count of values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 987, "value": 123}
DistinctAggregatedDatapointTimeFirst
Description
Returns the oldest value based on the timestamp from a DistinctAggregatedDatapoint as a time.
Example
{"count": 987, "value": "10:15:30Z"}
DistinctAggregatedDatapointTimeLast
Description
Returns the newest value based on the timestamp from a DistinctAggregatedDatapoint as a time.
Example
{"count": 123, "value": "10:15:30Z"}
DistinctAggregatedDatapointTimeMax
Description
Returns the maximum value from a DistinctAggregatedDatapoint as a time.
Example
{"count": 123, "value": "10:15:30Z"}
DistinctAggregatedDatapointTimeMin
Description
Returns the smallest value from a DistinctAggregatedDatapoint as a time.
Example
{"count": 987, "value": "10:15:30Z"}
DistinctAggregatedDatapointTimespanAvg
Description
Returns the arithmetic average value from a DistinctAggregatedDatapoint as a timespan.
Example
{"count": 123, "value": Timespan}
DistinctAggregatedDatapointTimespanCount
Description
Returns the count of values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 987, "value": 123}
DistinctAggregatedDatapointTimespanFirst
Description
Returns the oldest value based on the timestamp from a DistinctAggregatedDatapoint as a timespan.
Example
{"count": 987, "value": Timespan}
DistinctAggregatedDatapointTimespanLast
Description
Returns the newest value based on the timestamp from a DistinctAggregatedDatapoint as a timespan.
Example
{"count": 987, "value": Timespan}
DistinctAggregatedDatapointTimespanMax
Description
Returns the maximum value from a DistinctAggregatedDatapoint as a timespan.
Example
{"count": 987, "value": Timespan}
DistinctAggregatedDatapointTimespanMin
Description
Returns the smallest value from a DistinctAggregatedDatapoint as a timespan.
Example
{"count": 123, "value": Timespan}
DistinctAggregatedDatapointTimespanSum
Description
Returns the sum of the values from a DistinctAggregatedDatapoint as a timespan.
Example
{"count": 123, "value": Timespan}
DistinctAggregatedDatapointTimestampCount
Description
Returns the count of values from a DistinctAggregatedDatapoint as an integer.
Example
{"count": 123, "value": 987}
DistinctAggregatedDatapointTimestampFirst
Description
Returns the oldest value based on the value's timestamp from a DistinctAggregatedDatapoint as a date_time.
Example
{
"count": 987,
"value": "2007-12-03T10:15:30Z"
}
DistinctAggregatedDatapointTimestampLast
Description
Returns the newest value based on the value's timestamp from a DistinctAggregatedDatapoint as a date_time.
Example
{
"count": 123,
"value": "2007-12-03T10:15:30Z"
}
DistinctAggregatedDatapointTimestampMax
Description
Returns the maximum value from a DistinctAggregatedDatapoint as a DateTime.
Example
{
"count": 123,
"value": "2007-12-03T10:15:30Z"
}
DistinctAggregatedDatapointTimestampMin
Description
Returns the smallest value from a DistinctAggregatedDatapoint as a DateTime.
Example
{
"count": 123,
"value": "2007-12-03T10:15:30Z"
}
DistinctAggregatedDatapoints
Description
Represents a set of AggregatedDistinctDatapoint. It provides a summary of data points that have been aggregated by specific Characteristics or linked TimeStreams.
Fields
| Field Name | Description |
|---|---|
datapoints - [DistinctAggregatedDatapoint!]
|
Specifies the distinct data corresponding to this aggregated datapoint. |
time - DateTime
|
Specifies the timestamp of the aggregated datapoint. |
Possible Types
| DistinctAggregatedDatapoints Types |
|---|
Example
{
"datapoints": [DistinctAggregatedDatapoint],
"time": "2007-12-03T10:15:30Z"
}
DistinctAggregatedDatapointsPerCharacteristic
Description
Represents an AggregatedDistinctDatapoint for Characteristics. It provides a summary of data points that have been aggregated by a specific Characteristic.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
datapoints - [DistinctAggregatedDatapoint!]
|
Specifies the distinct data corresponding to this aggregated datapoint. |
time - DateTime
|
Specifies the timestamp of the aggregated datapoint. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"datapoints": [DistinctAggregatedDatapoint],
"time": "2007-12-03T10:15:30Z"
}
DistinctAggregatedDatapointsPerTimeStream
Description
Represents an AggregatedDistinctDatapoint for TimeStreams. It provides a summary of data points that have been aggregated by a specific linked TimeStream.
Fields
| Field Name | Description |
|---|---|
datapoints - [DistinctAggregatedDatapoint!]
|
Specifies the distinct data corresponding to this aggregated datapoint. |
time - DateTime
|
Specifies the timestamp of the aggregated datapoint. |
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
Example
{
"datapoints": [DistinctAggregatedDatapoint],
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
DistinctAggregatedDatapointsWhereQuery
Description
A complex filter allowing for more granular filtering over DistinctAggregatedDatapoints. Use this filter to build more complex queries for retrieving DistinctAggregatedDatapoints.
Fields
| Input Field | Description |
|---|---|
_and - [DistinctAggregatedDatapointsWhereQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [DistinctAggregatedDatapointsWhereQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
|
characteristicUuid - UuidQueryField
|
Filter by Characteristic UUID. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
componentModelUuid - UuidQueryField
|
Filter by ComponentModel UUID. |
componentUuid - UuidQueryField
|
Filter by Component UUID. |
domainUuid - UuidQueryField
|
Filter by Domain UUID. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
grid - Timespan
|
The timespan based chunk size by which datapoints are aggregated. Requires from and to to be set. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service & ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
Filter by Service UUID. |
system - NestedSystemQuery
|
|
systemUuid - UuidQueryField
|
Filter by System UUID. |
timeStream - NestedTimeStreamQuery
|
|
timeStreamUuid - UuidQueryField
|
Filter by TimeStream UUID. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
value - AggregateValueField
|
Example
{
"_and": [DistinctAggregatedDatapointsWhereQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [DistinctAggregatedDatapointsWhereQuery],
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"componentModelUuid": UuidQueryField,
"componentUuid": UuidQueryField,
"domainUuid": UuidQueryField,
"from": "2007-12-03T10:15:30Z",
"grid": Timespan,
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"system": NestedSystemQuery,
"systemUuid": UuidQueryField,
"timeStream": NestedTimeStreamQuery,
"timeStreamUuid": UuidQueryField,
"to": "2007-12-03T10:15:30Z",
"value": AggregateValueField
}
DistinctDatapoint
Description
Represents a single distinct Datapoint. It provides the common attributes and behavior for all distinct Datapoint types.
Fields
| Field Name | Description |
|---|---|
count - Int!
|
Specifies the number of times the distinct Datapoint appeared in the group. |
Example
{"count": 123}
DistinctDatapointBlob
Description
Represents a distinct Datapoint for a binary large object (BLOB). It captures the unique BLOB values of a given Datapoint, along with the frequency of occurrence, for a specific time period and time stream.
Example
{"count": 987, "value": "xyz789"}
DistinctDatapointBoolean
Description
Represents a distinct Datapoint for a boolean value. Distinct datapoints are used to capture the unique values of a given Datapoint and the frequency of occurrence for a specific time period and time stream.
Example
{"count": 123, "value": true}
DistinctDatapointDate
Description
Represents a distinct Datapoint for a date value. It captures the unique date values of a given Datapoint, along with the frequency of occurrence, for a specific time period and time stream.
Example
{"count": 987, "value": "2007-12-03"}
DistinctDatapointFloat
Description
Represents a distinct Datapoint for a float value. It captures the unique float values of a given Datapoint, along with the frequency of occurrence, for a specific time period and time stream.
Example
{"count": 987, "value": 987.65}
DistinctDatapointGroup
Description
Defines the groups that distinct Datapoints can belong to.
Values
| Enum Value | Description |
|---|---|
|
|
Represents a characteristic group of a distinct Datapoint |
|
|
Represents a group of a distinct Datapoint that is linked to a TimeStream. |
Example
"CHARACTERISTIC"
DistinctDatapointInteger
Description
Represents a distinct Datapoint for a integer value. It captures the unique integer values of a given Datapoint, along with the frequency of occurrence, for a specific time period and time stream.
Example
{"count": 123, "value": 987}
DistinctDatapointPerCharacteristic
Description
Represents a distinct Datapoint for a Characteristic. It captures the unique values of a given Datapoint's Characteristic, along with the frequency of occurrence, for a specific time period and time stream.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
datapoints - [DistinctDatapoint!]!
|
The list of distinct datapoints. |
time - DateTime
|
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"datapoints": [DistinctDatapoint],
"time": "2007-12-03T10:15:30Z"
}
DistinctDatapointPerTimeStream
Description
Represents a distinct Datapoint for a TimeStream. It captures the unique values of a given Datapoint's TimeStream, along with the frequency of occurrence, for a specific time period.
Fields
| Field Name | Description |
|---|---|
datapoints - [DistinctDatapoint!]!
|
The list of distinct datapoints. |
time - DateTime
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
Example
{
"datapoints": [DistinctDatapoint],
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
DistinctDatapointString
Description
Represents a distinct Datapoint for a string value. It captures the unique string values of a given Datapoint, along with the frequency of occurrence, for a specific time period and time stream.
Example
{"count": 987, "value": "abc123"}
DistinctDatapointTime
Description
Represents a distinct Datapoint for a time value. It captures the unique time values of a given Datapoint, along with the frequency of occurrence, for a specific time period and time stream.
Example
{"count": 987, "value": "10:15:30Z"}
DistinctDatapointTimespan
Description
Represents a distinct Datapoint for a timespan value. It captures the unique timespan values of a given Datapoint, along with the frequency of occurrence, for a specific time period and time stream.
Example
{"count": 987, "value": Timespan}
DistinctDatapointTimestamp
Description
Represents a distinct Datapoint for a timestamp value. It captures the unique timestamp values of a given Datapoint, along with the frequency of occurrence, for a specific time period and time stream.
Example
{
"count": 123,
"value": "2007-12-03T10:15:30Z"
}
DistinctDatapoints
Description
Distinct datapoints for a set of datapoints.
Fields
| Field Name | Description |
|---|---|
datapoints - [DistinctDatapoint!]!
|
The list of distinct datapoints. |
time - DateTime
|
Possible Types
| DistinctDatapoints Types |
|---|
Example
{
"datapoints": [DistinctDatapoint],
"time": "2007-12-03T10:15:30Z"
}
DistinctDatapointsWhereQuery
Description
A complex filter allowing for more granular filtering over DistinctDatapoints. Use this filter to build more complex queries for retrieving DistinctDatapoints.
Fields
| Input Field | Description |
|---|---|
_and - [DistinctDatapointsWhereQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [DistinctDatapointsWhereQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
|
characteristicUuid - UuidQueryField
|
Filter by Characteristic UUID. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
componentModelUuid - UuidQueryField
|
Filter by ComponentModel UUID. |
componentUuid - UuidQueryField
|
Filter by Component UUID. |
domainUuid - UuidQueryField
|
Filter by Domain UUID. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
grid - Timespan
|
The timespan based chunk size by which datapoints are aggregated. Requires from and to to be set. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service & ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
Filter by Service UUID. |
system - NestedSystemQuery
|
|
systemUuid - UuidQueryField
|
Filter by System UUID. |
timeStream - NestedTimeStreamQuery
|
|
timeStreamUuid - UuidQueryField
|
Filter by TimeStream UUID. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
Example
{
"_and": [DistinctDatapointsWhereQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [DistinctDatapointsWhereQuery],
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"componentModelUuid": UuidQueryField,
"componentUuid": UuidQueryField,
"domainUuid": UuidQueryField,
"from": "2007-12-03T10:15:30Z",
"grid": Timespan,
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"system": NestedSystemQuery,
"systemUuid": UuidQueryField,
"timeStream": NestedTimeStreamQuery,
"timeStreamUuid": UuidQueryField,
"to": "2007-12-03T10:15:30Z"
}
DistinctMetadataOrderByQuery
Description
Defines the fields by which DistinctMetadataValues can be ordered.
Fields
| Input Field | Description |
|---|---|
count - OrderByDirection
|
Orders DistinctMetadataValues based on their count field. |
key - OrderByDirection
|
Orders DistinctMetadataValues based on their key. |
metadataTypeUuid - OrderByDirection
|
Orders DistinctMetadataValues based on their metadataTypeUuid. |
value - OrderByDirection
|
Orders DistinctMetadataValues based on their value. |
Example
{"count": "ASC", "key": "ASC", "metadataTypeUuid": "ASC", "value": "ASC"}
DistinctMetadataValue
Description
Retrieve distinct values for a specific metadata types.
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of times the metadata value and key combination is stored. |
key - String
|
The name of the field that maps to the specified metadata type. It must be unique of all ACTIVATED metadata types. |
metadataTypeUuid - UUID
|
The metadata type UUID for the current value. |
Possible Types
| DistinctMetadataValue Types |
|---|
Example
{
"count": 123,
"key": "abc123",
"metadataTypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
DistinctMetadataValueBoolean
Description
Retrieve distinct values for boolean metadata types.
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of times the metadata value and key combination is stored. |
key - String
|
The name of the field that maps to the specified metadata type. It must be unique of all ACTIVATED metadata types. |
metadataTypeUuid - UUID
|
The metadata type UUID for the current value. |
value - Boolean
|
The boolean value of the specified metadata type. |
Example
{
"count": 123,
"key": "xyz789",
"metadataTypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": false
}
DistinctMetadataValueFloat
Description
Retrieve distinct values for float metadata types.
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of times the metadata value and key combination is stored. |
key - String
|
The name of the field that maps to the specified metadata type. It must be unique of all ACTIVATED metadata types. |
metadataTypeUuid - UUID
|
The metadata type UUID for the current value. |
value - Float
|
The float value of the specified metadata type. |
Example
{
"count": 123,
"key": "xyz789",
"metadataTypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 123.45
}
DistinctMetadataValueInteger
Description
Retrieve distinct values for integer metadata types.
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of times the metadata value and key combination is stored. |
key - String
|
The name of the field that maps to the specified metadata type. It must be unique of all ACTIVATED metadata types. |
metadataTypeUuid - UUID
|
The metadata type UUID for the current value. |
value - Int
|
The integer value of the specified metadata type. |
Example
{
"count": 987,
"key": "xyz789",
"metadataTypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 123
}
DistinctMetadataValueQuery
Description
A complex filter allowing for more granular filtering over DistinctMetadataValues. Use this filter to build more complex queries for retrieving DistinctMetadataValues.
Fields
| Input Field | Description |
|---|---|
_and - [DistinctMetadataValueQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [DistinctMetadataValueQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
The Characteristic associated with the DistinctMetadataValues. |
component - NestedComponentQuery
|
The Component associated with the DistinctMetadataValues. |
componentModel - NestedComponentModelQuery
|
The ComponentModel associated with the DistinctMetadataValues. |
entityUuid - UuidQueryField
|
The UUID of the entity the metadataValue belongs to. |
event - NestedEventQuery
|
The Event associated with the DistinctMetadataValues. |
eventModel - NestedEventModelQuery
|
The EventModel associated with the DistinctMetadataValues. |
metadataType - NestedMetadataTypeQuery
|
The MetadataType associated with the DistinctMetadataValues. |
metadataTypeUuid - UuidQueryField
|
The UUID of the metadataType the metadataValue belongs to. |
organization - NestedOrganizationQuery
|
The Organization associated with the DistinctMetadataValues. |
service - NestedServiceQuery
|
The Service associated with the DistinctMetadataValues. |
system - NestedSystemQuery
|
The System associated with the DistinctMetadataValues. |
user - NestedUserQuery
|
The User associated with the DistinctMetadataValues. |
Example
{
"_and": [DistinctMetadataValueQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [DistinctMetadataValueQuery],
"characteristic": NestedCharacteristicQuery,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"entityUuid": UuidQueryField,
"event": NestedEventQuery,
"eventModel": NestedEventModelQuery,
"metadataType": NestedMetadataTypeQuery,
"metadataTypeUuid": UuidQueryField,
"organization": NestedOrganizationQuery,
"service": NestedServiceQuery,
"system": NestedSystemQuery,
"user": NestedUserQuery
}
DistinctMetadataValueString
Description
Retrieve distinct values for string metadata types.
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of times the metadata value and key combination is stored. |
key - String
|
The name of the field that maps to the specified metadata type. It must be unique of all ACTIVATED metadata types. |
metadataTypeUuid - UUID
|
The metadata type UUID for the current value. |
value - String
|
The string value of the specified metadata type. |
Example
{
"count": 123,
"key": "xyz789",
"metadataTypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "abc123"
}
DistinctMetadataValueTimestamp
Description
Retrieve distinct values for timestamp metadata types.
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of times the metadata value and key combination is stored. |
key - String
|
The name of the field that maps to the specified metadata type. It must be unique of all ACTIVATED metadata types. |
metadataTypeUuid - UUID
|
The metadata type UUID for the current value. |
value - DateTime
|
The timestamp value of the specified metadata type. |
Example
{
"count": 123,
"key": "xyz789",
"metadataTypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "2007-12-03T10:15:30Z"
}
DistinctMetadataValueUuid
Description
Retrieve distinct values for uuid metadata types.
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of times the metadata value and key combination is stored. |
key - String
|
The name of the field that maps to the specified metadata type. It must be unique of all ACTIVATED metadata types. |
metadataTypeUuid - UUID
|
The metadata type UUID for the current value. |
value - UUID
|
The uuid value of the specified metadata type. |
Example
{
"count": 987,
"key": "xyz789",
"metadataTypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Domain
Description
A Domain groups Users, Organizations and Systems, as well as additional entities like ComponentModels, ComponentServices, Characteristics, and Datapoints. A Domain is an isolated environment for an individual tenant, normally a company or a team. For example, the currentDomain endpoint returns information about the Domain associated with the current User's tenant.
Fields
| Field Name | Description |
|---|---|
authenticationMethods - PagedAuthenticationMethods!
|
A paged list of AuthenticationMethods for the Domain. |
Arguments
|
|
componentModels - PagedComponentModels!
|
A paged list of ComponentModels belonging to the Domain. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domainFeatures - PagedDomainFeatures!
|
A paged list of DomainFeatures for the Domain. It includes which features are enabled and disabled for the Domain. |
Arguments
|
|
hostNames - [String!]!
|
A list of host names at which the Domain can be reached. This can be used to determine whether a given host name is associated and which domains can be used to reach a given Domain. |
name - String!
|
A non-unique, human-readable identifier for the Domain. Something like the company or team name. |
organizations - PagedOrganizations!
|
A paged list of Organizations belonging to the Domain. |
Arguments
|
|
owner - Account
|
The Account which owns the entity. |
ownerUuid - UUID
|
The UUID of the Account which owns the entity. |
roleAssignments - PagedRoleAssignments!
|
A paged list of assigned RoleAssignments. |
Arguments
|
|
slug - String!
|
A unique, human- and machine-readable identifier for the Domain. This is used in URLs and other places where a unique identifier is required. |
status - Status!
|
The current status of the entity. |
systems - PagedSystems!
|
A paged list of Systems belonging to the Domain. |
Arguments
|
|
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
users - PagedUsers!
|
A paged list of Users belonging to the Domain. |
Arguments
|
|
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"authenticationMethods": PagedAuthenticationMethods,
"componentModels": PagedComponentModels,
"createdAt": "2007-12-03T10:15:30Z",
"domainFeatures": PagedDomainFeatures,
"hostNames": ["abc123"],
"name": "abc123",
"organizations": PagedOrganizations,
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"slug": "abc123",
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"users": PagedUsers,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
DomainAuthenticationMethod
Description
The different types of DomainAuthenticationMethods that can be used with DRIVR's APIs. These methods determine the type of identification or credentials required to successfully authenticate a request before it can be fulfilled.
Values
| Enum Value | Description |
|---|---|
|
|
Enables OAUTH authentication against Azure's ActiveDirectory OAUTH service. This allows accounts from this OAuth provider to login into DRIVR with their Azure accounts. |
|
|
Setting for DRIVR's built-in authentication. All DRIVR Users which have a password set and have the status ACTIVATED can login into DRIVR. |
|
|
Uses OAUTH authentication against Google's OAUTH services. This allows accounts from this OAuth provider to login into DRIVR with their Google accounts. |
|
|
Enables OpenID Bearer token delegation to third-party OAuth servers. This enables the capability to use third-party OAuth tokens to authenticate in DRIVR. |
Example
"AZURE_AD"
DomainAuthenticationMethodOrderByQuery
Description
Specifies which fields can be used to order the results of a DomainAuthenticationMethod query.
Fields
| Input Field | Description |
|---|---|
authenticationType - OrderByDirection
|
Order DomainAuthenticationMethod by authenticationType field. |
createdAt - OrderByDirection
|
Order DomainAuthenticationMethod by createdAt field. |
status - OrderByDirection
|
Order DomainAuthenticationMethod by status field. |
updatedAt - OrderByDirection
|
Order DomainAuthenticationMethod by updatedAt field. |
uuid - OrderByDirection
|
Order DomainAuthenticationMethod by uuid field. |
Example
{
"authenticationType": "ASC",
"createdAt": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
DomainAuthenticationMethodQuery
Description
A complex filter allowing for more granular filtering over DomainAuthenticationMethods. Use this filter to build more complex queries for retrieving DomainAuthenticationMethods.
Fields
| Input Field | Description |
|---|---|
_and - [DomainAuthenticationMethodQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [DomainAuthenticationMethodQuery]
|
One of the passed entities must match |
authenticationType - DomainAuthenticationMethodQueryField
|
Filter DomainAuthenticationMethods by authenticationType. |
createdAt - DateTimeQueryField
|
|
status - StatusQueryField
|
Filter DomainAuthenticationMethods by status. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter DomainAuthenticationMethods by uuid. |
Example
{
"_and": [DomainAuthenticationMethodQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [DomainAuthenticationMethodQuery],
"authenticationType": DomainAuthenticationMethodQueryField,
"createdAt": DateTimeQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
DomainAuthenticationMethodQueryField
Description
Apply the filter operation to domain-authentication-method value.
Fields
| Input Field | Description |
|---|---|
_eq - DomainAuthenticationMethod
|
Equals |
_in - [DomainAuthenticationMethod]
|
Is in the list |
_neq - DomainAuthenticationMethod
|
Does NOT equal |
_nin - [DomainAuthenticationMethod]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "AZURE_AD",
"_in": ["AZURE_AD"],
"_neq": "AZURE_AD",
"_nin": ["AZURE_AD"],
"_null": false
}
DomainFeature
Description
A DomainFeature is a per Domain configuration within DRIVR. Each DomainFeature represents a feature flag that can be enabled or disabled on a per tenant basis. For example, a DomainFeature can represent a requirement for users to have an email.
Fields
| Field Name | Description |
|---|---|
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
enabled - Boolean!
|
Whether the feature flag is enabled or disabled. |
slug - DomainFeatureSlug!
|
The unique, machine-readable identifier for the DomainFeature. |
Example
{
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"enabled": false,
"slug": "DELETE_ARCHIVE_ORGANIZATION_USERS"
}
DomainFeatureOrderByQuery
Description
Specifies which fields can be used to order the results of a DomainFeature query.
Fields
| Input Field | Description |
|---|---|
enabled - OrderByDirection
|
Orders DomainFeatures by their enabled status. |
slug - OrderByDirection
|
Orders DomainFeatures by their slug. |
Example
{"enabled": "ASC", "slug": "ASC"}
DomainFeatureQuery
Description
A complex filter allowing for more granular filtering over DomainFeatures. Use this filter to build more complex queries for retrieving DomainFeatures.
Fields
| Input Field | Description |
|---|---|
_and - [DomainFeatureQuery]
|
All passed queries must match |
_or - [DomainFeatureQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
enabled - BoolQueryField
|
Filter by the enabled status of the DomainFeature. |
slug - DomainFeatureSlugQueryField
|
Filter by the slug of the DomainFeature. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"_and": [DomainFeatureQuery],
"_or": [DomainFeatureQuery],
"createdAt": DateTimeQueryField,
"enabled": BoolQueryField,
"slug": DomainFeatureSlugQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
DomainFeatureSlug
Description
This ENUM outlines the various customizable settings available for a specific Domain within DRIVR.
Values
| Enum Value | Description |
|---|---|
|
|
Determines whether the User belonging to an Organization should be deleted or archived when the Organization is deleted or archived. The default value is true. |
|
|
Determines whether Users are required to provide an email address when creating an Account. The default value is true. |
|
|
Whether the User must provide a password when creating an Account. The default value is true. |
Example
"DELETE_ARCHIVE_ORGANIZATION_USERS"
DomainFeatureSlugQueryField
Description
Apply the filter operation to domain-feature-slug value.
Fields
| Input Field | Description |
|---|---|
_eq - DomainFeatureSlug
|
Equals |
_in - [DomainFeatureSlug]
|
Is in the list |
_neq - DomainFeatureSlug
|
Does NOT equal |
_nin - [DomainFeatureSlug]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "DELETE_ARCHIVE_ORGANIZATION_USERS",
"_in": ["DELETE_ARCHIVE_ORGANIZATION_USERS"],
"_neq": "DELETE_ARCHIVE_ORGANIZATION_USERS",
"_nin": ["DELETE_ARCHIVE_ORGANIZATION_USERS"],
"_null": true
}
Empty
Description
Represents an Empty value.
Example
Empty
EmptyResult
Description
An empty response.
Fields
| Field Name | Description |
|---|---|
ok - Empty
|
Example
{"ok": Empty}
Entity
Description
An entity in the system with a unique ID.
Fields
| Field Name | Description |
|---|---|
uuid - UUID!
|
The unique ID for referencing the entity. |
Possible Types
| Entity Types |
|---|
Example
{
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
Event
Description
An Event is a single occurrence of a specific EventModel. It contains information such as the start and end time of the event, its status, metadata information, and acknowledgments related to it.
Fields
| Field Name | Description |
|---|---|
acknowledged - Boolean
|
A flag indicates if the entity is acknowledged. |
acks - PagedEventAcks!
|
A list of acknowledgments made by users related to this Event. This includes information about the user who made the acknowledgment, the time it was made, and any comments or metadata associated with it. The acknowledgments can be filtered using the where queries. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
endTime - DateTime
|
The end time of the Event. |
entity - EventEntity
|
The event's Entity. |
entityUuid - UUID
|
The UUID of the Event's Entity. |
eventModel - EventModel
|
The entity's EventModel. |
eventModelUuid - UUID
|
The UUID of the entity's EventModel. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
status - EventStatus
|
The current status of the Event. |
time - DateTime!
|
The start time of the Event. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"acknowledged": true,
"acks": PagedEventAcks,
"createdAt": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"entity": Component,
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"eventModel": EventModel,
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"status": "ACTIVE",
"time": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
EventAck
Description
An event acknowledgment indicates if a user has seen the corresponding event. When an event is acknowledged, it is flagged as viewed by the user performing the acknowledgement.
Fields
| Field Name | Description |
|---|---|
eventUuid - UUID!
|
The UUID of the event that this acknowledgement is for. |
time - DateTime!
|
The time when the event has been acknowledged by the user. |
user - User!
|
The user that performed the acknowledgment. |
userUuid - UUID!
|
The UUID of the user who has acknowledged the event. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"eventUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"time": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
EventAckOrderByQuery
Description
Sorting and ordering options for the EventAck query.
Fields
| Input Field | Description |
|---|---|
time - OrderByDirection
|
Order EventAck by time field. |
userUuid - OrderByDirection
|
Order EventAck by uuid field of associated User. |
uuid - OrderByDirection
|
Order EventAck by uuid field. |
Example
{"time": "ASC", "userUuid": "ASC", "uuid": "ASC"}
EventAckWhereQuery
Description
The EventAckWhereQuery is a WHERE query that allows you to specify filtersfor retrieving EventAck objects based on their attributes.
Fields
| Input Field | Description |
|---|---|
_and - [EventAckWhereQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [EventAckWhereQuery]
|
One of the passed entities must match |
time - DateTimeQueryField
|
Filter by the time of the EventAck. |
user - NestedUserQuery
|
Filters that can be used to filter and retrieve Users associated with the EventAck. |
userUuid - UuidQueryField
|
Filter by the UUID of the user associated with the EventAck. |
uuid - UuidQueryField
|
The UUID of the EventAck. |
Example
{
"_and": [EventAckWhereQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [EventAckWhereQuery],
"time": DateTimeQueryField,
"user": NestedUserQuery,
"userUuid": UuidQueryField,
"uuid": UuidQueryField
}
EventEntities
Fields
| Input Field | Description |
|---|---|
component - NestedComponentQuery
|
Filters that can be used to filter and retrieve Component associated with the Event. |
system - NestedSystemQuery
|
Filters that can be used to filter and retrieve System associated with the Event . |
Example
{
"component": NestedComponentQuery,
"system": NestedSystemQuery
}
EventEntity
EventEntityType
Description
The type of DRIVR entity which an Event should be emitted for.
Values
| Enum Value | Description |
|---|---|
|
|
Generating Events for this EventModel is only permitted for Component entities. |
|
|
Allow corresponding Events to only be emitted for Systems. |
Example
"COMPONENT"
EventEntityTypeQueryField
Description
Apply the filter operation to event-entity-type value.
Fields
| Input Field | Description |
|---|---|
_eq - EventEntityType
|
Equals |
_in - [EventEntityType]
|
Is in the list |
_neq - EventEntityType
|
Does NOT equal |
_nin - [EventEntityType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "COMPONENT",
"_in": ["COMPONENT"],
"_neq": "COMPONENT",
"_nin": ["COMPONENT"],
"_null": true
}
EventFilterQuery
Fields
| Input Field | Description |
|---|---|
_and - [EventFilterQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [EventFilterQuery]
|
One of the passed entities must match |
acknowledged - BoolQueryField
|
Filter by the acknowledged status of the Event. |
createdAt - DateTimeQueryField
|
|
endTime - DateTimeQueryField
|
Filter by the end time of the Event. |
entityUuid - UuidQueryField
|
Filter by the UUID of the entity associated with the Event. |
eventModel - NestedEventModelQuery
|
Filters that can be used to filter and retrieve EventModel associated with the Event. |
eventType - EventTypeQueryField
|
Filter by the type of the Event. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
status - EventStatusQueryField
|
Filter by the status of the Event. |
time - DateTimeQueryField
|
Filter by the start time of the Event. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the Event. |
Example
{
"_and": [EventFilterQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [EventFilterQuery],
"acknowledged": BoolQueryField,
"createdAt": DateTimeQueryField,
"endTime": DateTimeQueryField,
"entityUuid": UuidQueryField,
"eventModel": NestedEventModelQuery,
"eventType": EventTypeQueryField,
"from": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"status": EventStatusQueryField,
"time": DateTimeQueryField,
"to": "2007-12-03T10:15:30Z",
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
EventLevel
Description
The configuration of the severity of Events is determined by the event level of an EventModel.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates an Event related to an error that has occurred. |
|
|
Used for informational Events transmitted to DRIVR. |
|
|
Outlines a successful Event occurrence. |
|
|
Relates to a warning Event message. |
Example
"ERROR"
EventLevelQueryField
Description
Apply the filter operation to event-level value.
Fields
| Input Field | Description |
|---|---|
_eq - EventLevel
|
Equals |
_in - [EventLevel]
|
Is in the list |
_neq - EventLevel
|
Does NOT equal |
_nin - [EventLevel]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "ERROR",
"_in": ["ERROR"],
"_neq": "ERROR",
"_nin": ["ERROR"],
"_null": true
}
EventModel
Description
An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).
Fields
| Field Name | Description |
|---|---|
code - String
|
Defines a human-readable identifier for the EventModel. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
entityType - EventEntityType!
|
Describes the type of DRIVR entity an Event can correspond to e.g. Component or System |
eventLevel - EventLevel
|
The configuration of the severity level of the Events. |
eventModelLinks - PagedEventModelLinks!
|
A paged list of EventModelLinks belonging to the EventModel. They describe the connection between the EventModel and other DRIVR entities (e.g. Component, …). |
Arguments
|
|
eventType - EventType!
|
Determines if the Events are of type SINGLE_POINT or RANGED. SINGLE_POINT Events are emitted for a single point in time. RANGED Events are emitted for a range of time. |
limitToPrototypes - Boolean
|
Whether Events may be emitted for all instances of a specific EntityType or only certain entity prototypes (e.g. whether an Event can be emitted for all Components or only for Components that correspond to a certain ComponentModel). This can be configured by creating EventModelLinks. Can't be set to true if the entity type is a System. |
message - String
|
An optional message which can provide more detail about the derived Events. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"code": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "COMPONENT",
"eventLevel": "ERROR",
"eventModelLinks": PagedEventModelLinks,
"eventType": "RANGED",
"limitToPrototypes": true,
"message": "abc123",
"metadataKeyValueStore": [MetadataKeyValuePair],
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
EventModelCode
Description
Represents an element that groups together multiple instances of an EventModel using the same code. The code represents a specific type of event that can occur in multiple instances.
Fields
| Field Name | Description |
|---|---|
code - String!
|
The code of the EventModel instances that this element has been grouped by. The code is a unique identifier that allows instances of the same EventModel type to be grouped together. This field is a required input. |
Example
{"code": "xyz789"}
EventModelLink
Description
A EventModelLink is the relationship between a prototype and EventModel. For example, it describes which _ComponentModel_s can feature which EventModel.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
eventModel - EventModel
|
The entity's EventModel. |
eventModelUuid - UUID
|
The UUID of the entity's EventModel. |
prototype - EventModelPrototype
|
The entity's Prototype. |
prototypeUuid - UUID
|
The UUID of the entity's Prototype. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"eventModel": EventModel,
"eventModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"prototype": ComponentModel,
"prototypeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
EventModelLinkOrderByQuery
Description
Sorting and ordering options for EventModelLinks.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
Order EventModelLink by createdAt field. |
eventModelUuid - OrderByDirection
|
Order EventModelLink by uuid field of associated EventModel. |
prototypeUuid - OrderByDirection
|
Order EventModelLink by uuid field of associated prototype. |
status - OrderByDirection
|
Order EventModelLink by status field. |
updatedAt - OrderByDirection
|
Order EventModelLink by updatedAt field. |
uuid - OrderByDirection
|
Order EventModelLink by uuid field. |
Example
{
"createdAt": "ASC",
"eventModelUuid": "ASC",
"prototypeUuid": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
EventModelLinkQuery
Description
EventModelLinkQuery provides complex filter over EventModelLinks
Fields
| Input Field | Description |
|---|---|
_and - [EventModelLinkQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [EventModelLinkQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
eventModel - NestedEventModelQuery
|
Filter by EventModel associated with the EventModelLink. |
prototypeUuid - UuidQueryField
|
Filter by prototype UUID associated with the EventModelLink. |
status - StatusQueryField
|
Filter by status of the EventModelLink. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid of the EventModelLink. |
Example
{
"_and": [EventModelLinkQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [EventModelLinkQuery],
"createdAt": DateTimeQueryField,
"eventModel": NestedEventModelQuery,
"prototypeUuid": UuidQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
EventModelOrderByQuery
Description
Sorting and ordering options for EventModels.
Fields
| Input Field | Description |
|---|---|
code - OrderByDirection
|
Order EventModel by code field. |
createdAt - OrderByDirection
|
Order EventModel by createdAt field. |
entityType - OrderByDirection
|
Order EventModel by entityType field. |
eventLevel - OrderByDirection
|
Order EventModel by the severity level configuration. |
eventType - OrderByDirection
|
Order EventModel by eventType field. |
limitToPrototypes - OrderByDirection
|
Order EventModel by the limitToPrototypes setting. |
message - OrderByDirection
|
Order EventModel by message field. |
status - OrderByDirection
|
Order EventModel by status field. |
updatedAt - OrderByDirection
|
Order EventModel by updatedAt field. |
uuid - OrderByDirection
|
Order EventModel by uuid field. |
Example
{
"code": "ASC",
"createdAt": "ASC",
"entityType": "ASC",
"eventLevel": "ASC",
"eventType": "ASC",
"limitToPrototypes": "ASC",
"message": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
EventModelPrototype
Description
The prototype of an event model link which must be of a certain type, depending on the type specified in the event model.
Types
| Union Types |
|---|
Example
ComponentModel
EventModelQuery
Description
A complex filter allowing for more granular filtering over EventModels.
Fields
| Input Field | Description |
|---|---|
_and - [EventModelQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [EventModelQuery]
|
One of the passed entities must match |
code - StringQueryField
|
Filter by the code of the EventModel. |
createdAt - DateTimeQueryField
|
|
entityType - EventEntityTypeQueryField
|
Filter by the entityType of the EventModel. |
eventLevel - EventLevelQueryField
|
Filter by the severity level configuration of the EventModel. |
eventType - EventTypeQueryField
|
Filter by the eventType of the EventModel. |
limitToPrototypes - BoolQueryField
|
Filter by the limitToPrototypes setting of the EventModel. |
message - StringQueryField
|
Filter by the message of the EventModel. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
status - StatusQueryField
|
Filter by the status of the EventModel. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by the UUID of the EventModel. |
Example
{
"_and": [EventModelQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [EventModelQuery],
"code": StringQueryField,
"createdAt": DateTimeQueryField,
"entityType": EventEntityTypeQueryField,
"eventLevel": EventLevelQueryField,
"eventType": EventTypeQueryField,
"limitToPrototypes": BoolQueryField,
"message": StringQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
EventOrderByQuery
Description
Sorting and ordering options for Events.
Fields
| Input Field | Description |
|---|---|
acknowledged - OrderByDirection
|
Order Event by acknowledged field. |
createdAt - OrderByDirection
|
Order Event by createdAt field. |
endTime - OrderByDirection
|
Order Event by endTime field. |
entityUuid - OrderByDirection
|
Order Event by uuid field of associated entity. |
eventModelUuid - OrderByDirection
|
Order Event by uuid field of associated EventModel. |
status - OrderByDirection
|
Order Event by status field. |
time - OrderByDirection
|
Order Event by time field. |
updatedAt - OrderByDirection
|
Order Event by updatedAt field. |
uuid - OrderByDirection
|
Order Event by uuid field. |
Example
{
"acknowledged": "ASC",
"createdAt": "ASC",
"endTime": "ASC",
"entityUuid": "ASC",
"eventModelUuid": "ASC",
"status": "ASC",
"time": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
EventQuery
Description
The EventQuery is a WHERE query that allows you to specify filtersfor retrieving Event objects based on their attributes.
Fields
| Input Field | Description |
|---|---|
_and - [EventQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [EventQuery]
|
One of the passed entities must match |
acknowledged - BoolQueryField
|
Filter by the acknowledged status of the Event. |
component - NestedComponentQuery
|
Filters that can be used to filter and retrieve Component associated with the Event. |
createdAt - DateTimeQueryField
|
|
endTime - DateTimeQueryField
|
Filter by the end time of the Event. |
entity - EventEntities
|
|
entityUuid - UuidQueryField
|
Filter by the UUID of the entity associated with the Event. |
eventModel - NestedEventModelQuery
|
Filters that can be used to filter and retrieve EventModel associated with the Event. |
eventType - EventTypeQueryField
|
Filter by the type of the Event. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
status - EventStatusQueryField
|
Filter by the status of the Event. |
system - NestedSystemQuery
|
Filters that can be used to filter and retrieve System associated with the Event. It does not matter if the Event is directly connected to the System or to a Component which is connected to the System. This query will resolve both. |
time - DateTimeQueryField
|
Filter by the start time of the Event. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the Event. |
Example
{
"_and": [EventQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [EventQuery],
"acknowledged": BoolQueryField,
"component": NestedComponentQuery,
"createdAt": DateTimeQueryField,
"endTime": DateTimeQueryField,
"entity": EventEntities,
"entityUuid": UuidQueryField,
"eventModel": NestedEventModelQuery,
"eventType": EventTypeQueryField,
"from": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"status": EventStatusQueryField,
"system": NestedSystemQuery,
"time": DateTimeQueryField,
"to": "2007-12-03T10:15:30Z",
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
EventStatus
Description
The status for an Event.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
EventStatusQueryField
Description
Apply the filter operation to event-status value.
Fields
| Input Field | Description |
|---|---|
_eq - EventStatus
|
Equals |
_in - [EventStatus]
|
Is in the list |
_neq - EventStatus
|
Does NOT equal |
_nin - [EventStatus]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "ACTIVE",
"_in": ["ACTIVE"],
"_neq": "ACTIVE",
"_nin": ["ACTIVE"],
"_null": true
}
EventType
Description
Configuration of the severity level of the derived Events.
Values
| Enum Value | Description |
|---|---|
|
|
Utilised for Events which occur over a range of time. |
|
|
Used for Events emitted for a single point in time. |
Example
"RANGED"
EventTypeQueryField
Description
Apply the filter operation to event-type value.
Fields
| Input Field | Description |
|---|---|
_eq - EventType
|
Equals |
_in - [EventType]
|
Is in the list |
_neq - EventType
|
Does NOT equal |
_nin - [EventType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "RANGED",
"_in": ["RANGED"],
"_neq": "RANGED",
"_nin": ["RANGED"],
"_null": true
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FloatAggregates
Fields
| Input Field | Description |
|---|---|
avg - FloatQueryField
|
|
count - IntQueryField
|
|
first - FloatQueryField
|
|
last - FloatQueryField
|
|
max - FloatQueryField
|
|
min - FloatQueryField
|
|
sum - FloatQueryField
|
Example
{
"avg": FloatQueryField,
"count": IntQueryField,
"first": FloatQueryField,
"last": FloatQueryField,
"max": FloatQueryField,
"min": FloatQueryField,
"sum": FloatQueryField
}
FloatQueryField
Description
Apply the filter operation to Float value.
Example
{
"_eq": 123.45,
"_gt": 123.45,
"_gte": 987.65,
"_in": [987.65],
"_lt": 987.65,
"_lte": 123.45,
"_neq": 123.45,
"_nin": [987.65],
"_null": false
}
GenericOAuthLoginMethod
Description
The interface representing a LoginMethod the User has to authenticate against DRIVR via an external OAuth provider.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainAuthenticationMethod - AuthenticationMethod
|
The entity's DomainAuthenticationMethod. |
domainAuthenticationMethodUuid - UUID
|
The UUID of the entity's DomainAuthenticationMethod. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
externalId - String
|
The ID the entity is known for on the referenced third party system. |
preferredUsername - String
|
The username which is the name indicated by another OAuth server the user should ideally have. |
type - LoginMethod
|
The login method type of the entity. Describes the type of authentication which can be used with this Entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
user - User
|
The User linked to the entity. This field provides more information about the User linked to the entity. |
userUuid - UUID
|
The UUID of the User linked to the entity. This is usually the owner or person who created the entity. They also could have been assigned to it after creation by another User. |
username - String
|
The name of the User used for login against DRIVR. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Possible Types
| GenericOAuthLoginMethod Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainAuthenticationMethod": AzureAuthenticationMethod,
"domainAuthenticationMethodUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"externalId": "abc123",
"preferredUsername": "abc123",
"type": "OAUTH_AZURE",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"username": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
GoogleAuthenticationMethod
Description
DomainAuthenticationMethod for authenticating DRIVR entities against Google's OAUTH service.
Fields
| Field Name | Description |
|---|---|
authenticationType - DomainAuthenticationMethod
|
The type of authentication method. |
configuration - GoogleAuthenticationMethodConfiguration
|
Configuration for Google's OAUTH service. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"authenticationType": "AZURE_AD",
"configuration": GoogleAuthenticationMethodConfiguration,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
GoogleAuthenticationMethodConfiguration
Description
Configuration options for Google's OAUTH service.
Fields
| Field Name | Description |
|---|---|
clientId - String!
|
The client_id used to authenticate DRIVR against the Google authentication service. |
clientSecret - String!
|
The client_secret used to authenticate DRIVR against the Google authentication service. |
scopes - [String!]!
|
The list of authentication scopes for the Google authentication service. |
Example
{
"clientId": "xyz789",
"clientSecret": "abc123",
"scopes": ["abc123"]
}
GoogleLoginMethod
Description
A LoginMethod is a method of authentication that a User can use to authenticate against DRIVR. This indicates the User to be able to authenticate against a Google OAuth Server.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainAuthenticationMethod - AuthenticationMethod
|
The entity's DomainAuthenticationMethod. |
domainAuthenticationMethodUuid - UUID
|
The UUID of the entity's DomainAuthenticationMethod. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
externalId - String
|
The ID the entity is known for on the referenced third party system. |
preferredUsername - String
|
The username which is the name indicated by another OAuth server the user should ideally have. |
type - LoginMethod
|
The login method type of the entity. Describes the type of authentication which can be used with this Entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
user - User
|
The User linked to the entity. This field provides more information about the User linked to the entity. |
userUuid - UUID
|
The UUID of the User linked to the entity. This is usually the owner or person who created the entity. They also could have been assigned to it after creation by another User. |
username - String
|
The name of the User used for login against DRIVR. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainAuthenticationMethod": AzureAuthenticationMethod,
"domainAuthenticationMethodUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"externalId": "xyz789",
"preferredUsername": "xyz789",
"type": "OAUTH_AZURE",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"username": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
GrantType
Values
| Enum Value | Description |
|---|---|
|
|
For confidential and public clients using a server-based flow such as the authorization code grant type, this is used to exchange an authorization code for an access token. |
|
|
Resource Owner Password Credentials Grant allows exchanging a username and password for an access token. |
|
|
Enables the issuance of a refresh token. They are long-lasting credentials used to request additional access tokens. The refresh token is bound to the client to which it was issued. This can be combined with other grant_types. |
Example
"AUTHORIZATION_CODE"
Having
Fields
| Input Field | Description |
|---|---|
count - IntQueryField
|
Example
{"count": IntQueryField}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
IntQueryField
Description
Apply the filter operation to Integer value.
Example
{
"_eq": 123,
"_gt": 987,
"_gte": 987,
"_in": [987],
"_lt": 987,
"_lte": 123,
"_neq": 987,
"_nin": [987],
"_null": true
}
IntegerAggregates
Fields
| Input Field | Description |
|---|---|
avg - FloatQueryField
|
|
count - IntQueryField
|
|
first - IntQueryField
|
|
last - IntQueryField
|
|
max - IntQueryField
|
|
min - IntQueryField
|
|
sum - IntQueryField
|
Example
{
"avg": FloatQueryField,
"count": IntQueryField,
"first": IntQueryField,
"last": IntQueryField,
"max": IntQueryField,
"min": IntQueryField,
"sum": IntQueryField
}
Integration
Description
An Integration models an external application that can authenticate against DRIVR.
Fields
| Field Name | Description |
|---|---|
authentication - IntegrationAuthenticationMethod
|
The authentication method associated with the Integration. |
code - String
|
An identifier unique within all activated Integrations belonging to the same Domain. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
description - String
|
A description of the Integration. |
domain - Domain
|
The entity's Domain. |
domainUuid - UUID
|
The UUID of the entity's Domain. |
name - String
|
The name of the Integration. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"authentication": "API_TOKEN",
"code": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "abc123",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
IntegrationAuthenticationMethod
Description
The authentication method associated with the Integration.
Values
| Enum Value | Description |
|---|---|
|
|
Authentication via an API token. |
Example
"API_TOKEN"
IntegrationAuthenticationMethodQueryField
Description
Apply the filter operation to integration-authentication-method value.
Fields
| Input Field | Description |
|---|---|
_eq - IntegrationAuthenticationMethod
|
Equals |
_in - [IntegrationAuthenticationMethod]
|
Is in the list |
_neq - IntegrationAuthenticationMethod
|
Does NOT equal |
_nin - [IntegrationAuthenticationMethod]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "API_TOKEN",
"_in": ["API_TOKEN"],
"_neq": "API_TOKEN",
"_nin": ["API_TOKEN"],
"_null": true
}
IntegrationOrderByQuery
Description
Sorting and ordering options for Integrations.
Fields
| Input Field | Description |
|---|---|
authentication - OrderByDirection
|
Order Integration by authentication field. |
code - OrderByDirection
|
Order Integration by code field. |
createdAt - OrderByDirection
|
Order Integration by createdAt field. |
description - OrderByDirection
|
Order Integration by description field. |
domainUuid - OrderByDirection
|
Order Integration by uuid field of associated Domain. |
name - OrderByDirection
|
Order Integration by name field. |
status - OrderByDirection
|
Order Integration by status field. |
updatedAt - OrderByDirection
|
Order Integration by updatedAt field. |
uuid - OrderByDirection
|
Order Integration by uuid field. |
Example
{
"authentication": "ASC",
"code": "ASC",
"createdAt": "ASC",
"description": "ASC",
"domainUuid": "ASC",
"name": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
IntegrationQuery
Description
IntegrationQuery provides complex filter over Users
Fields
| Input Field | Description |
|---|---|
_and - [IntegrationQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [IntegrationQuery]
|
One of the passed entities must match |
authentication - IntegrationAuthenticationMethodQueryField
|
Filter by authentication of the Integration. |
code - StringQueryField
|
Filter by code of the Integration. |
createdAt - DateTimeQueryField
|
|
description - StringQueryField
|
Filter by description of the Integration. |
name - StringQueryField
|
Filter by name of the Integration. |
status - StatusQueryField
|
Filter by status of the Integration. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid of the Integration. |
Example
{
"_and": [IntegrationQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [IntegrationQuery],
"authentication": IntegrationAuthenticationMethodQueryField,
"code": StringQueryField,
"createdAt": DateTimeQueryField,
"description": StringQueryField,
"name": StringQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
Issuer
Description
An Issuer is a trusted entity that issues and manages digital Certificates. These digital Certificates are used to verify the authenticity of a device (System or Component) against the DRIVR MQTT Broker and enables secure communication.
Fields
| Field Name | Description |
|---|---|
ca - String
|
The ca (certificate authority) for this Issuer as a base64 encoded string. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain
|
The entity's Domain. |
domainUuid - UUID
|
The UUID of the entity's Domain. |
name - String!
|
The unique name of the Issuer. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"ca": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
IssuerOrderByQuery
Description
Sorting and ordering options for Issuers.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
Order Issuer by createdAt field. |
name - OrderByDirection
|
Order Issuer by name field. |
updatedAt - OrderByDirection
|
Order Issuer by updatedAt field. |
uuid - OrderByDirection
|
Order Issuer by uuid field. |
Example
{"createdAt": "ASC", "name": "ASC", "updatedAt": "ASC", "uuid": "ASC"}
IssuerQuery
Description
IssuerQuery provides complex filter over Issuers
Fields
| Input Field | Description |
|---|---|
_and - [IssuerQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [IssuerQuery]
|
One of the passed entities must match |
ca - StringQueryField
|
Filter by ca of the Issuer. |
certificates - NestedCertificateQuery
|
Filter by Certificates associated with the Issuer. |
createdAt - DateTimeQueryField
|
|
name - StringQueryField
|
Filter by name of the Issuer. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid of the Issuer. |
Example
{
"_and": [IssuerQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [IssuerQuery],
"ca": StringQueryField,
"certificates": NestedCertificateQuery,
"createdAt": DateTimeQueryField,
"name": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
LoginMethod
Values
| Enum Value | Description |
|---|---|
|
|
Indicates the entity to be able to login via Azure AD. |
|
|
Indicates the entity to be able to login via Google. |
|
|
Indicates the entity to be able to login via OpenID and not handling the authentication directly within DRIVR. It uses an existing bearer token from another OAuth server. |
|
|
Indicates the entity to be able to login via a set password. |
Example
"OAUTH_AZURE"
LoginMethodOrderByQuery
Description
Sorting and ordering options for LoginMethods.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
|
externalId - OrderByDirection
|
Order LoginMethod by externalId field. |
preferredUsername - OrderByDirection
|
Order LoginMethod by preferredUsername field. |
status - OrderByDirection
|
|
type - OrderByDirection
|
Order LoginMethod by type field. |
updatedAt - OrderByDirection
|
|
username - OrderByDirection
|
Order LoginMethod by username field. |
uuid - OrderByDirection
|
Example
{
"createdAt": "ASC",
"externalId": "ASC",
"preferredUsername": "ASC",
"status": "ASC",
"type": "ASC",
"updatedAt": "ASC",
"username": "ASC",
"uuid": "ASC"
}
LoginMethodQuery
Description
LoginMethodQuery provides complex filters over LoginMethods'
Fields
| Input Field | Description |
|---|---|
_and - [LoginMethodQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [LoginMethodQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
domainAuthenticationMethod - NestedDomainAuthenticationMethodQuery
|
Filter by the domain authentication method of the LoginMethod. |
externalId - StringQueryField
|
Filter by the external ID of the LoginMethod. This is only set for Azure and Google OAuth and references the ID of the user in the other system. |
preferredUsername - StringQueryField
|
Filter by the preferred username of the LoginMethod. This is only set for Azure and Google OAuth and references the username of the user in the other system. |
status - StatusQueryField
|
Filter by the status of the LoginMethod. |
type - LoginMethodQueryField
|
The type of the LoginMethod. This defines if the LoginMethod works for Azure, Google OAuth, Password, etc. |
updatedAt - DateTimeQueryField
|
|
user - NestedUserQuery
|
Filter by the user of the LoginMethod. |
username - StringQueryField
|
Filter by the username of the LoginMethod. |
uuid - UuidQueryField
|
Filter by the UUID of the LoginMethod. |
Example
{
"_and": [LoginMethodQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [LoginMethodQuery],
"createdAt": DateTimeQueryField,
"domainAuthenticationMethod": NestedDomainAuthenticationMethodQuery,
"externalId": StringQueryField,
"preferredUsername": StringQueryField,
"status": StatusQueryField,
"type": LoginMethodQueryField,
"updatedAt": DateTimeQueryField,
"user": NestedUserQuery,
"username": StringQueryField,
"uuid": UuidQueryField
}
LoginMethodQueryField
Description
Apply the filter operation to login-method value.
Fields
| Input Field | Description |
|---|---|
_eq - LoginMethod
|
Equals |
_in - [LoginMethod]
|
Is in the list |
_neq - LoginMethod
|
Does NOT equal |
_nin - [LoginMethod]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "OAUTH_AZURE",
"_in": ["OAUTH_AZURE"],
"_neq": "OAUTH_AZURE",
"_nin": ["OAUTH_AZURE"],
"_null": false
}
MachineUser
Description
A MachineUser represents an entity that can authenticate against DRIVR. It usually is a connector or service which requires access to most data of your domain.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
roleAssignments - PagedRoleAssignments!
|
A paged list of assigned RoleAssignments. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
username - String!
|
The username of the MachineUser. Must be unique per Domain. This is used for the MachineUser as a name for authentication. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"username": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MachineUserOrderByQuery
Description
Sorting and ordering options for MachineUsers.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
|
status - OrderByDirection
|
|
updatedAt - OrderByDirection
|
|
username - OrderByDirection
|
Order MachineUser by username field. |
uuid - OrderByDirection
|
Example
{
"createdAt": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"username": "ASC",
"uuid": "ASC"
}
MachineUserQuery
Description
MachineUserQuery provides complex filter over MachineUsers
Fields
| Input Field | Description |
|---|---|
_and - [MachineUserQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [MachineUserQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
status - StatusQueryField
|
Filter by status of the MachineUser. |
updatedAt - DateTimeQueryField
|
|
username - StringQueryField
|
Filter by username of the MachineUser. |
uuid - UuidQueryField
|
Filter by uuid of the MachineUser. |
Example
{
"_and": [MachineUserQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [MachineUserQuery],
"createdAt": DateTimeQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"username": StringQueryField,
"uuid": UuidQueryField
}
MetadataDataType
Description
The metadata-data-type enum lists the various data types that can be associated with MetadataType entities. Each MetadataType entity defines a specific type of metadata that can be added to a specific DRIVR entity, such as User, System, or Service.
Values
| Enum Value | Description |
|---|---|
|
|
A boolean data type represents a true or false value. |
|
|
A float data type represents a decimal number |
|
|
An integer data type represents a whole number. |
|
|
A string data type represents a sequence of characters. |
|
|
A timestamp data type represents a point in time. |
|
|
A UUID data type represents a universally unique identifier. |
Example
"BOOLEAN"
MetadataDataTypeQueryField
Description
Apply the filter operation to metadata-data-type value.
Fields
| Input Field | Description |
|---|---|
_eq - MetadataDataType
|
Equals |
_in - [MetadataDataType]
|
Is in the list |
_neq - MetadataDataType
|
Does NOT equal |
_nin - [MetadataDataType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "BOOLEAN",
"_in": ["BOOLEAN"],
"_neq": "BOOLEAN",
"_nin": ["BOOLEAN"],
"_null": false
}
MetadataGenericValueQueryField
Description
Filter by the metadata value
Fields
| Input Field | Description |
|---|---|
_and - [MetadataGenericValueQueryField]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [MetadataGenericValueQueryField]
|
One of the passed entities must match |
boolean - BoolQueryField
|
Filter by boolean metadata value |
float - FloatQueryField
|
Filter by float metadata value |
integer - IntQueryField
|
Filter by integer metadata value |
string - StringQueryField
|
Filter by string metadata value |
timestamp - DateTimeQueryField
|
Filter by timestamp metadata value |
uuid - UuidQueryField
|
Filter by uuid metadata value |
Example
{
"_and": [MetadataGenericValueQueryField],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [MetadataGenericValueQueryField],
"boolean": BoolQueryField,
"float": FloatQueryField,
"integer": IntQueryField,
"string": StringQueryField,
"timestamp": DateTimeQueryField,
"uuid": UuidQueryField
}
MetadataKeyValuePair
Description
A MetadataKeyValuePair represents a way to request metadata set on an entity in a generic value over different Domains. It is used for building applications which do work over multiple DRIVR Domains with different Metadata instead of using the Domain-specific metadata fields on the entities.
Fields
| Field Name | Description |
|---|---|
dataType - MetadataDataType!
|
The metadata data type. |
key - String!
|
The key of the metadata. |
metadataTypeUuid - String!
|
The UUID of the corresponding MetadataType. |
Possible Types
| MetadataKeyValuePair Types |
|---|
Example
{
"dataType": "BOOLEAN",
"key": "abc123",
"metadataTypeUuid": "abc123"
}
MetadataKeyValuePairBoolean
Description
A MetadataKeyValuePairBoolean is a metadata key-value pair that contains a boolean value.
Fields
| Field Name | Description |
|---|---|
dataType - MetadataDataType!
|
The metadata data type. |
key - String!
|
The key of the metadata. |
metadataTypeUuid - String!
|
The UUID of the corresponding MetadataType. |
value - Boolean
|
The boolean value contained in the MetadataKeyValuePairBoolean. |
Example
{
"dataType": "BOOLEAN",
"key": "xyz789",
"metadataTypeUuid": "abc123",
"value": true
}
MetadataKeyValuePairFloat
Description
A MetadataKeyValuePairFloat is a metadata key-value pair that contains a float value.
Fields
| Field Name | Description |
|---|---|
dataType - MetadataDataType!
|
The metadata data type. |
key - String!
|
The key of the metadata. |
metadataTypeUuid - String!
|
The UUID of the corresponding MetadataType. |
value - Float
|
The float value contained in the MetadataKeyValuePairFloat. |
Example
{
"dataType": "BOOLEAN",
"key": "xyz789",
"metadataTypeUuid": "abc123",
"value": 987.65
}
MetadataKeyValuePairInput
Fields
| Input Field | Description |
|---|---|
key - String!
|
The key of the metadata key-value pair. |
value - MetadataKeyValueValueInput!
|
Example
{
"key": "abc123",
"value": MetadataKeyValueValueInput
}
MetadataKeyValuePairInteger
Description
A MetadataKeyValuePairInteger is a metadata key-value pair that contains an integer value.
Fields
| Field Name | Description |
|---|---|
dataType - MetadataDataType!
|
The metadata data type. |
key - String!
|
The key of the metadata. |
metadataTypeUuid - String!
|
The UUID of the corresponding MetadataType. |
value - Int
|
The integer value contained in the MetadataKeyValuePairInteger. |
Example
{
"dataType": "BOOLEAN",
"key": "abc123",
"metadataTypeUuid": "abc123",
"value": 123
}
MetadataKeyValuePairString
Description
A MetadataKeyValuePairString node is a metadata key-value pair that contains a string value.
Fields
| Field Name | Description |
|---|---|
dataType - MetadataDataType!
|
The metadata data type. |
key - String!
|
The key of the metadata. |
metadataTypeUuid - String!
|
The UUID of the corresponding MetadataType. |
value - String
|
The string value contained in the MetadataKeyValuePairString. |
Example
{
"dataType": "BOOLEAN",
"key": "xyz789",
"metadataTypeUuid": "abc123",
"value": "abc123"
}
MetadataKeyValuePairTimestamp
Description
A MetadataKeyValuePairTimestamp is a metadata key-value pair that contains a timestamp value.
Fields
| Field Name | Description |
|---|---|
dataType - MetadataDataType!
|
The metadata data type. |
key - String!
|
The key of the metadata. |
metadataTypeUuid - String!
|
The UUID of the corresponding MetadataType. |
value - DateTime
|
The timestamp value contained in the MetadataKeyValuePairTimestamp. |
Example
{
"dataType": "BOOLEAN",
"key": "xyz789",
"metadataTypeUuid": "xyz789",
"value": "2007-12-03T10:15:30Z"
}
MetadataKeyValuePairUuid
Description
A MetadataKeyValuePairUuid is a metadata key-value pair that contains a UUID value.
Fields
| Field Name | Description |
|---|---|
dataType - MetadataDataType!
|
The metadata data type. |
key - String!
|
The key of the metadata. |
metadataTypeUuid - String!
|
The UUID of the corresponding MetadataType. |
value - UUID
|
The UUID value contained in the MetadataKeyValuePairUuid. |
Example
{
"dataType": "BOOLEAN",
"key": "abc123",
"metadataTypeUuid": "abc123",
"value": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MetadataKeyValueStoreQueryField
Fields
| Input Field | Description |
|---|---|
key - StringQueryField
|
|
value - MetadataGenericValueQueryField
|
Example
{
"key": StringQueryField,
"value": MetadataGenericValueQueryField
}
MetadataKeyValueValueInput
MetadataType
Description
A metadata type for entity types which can be used to configure additional metadata fields.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - MetadataDataType!
|
The data type for which this metadata type is valid. This determines which type of value may be stored in the metadata values associated with this metadata type. |
description - String
|
The description of the field this metadata type represents. |
distinctValues - PagedDistinctMetadataValues!
|
A paged list of distinct metadata values for the metadata type. |
Arguments
|
|
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Possible Types
| MetadataType Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"description": "abc123",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MetadataTypeBoolean
Description
A metadata type for entity types which can be used to configure additional metadata fields for booleans.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - MetadataDataType!
|
The data type for which this metadata type is valid. This determines which type of value may be stored in the metadata values associated with this metadata type. |
default - Boolean
|
The default value for the metadata type. |
description - String
|
The description of the field this metadata type represents. |
distinctValues - PagedDistinctMetadataValues!
|
A paged list of distinct metadata values for the metadata type. |
Arguments
|
|
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": false,
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MetadataTypeEntityTypes
Description
The type of entity that the metadata is associated with. The MetadataEntity enum lists the various entity types in DRIVR that support setting metadata.
Values
| Enum Value | Description |
|---|---|
|
|
Represents a measurement or setting specific to a ComponentModel. |
|
|
Represents the instance of a ComponentModel. |
|
|
Represents a model describing how a Component is structured in DRIVR.Components are instances of ComponentModels. |
|
|
Represents an occasion in which an activity or event took place within a System, Component, Service, or Characteristic. Events include a timestamp.Events are instances of EventModels. |
|
|
Describes a model for how an Event is structured in DRIVR. Events are created based on an EventModel. |
|
|
Represents an Organization within DRIVR that can own System and have users assigned to it. |
|
|
Describes a collection of Characteristics that share a specific data type configuration.A Service can hold several Components. |
|
|
Represents a System within DRIVR, which is a logical grouping of components that provide services. |
|
|
Represents an individual User who interacts with the application and can own a System within it. |
Example
"CHARACTERISTIC"
MetadataTypeEntityTypesQueryField
Description
Apply the filter operation to metadata-type-entity-types value.
Fields
| Input Field | Description |
|---|---|
_eq - MetadataTypeEntityTypes
|
Equals |
_in - [MetadataTypeEntityTypes]
|
Is in the list |
_neq - MetadataTypeEntityTypes
|
Does NOT equal |
_nin - [MetadataTypeEntityTypes]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "CHARACTERISTIC",
"_in": ["CHARACTERISTIC"],
"_neq": "CHARACTERISTIC",
"_nin": ["CHARACTERISTIC"],
"_null": false
}
MetadataTypeFloat
Description
A metadata type for entity types which can be used to configure additional metadata fields for floats.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - MetadataDataType!
|
The data type for which this metadata type is valid. This determines which type of value may be stored in the metadata values associated with this metadata type. |
default - Float
|
The default value for the metadata type. |
description - String
|
The description of the field this metadata type represents. |
distinctValues - PagedDistinctMetadataValues!
|
A paged list of distinct metadata values for the metadata type. |
Arguments
|
|
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": 123.45,
"description": "abc123",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MetadataTypeInteger
Description
A metadata type for entity types which can be used to configure additional metadata fields for integers.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - MetadataDataType!
|
The data type for which this metadata type is valid. This determines which type of value may be stored in the metadata values associated with this metadata type. |
default - Int
|
The default value for the metadata type. |
description - String
|
The description of the field this metadata type represents. |
distinctValues - PagedDistinctMetadataValues!
|
A paged list of distinct metadata values for the metadata type. |
Arguments
|
|
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
unique - Boolean
|
Specifies the individual value within the entities of this metadata type to must be unique. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": 987,
"description": "abc123",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"unique": true,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MetadataTypeOrderByQuery
Description
Sorting and ordering options for MetadataType entities within DRIVR.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
Order MetadataType by createdAt field. |
dataType - OrderByDirection
|
|
defaultValue - OrderByDirection
|
|
description - OrderByDirection
|
Order MetadataType by description field. |
entityType - OrderByDirection
|
Order MetadataType by entityType field. |
key - OrderByDirection
|
Order MetadataType by key field. |
mandatory - OrderByDirection
|
Order MetadataType by mandatory field. |
unique - OrderByDirection
|
Order MetadataType by unique field. |
updatedAt - OrderByDirection
|
Order MetadataType by updatedAt field. |
uuid - OrderByDirection
|
Order MetadataType by uuid field. |
Example
{
"createdAt": "ASC",
"dataType": "ASC",
"defaultValue": "ASC",
"description": "ASC",
"entityType": "ASC",
"key": "ASC",
"mandatory": "ASC",
"unique": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
MetadataTypeQuery
Description
Use this query to filter by MetadataType entities within DRIVR.
Fields
| Input Field | Description |
|---|---|
_and - [MetadataTypeQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [MetadataTypeQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
dataType - MetadataDataTypeQueryField
|
Filter by data type of MetadataType. |
defaults - DefaultValueQueryField
|
|
description - StringQueryField
|
Filter by description of MetadataType. |
entityType - MetadataTypeEntityTypesQueryField
|
Filter by entity type of MetadataType. |
key - StringQueryField
|
Filter by key of MetadataType. |
unique - BoolQueryField
|
Filter by unique of MetadataType. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by UUID of MetadataType. |
Example
{
"_and": [MetadataTypeQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [MetadataTypeQuery],
"createdAt": DateTimeQueryField,
"dataType": MetadataDataTypeQueryField,
"defaults": DefaultValueQueryField,
"description": StringQueryField,
"entityType": MetadataTypeEntityTypesQueryField,
"key": StringQueryField,
"unique": BoolQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
MetadataTypeString
Description
A metadata type for entity types which can be used to configure additional metadata fields for strings.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - MetadataDataType!
|
The data type for which this metadata type is valid. This determines which type of value may be stored in the metadata values associated with this metadata type. |
default - String
|
The default value for the metadata type. |
description - String
|
The description of the field this metadata type represents. |
distinctValues - PagedDistinctMetadataValues!
|
A paged list of distinct metadata values for the metadata type. |
Arguments
|
|
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
unique - Boolean
|
Specifies the individual value within the entities of this metadata type to must be unique. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": "xyz789",
"description": "abc123",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"unique": false,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MetadataTypeTimestamp
Description
A metadata type for entity types which can be used to configure additional metadata fields for timestamps.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - MetadataDataType!
|
The data type for which this metadata type is valid. This determines which type of value may be stored in the metadata values associated with this metadata type. |
default - DateTime
|
The default value for the metadata type. |
description - String
|
The description of the field this metadata type represents. |
distinctValues - PagedDistinctMetadataValues!
|
A paged list of distinct metadata values for the metadata type. |
Arguments
|
|
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": "2007-12-03T10:15:30Z",
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MetadataTypeUuid
Description
A metadata type for entity types which can be used to configure additional metadata fields for uuids.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataType - MetadataDataType!
|
The data type for which this metadata type is valid. This determines which type of value may be stored in the metadata values associated with this metadata type. |
default - UUID
|
The default value for the metadata type. |
description - String
|
The description of the field this metadata type represents. |
distinctValues - PagedDistinctMetadataValues!
|
A paged list of distinct metadata values for the metadata type. |
Arguments
|
|
entityType - MetadataTypeEntityTypes!
|
The entity type which this metadata type is valid for. Each metadata type key must be unique within the same entity types. |
key - String!
|
The name of the field this metadata type represents. It must be unique of all ACTIVATED metadata types. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataType": "BOOLEAN",
"default": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"description": "xyz789",
"distinctValues": PagedDistinctMetadataValues,
"entityType": "CHARACTERISTIC",
"key": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MeteringRecord
Description
A single record tracking event quantities over a flexible but distinct timeframe.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
entityType - MeteringRecordEntityType!
|
The type of the entity for which this MeteringRecord tracks event quantities. |
entityUuid - UUID!
|
The UUID of the entity for which this MeteringRecord tracks event quantities. |
eventCount - Int!
|
The number of events this MeteringRecord tracks. |
eventType - MeteringRecordEventType!
|
The type of events this MeteringRecord tracks. |
time - DateTime!
|
The start of the timeframe this MeteringRecord tracks. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "DOMAIN",
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"eventCount": 987,
"eventType": "DATAPOINT_CREATED",
"time": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
MeteringRecordBaseQuery
Description
Retrieves matching MeteringRecords based on specified criteria.
Fields
| Input Field | Description |
|---|---|
_and - [MeteringRecordBaseQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [MeteringRecordBaseQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
entityType - MeteringRecordEntityTypeQueryField
|
The type of the entity the MeteringRecord belongs to. |
entityUuid - UuidQueryField
|
The UUID of the entity the MeteringRecord belongs to. |
eventCount - IntQueryField
|
The number of events in the MeteringRecord. |
eventType - MeteringRecordEventTypeQueryField
|
The event type the MeteringRecord tracks. |
from - DateTime
|
The inclusive from of the window which data should be requested |
time - DateTimeQueryField
|
The time bucket this MeteringRecord represents. |
to - DateTime
|
The exclusive to of the window which data should be requested |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the MeteringRecord. |
Example
{
"_and": [MeteringRecordBaseQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [MeteringRecordBaseQuery],
"createdAt": DateTimeQueryField,
"entityType": MeteringRecordEntityTypeQueryField,
"entityUuid": UuidQueryField,
"eventCount": IntQueryField,
"eventType": MeteringRecordEventTypeQueryField,
"from": "2007-12-03T10:15:30Z",
"time": DateTimeQueryField,
"to": "2007-12-03T10:15:30Z",
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
MeteringRecordEntityType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DOMAIN"
MeteringRecordEntityTypeQueryField
Fields
| Input Field | Description |
|---|---|
_eq - MeteringRecordEntityType
|
Equals |
_in - [MeteringRecordEntityType]
|
Is in the list |
_neq - MeteringRecordEntityType
|
Does NOT equal |
_nin - [MeteringRecordEntityType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "DOMAIN",
"_in": ["DOMAIN"],
"_neq": "DOMAIN",
"_nin": ["DOMAIN"],
"_null": false
}
MeteringRecordEventType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATAPOINT_CREATED"
MeteringRecordEventTypeQueryField
Fields
| Input Field | Description |
|---|---|
_eq - MeteringRecordEventType
|
Equals |
_in - [MeteringRecordEventType]
|
Is in the list |
_neq - MeteringRecordEventType
|
Does NOT equal |
_nin - [MeteringRecordEventType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "DATAPOINT_CREATED",
"_in": ["DATAPOINT_CREATED"],
"_neq": "DATAPOINT_CREATED",
"_nin": ["DATAPOINT_CREATED"],
"_null": false
}
MeteringRecordOrderByQuery
Description
Defines the fields by which MeteringRecords can be ordered.
Fields
| Input Field | Description |
|---|---|
entityUuid - OrderByDirection
|
|
eventCount - OrderByDirection
|
|
time - OrderByDirection
|
|
uuid - OrderByDirection
|
Example
{"entityUuid": "ASC", "eventCount": "ASC", "time": "ASC", "uuid": "ASC"}
MeteringRecordResolution
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DAILY"
NestedAggregatedDatapointsWhereQuery
Fields
| Input Field | Description |
|---|---|
_and - [AggregatedDatapointsWhereQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [AggregatedDatapointsWhereQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
|
characteristicUuid - UuidQueryField
|
Filter by Characteristic UUID. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
componentModelUuid - UuidQueryField
|
Filter by ComponentModel UUID. |
componentUuid - UuidQueryField
|
Filter by Component UUID. |
domainUuid - UuidQueryField
|
Filter by Domain UUID. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
grid - Timespan
|
The timespan based chunk size by which datapoints are aggregated. Requires from and to to be set. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service & ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
Filter by Service UUID. |
system - NestedSystemQuery
|
|
systemUuid - UuidQueryField
|
Filter by System UUID. |
timeStream - NestedTimeStreamQuery
|
|
timeStreamUuid - UuidQueryField
|
Filter by TimeStream UUID. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
value - AggregateValueField
|
Example
{
"_and": [AggregatedDatapointsWhereQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [AggregatedDatapointsWhereQuery],
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"componentModelUuid": UuidQueryField,
"componentUuid": UuidQueryField,
"domainUuid": UuidQueryField,
"from": "2007-12-03T10:15:30Z",
"grid": Timespan,
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"system": NestedSystemQuery,
"systemUuid": UuidQueryField,
"timeStream": NestedTimeStreamQuery,
"timeStreamUuid": UuidQueryField,
"to": "2007-12-03T10:15:30Z",
"value": AggregateValueField
}
NestedCertificateQuery
Fields
| Input Field | Description |
|---|---|
_and - [CertificateQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [CertificateQuery]
|
One of the passed entities must match |
certificate - StringQueryField
|
The actual base64 encoded certificate of the Certificate. |
createdAt - DateTimeQueryField
|
|
csr - StringQueryField
|
The base64 encoded CSR of the Certificate. |
duration - TimespanQueryField
|
The duration of the Certificate. |
entity - CertificateEntities
|
|
entityType - CertificateEntityTypeQueryField
|
The entity type of the Certificate. |
expiresAt - DateTimeQueryField
|
The expiration date of the Certificate. |
issuer - NestedIssuerQuery
|
The issuer of the Certificate. |
name - StringQueryField
|
The name of the Certificate. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the Certificate. |
Example
{
"_and": [CertificateQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [CertificateQuery],
"certificate": StringQueryField,
"createdAt": DateTimeQueryField,
"csr": StringQueryField,
"duration": TimespanQueryField,
"entity": CertificateEntities,
"entityType": CertificateEntityTypeQueryField,
"expiresAt": DateTimeQueryField,
"issuer": NestedIssuerQuery,
"name": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedCharacteristicQuery
Fields
| Input Field | Description |
|---|---|
_and - [CharacteristicQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [CharacteristicQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by aggregated DataPoints. |
characteristicType - CharacteristicTypeQueryField
|
Filter by characteristic_type. |
code - StringQueryField
|
Filter by code. |
component - NestedComponentQuery
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by current DataPoints. |
dataType - CharacteristicDataTypeQueryField
|
Filter by data_type. |
datapoints - NestedDatapointsWhereQuery
|
Filter by DataPoints. |
description - StringQueryField
|
Filter by description. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
multiple - BoolQueryField
|
Filter by multiple. |
name - StringQueryField
|
Filter by name. |
service - NestedServiceQuery
|
|
status - StatusQueryField
|
Filter by status. |
symbol - StringQueryField
|
Filter by symbol. |
timeStreams - NestedTimeStreamQuery
|
Filter by TimeStream. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [CharacteristicQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [CharacteristicQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristicType": CharacteristicTypeQueryField,
"code": StringQueryField,
"component": NestedComponentQuery,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"dataType": CharacteristicDataTypeQueryField,
"datapoints": NestedDatapointsWhereQuery,
"description": StringQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"multiple": BoolQueryField,
"name": StringQueryField,
"service": NestedServiceQuery,
"status": StatusQueryField,
"symbol": StringQueryField,
"timeStreams": NestedTimeStreamQuery,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedComponentModelQuery
Fields
| Input Field | Description |
|---|---|
_and - [ComponentModelQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ComponentModelQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by aggregated Datapoints. |
code - StringQueryField
|
Filter by code. |
componentType - ComponentTypeQueryField
|
Filter by component_type. |
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by current Datapoints. |
datapoints - NestedDatapointsWhereQuery
|
Filter by Datapoints. |
description - StringQueryField
|
Filter by description. |
isConnective - BoolQueryField
|
Filter by is_connective. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name. |
service - NestedServiceOnComponentModelQuery
|
|
status - StatusQueryField
|
Filter by status. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [ComponentModelQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ComponentModelQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"code": StringQueryField,
"componentType": ComponentTypeQueryField,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"description": StringQueryField,
"isConnective": BoolQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"service": NestedServiceOnComponentModelQuery,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedComponentQuery
Fields
| Input Field | Description |
|---|---|
_and - [ComponentQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ComponentQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
The aggregated datapoints associated with the Component. |
characteristic - NestedCharacteristicQuery
|
|
code - StringQueryField
|
A human-readable identifier for the Component. |
componentModel - NestedComponentModelQuery
|
The model of the Component. |
connectionState - ComponentConnectionStateQueryField
|
The connection state of the Component. |
connectionStateUpdatedAt - DateTimeQueryField
|
The time at which the Component's connection state was last updated. |
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
The current datapoints associated with the Component. |
datapoints - NestedDatapointsWhereQuery
|
The datapoints associated with the Component. |
events - NestedEventFilterQuery
|
Filters that can be used to filter and retrieve Events associated with the Component. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
The name of the Component. |
service - NestedServiceOnComponentQuery
|
|
status - StatusQueryField
|
The status of the Component. |
system - NestedSystemQuery
|
The System that the Component belongs to. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the Component. |
Example
{
"_and": [ComponentQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ComponentQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"code": StringQueryField,
"componentModel": NestedComponentModelQuery,
"connectionState": ComponentConnectionStateQueryField,
"connectionStateUpdatedAt": DateTimeQueryField,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"events": NestedEventFilterQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"service": NestedServiceOnComponentQuery,
"status": StatusQueryField,
"system": NestedSystemQuery,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedCurrentDatapointsWhereQuery
Fields
| Input Field | Description |
|---|---|
_and - [CurrentDatapointsWhereQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [CurrentDatapointsWhereQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
|
characteristicUuid - UuidQueryField
|
Filter by Characteristic UUID. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
componentModelUuid - UuidQueryField
|
Filter by ComponentModel UUID. |
componentUuid - UuidQueryField
|
Filter by Component UUID. |
domainUuid - UuidQueryField
|
Filter by Domain UUID. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service & ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
Filter by Service UUID. |
system - NestedSystemQuery
|
|
systemUuid - UuidQueryField
|
Filter by System UUID. |
time - DateTimeQueryField
|
Filter by Datapoint occurrence. |
timeStream - NestedTimeStreamQuery
|
|
timeStreamUuid - UuidQueryField
|
Filter by TimeStream UUID. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
value - ValueQueryField
|
Example
{
"_and": [CurrentDatapointsWhereQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [CurrentDatapointsWhereQuery],
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"componentModelUuid": UuidQueryField,
"componentUuid": UuidQueryField,
"domainUuid": UuidQueryField,
"from": "2007-12-03T10:15:30Z",
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"system": NestedSystemQuery,
"systemUuid": UuidQueryField,
"time": DateTimeQueryField,
"timeStream": NestedTimeStreamQuery,
"timeStreamUuid": UuidQueryField,
"to": "2007-12-03T10:15:30Z",
"value": ValueQueryField
}
NestedDataSourceQuery
Fields
| Input Field | Description |
|---|---|
_and - [DataSourceQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [DataSourceQuery]
|
One of the passed entities must match |
code - StringQueryField
|
Code of the DataSources. |
createdAt - DateTimeQueryField
|
|
description - StringQueryField
|
A brief description of the DataSources. |
name - StringQueryField
|
The name of the DataSources. |
reference - StringQueryField
|
A reference to another system that the DataSources connects to. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The unique identifier for the DataSources. |
Example
{
"_and": [DataSourceQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [DataSourceQuery],
"code": StringQueryField,
"createdAt": DateTimeQueryField,
"description": StringQueryField,
"name": StringQueryField,
"reference": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedDatapointsWhereQuery
Fields
| Input Field | Description |
|---|---|
_and - [DatapointsWhereQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [DatapointsWhereQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
|
characteristicUuid - UuidQueryField
|
Filter by Characteristic UUID. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
componentModelUuid - UuidQueryField
|
Filter by ComponentModel UUID. |
componentUuid - UuidQueryField
|
Filter by Component UUID. |
domainUuid - UuidQueryField
|
Filter by Domain UUID. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service & ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
Filter by Service UUID. |
system - NestedSystemQuery
|
|
systemUuid - UuidQueryField
|
Filter by System UUID. |
time - DateTimeQueryField
|
Filter by Datapoint occurrence. |
timeStream - NestedTimeStreamQuery
|
|
timeStreamUuid - UuidQueryField
|
Filter by TimeStream UUID. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
value - ValueQueryField
|
Example
{
"_and": [DatapointsWhereQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [DatapointsWhereQuery],
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"componentModelUuid": UuidQueryField,
"componentUuid": UuidQueryField,
"domainUuid": UuidQueryField,
"from": "2007-12-03T10:15:30Z",
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"system": NestedSystemQuery,
"systemUuid": UuidQueryField,
"time": DateTimeQueryField,
"timeStream": NestedTimeStreamQuery,
"timeStreamUuid": UuidQueryField,
"to": "2007-12-03T10:15:30Z",
"value": ValueQueryField
}
NestedDomainAuthenticationMethodQuery
Fields
| Input Field | Description |
|---|---|
_and - [DomainAuthenticationMethodQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [DomainAuthenticationMethodQuery]
|
One of the passed entities must match |
authenticationType - DomainAuthenticationMethodQueryField
|
Filter DomainAuthenticationMethods by authenticationType. |
createdAt - DateTimeQueryField
|
|
status - StatusQueryField
|
Filter DomainAuthenticationMethods by status. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter DomainAuthenticationMethods by uuid. |
Example
{
"_and": [DomainAuthenticationMethodQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [DomainAuthenticationMethodQuery],
"authenticationType": DomainAuthenticationMethodQueryField,
"createdAt": DateTimeQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedEventFilterQuery
Fields
| Input Field | Description |
|---|---|
_and - [EventFilterQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [EventFilterQuery]
|
One of the passed entities must match |
acknowledged - BoolQueryField
|
Filter by the acknowledged status of the Event. |
createdAt - DateTimeQueryField
|
|
endTime - DateTimeQueryField
|
Filter by the end time of the Event. |
entityUuid - UuidQueryField
|
Filter by the UUID of the entity associated with the Event. |
eventModel - NestedEventModelQuery
|
Filters that can be used to filter and retrieve EventModel associated with the Event. |
eventType - EventTypeQueryField
|
Filter by the type of the Event. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
status - EventStatusQueryField
|
Filter by the status of the Event. |
time - DateTimeQueryField
|
Filter by the start time of the Event. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the Event. |
Example
{
"_and": [EventFilterQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [EventFilterQuery],
"acknowledged": BoolQueryField,
"createdAt": DateTimeQueryField,
"endTime": DateTimeQueryField,
"entityUuid": UuidQueryField,
"eventModel": NestedEventModelQuery,
"eventType": EventTypeQueryField,
"from": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"status": EventStatusQueryField,
"time": DateTimeQueryField,
"to": "2007-12-03T10:15:30Z",
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedEventModelQuery
Fields
| Input Field | Description |
|---|---|
_and - [EventModelQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [EventModelQuery]
|
One of the passed entities must match |
code - StringQueryField
|
Filter by the code of the EventModel. |
createdAt - DateTimeQueryField
|
|
entityType - EventEntityTypeQueryField
|
Filter by the entityType of the EventModel. |
eventLevel - EventLevelQueryField
|
Filter by the severity level configuration of the EventModel. |
eventType - EventTypeQueryField
|
Filter by the eventType of the EventModel. |
limitToPrototypes - BoolQueryField
|
Filter by the limitToPrototypes setting of the EventModel. |
message - StringQueryField
|
Filter by the message of the EventModel. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
status - StatusQueryField
|
Filter by the status of the EventModel. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by the UUID of the EventModel. |
Example
{
"_and": [EventModelQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [EventModelQuery],
"code": StringQueryField,
"createdAt": DateTimeQueryField,
"entityType": EventEntityTypeQueryField,
"eventLevel": EventLevelQueryField,
"eventType": EventTypeQueryField,
"limitToPrototypes": BoolQueryField,
"message": StringQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedEventQuery
Fields
| Input Field | Description |
|---|---|
_and - [EventQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [EventQuery]
|
One of the passed entities must match |
acknowledged - BoolQueryField
|
Filter by the acknowledged status of the Event. |
component - NestedComponentQuery
|
Filters that can be used to filter and retrieve Component associated with the Event. |
createdAt - DateTimeQueryField
|
|
endTime - DateTimeQueryField
|
Filter by the end time of the Event. |
entity - EventEntities
|
|
entityUuid - UuidQueryField
|
Filter by the UUID of the entity associated with the Event. |
eventModel - NestedEventModelQuery
|
Filters that can be used to filter and retrieve EventModel associated with the Event. |
eventType - EventTypeQueryField
|
Filter by the type of the Event. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
status - EventStatusQueryField
|
Filter by the status of the Event. |
system - NestedSystemQuery
|
Filters that can be used to filter and retrieve System associated with the Event. It does not matter if the Event is directly connected to the System or to a Component which is connected to the System. This query will resolve both. |
time - DateTimeQueryField
|
Filter by the start time of the Event. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
The UUID of the Event. |
Example
{
"_and": [EventQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [EventQuery],
"acknowledged": BoolQueryField,
"component": NestedComponentQuery,
"createdAt": DateTimeQueryField,
"endTime": DateTimeQueryField,
"entity": EventEntities,
"entityUuid": UuidQueryField,
"eventModel": NestedEventModelQuery,
"eventType": EventTypeQueryField,
"from": "2007-12-03T10:15:30Z",
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"status": EventStatusQueryField,
"system": NestedSystemQuery,
"time": DateTimeQueryField,
"to": "2007-12-03T10:15:30Z",
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedIssuerQuery
Fields
| Input Field | Description |
|---|---|
_and - [IssuerQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [IssuerQuery]
|
One of the passed entities must match |
ca - StringQueryField
|
Filter by ca of the Issuer. |
certificates - NestedCertificateQuery
|
Filter by Certificates associated with the Issuer. |
createdAt - DateTimeQueryField
|
|
name - StringQueryField
|
Filter by name of the Issuer. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid of the Issuer. |
Example
{
"_and": [IssuerQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [IssuerQuery],
"ca": StringQueryField,
"certificates": NestedCertificateQuery,
"createdAt": DateTimeQueryField,
"name": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedLoginMethodQuery
Fields
| Input Field | Description |
|---|---|
_and - [LoginMethodQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [LoginMethodQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
domainAuthenticationMethod - NestedDomainAuthenticationMethodQuery
|
Filter by the domain authentication method of the LoginMethod. |
externalId - StringQueryField
|
Filter by the external ID of the LoginMethod. This is only set for Azure and Google OAuth and references the ID of the user in the other system. |
preferredUsername - StringQueryField
|
Filter by the preferred username of the LoginMethod. This is only set for Azure and Google OAuth and references the username of the user in the other system. |
status - StatusQueryField
|
Filter by the status of the LoginMethod. |
type - LoginMethodQueryField
|
The type of the LoginMethod. This defines if the LoginMethod works for Azure, Google OAuth, Password, etc. |
updatedAt - DateTimeQueryField
|
|
user - NestedUserQuery
|
Filter by the user of the LoginMethod. |
username - StringQueryField
|
Filter by the username of the LoginMethod. |
uuid - UuidQueryField
|
Filter by the UUID of the LoginMethod. |
Example
{
"_and": [LoginMethodQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [LoginMethodQuery],
"createdAt": DateTimeQueryField,
"domainAuthenticationMethod": NestedDomainAuthenticationMethodQuery,
"externalId": StringQueryField,
"preferredUsername": StringQueryField,
"status": StatusQueryField,
"type": LoginMethodQueryField,
"updatedAt": DateTimeQueryField,
"user": NestedUserQuery,
"username": StringQueryField,
"uuid": UuidQueryField
}
NestedMetadataTypeQuery
Fields
| Input Field | Description |
|---|---|
_and - [MetadataTypeQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [MetadataTypeQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
dataType - MetadataDataTypeQueryField
|
Filter by data type of MetadataType. |
defaults - DefaultValueQueryField
|
|
description - StringQueryField
|
Filter by description of MetadataType. |
entityType - MetadataTypeEntityTypesQueryField
|
Filter by entity type of MetadataType. |
key - StringQueryField
|
Filter by key of MetadataType. |
unique - BoolQueryField
|
Filter by unique of MetadataType. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by UUID of MetadataType. |
Example
{
"_and": [MetadataTypeQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [MetadataTypeQuery],
"createdAt": DateTimeQueryField,
"dataType": MetadataDataTypeQueryField,
"defaults": DefaultValueQueryField,
"description": StringQueryField,
"entityType": MetadataTypeEntityTypesQueryField,
"key": StringQueryField,
"unique": BoolQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedOrganizationQuery
Fields
| Input Field | Description |
|---|---|
_and - [OrganizationQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [OrganizationQuery]
|
One of the passed entities must match |
alias - StringQueryField
|
Filter by alias of the Organization. |
createdAt - DateTimeQueryField
|
|
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name of the Organization. |
owner - NestedUserQuery
|
Filter by owner of the Organization. |
ownerUuid - UuidQueryField
|
Filter by the UUID of the owner of the Organization. |
sources - NestedOrganizationSourceQuery
|
Filter by OrganizationSource associated with the Organization. |
status - StatusQueryField
|
Filter by status of the Organization. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid of the Organization. |
Example
{
"_and": [OrganizationQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [OrganizationQuery],
"alias": StringQueryField,
"createdAt": DateTimeQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"owner": NestedUserQuery,
"ownerUuid": UuidQueryField,
"sources": NestedOrganizationSourceQuery,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedOrganizationSourceQuery
Fields
| Input Field | Description |
|---|---|
_and - [OrganizationSourceQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [OrganizationSourceQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
dataSource - NestedDataSourceQuery
|
Filter by DataSource associated with the OrganizationSource. |
dataSourceUuid - UuidQueryField
|
Filter by DataSource UUID associated with the OrganizationSource. |
organization - NestedOrganizationQuery
|
Filter by Organization associated with the OrganizationSource. |
organizationUuid - UuidQueryField
|
Filter by Organization UUID associated with the OrganizationSource. |
sourceId - StringQueryField
|
Filter by sourceId of the OrganizationSource. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid of the OrganizationSource. |
Example
{
"_and": [OrganizationSourceQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [OrganizationSourceQuery],
"createdAt": DateTimeQueryField,
"dataSource": NestedDataSourceQuery,
"dataSourceUuid": UuidQueryField,
"organization": NestedOrganizationQuery,
"organizationUuid": UuidQueryField,
"sourceId": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedRoleAssignmentQuery
Fields
| Input Field | Description |
|---|---|
_and - [RoleAssignmentQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [RoleAssignmentQuery]
|
One of the passed entities must match |
assigneeType - RoleAssigneeTypeQueryField
|
Filter by assignee_type. |
assigneeUuid - UuidQueryField
|
Filter by assignee_uuid. |
createdAt - DateTimeQueryField
|
|
entityType - RoleEntityTypeQueryField
|
Filter by entity_type. |
entityUuid - UuidQueryField
|
Filter by entity_uuid. |
roleUuid - UuidQueryField
|
Filter by role_uuid. |
sources - NestedRoleAssignmentSourceQuery
|
Filter by RoleAssignmentSource. |
status - StatusQueryField
|
Filter by status. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [RoleAssignmentQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [RoleAssignmentQuery],
"assigneeType": RoleAssigneeTypeQueryField,
"assigneeUuid": UuidQueryField,
"createdAt": DateTimeQueryField,
"entityType": RoleEntityTypeQueryField,
"entityUuid": UuidQueryField,
"roleUuid": UuidQueryField,
"sources": NestedRoleAssignmentSourceQuery,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedRoleAssignmentSourceQuery
Fields
| Input Field | Description |
|---|---|
_and - [RoleAssignmentSourceQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [RoleAssignmentSourceQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
dataSource - NestedDataSourceQuery
|
Filter by DataSource. |
dataSourceUuid - UuidQueryField
|
Filter by the linked DataSource uuid. |
roleAssignment - NestedRoleAssignmentQuery
|
Filter by RoleAssignment. |
roleAssignmentUuid - UuidQueryField
|
Filter by RoleAssignment uuid. |
sourceId - StringQueryField
|
Filter by source_id. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [RoleAssignmentSourceQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [RoleAssignmentSourceQuery],
"createdAt": DateTimeQueryField,
"dataSource": NestedDataSourceQuery,
"dataSourceUuid": UuidQueryField,
"roleAssignment": NestedRoleAssignmentQuery,
"roleAssignmentUuid": UuidQueryField,
"sourceId": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedServiceOnComponentModelQuery
Fields
| Input Field | Description |
|---|---|
_and - [ServiceOnComponentModelQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ServiceOnComponentModelQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by AggregatedDatapoints associated with the Services. |
characteristic - NestedCharacteristicQuery
|
|
code - StringQueryField
|
Filter by the code field of a Service. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by CurrentDatapoints associated with the Services. |
datapoints - NestedDatapointsWhereQuery
|
Filter by Datapoints associated with the Services. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name of the Service. |
serviceIndex - IntQueryField
|
Filter ServiceOnComponentModel relation using index. |
status - StatusQueryField
|
Filter by status of a Service. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"_and": [ServiceOnComponentModelQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ServiceOnComponentModelQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"code": StringQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"serviceIndex": IntQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedServiceOnComponentQuery
Fields
| Input Field | Description |
|---|---|
_and - [ServiceOnComponentQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ServiceOnComponentQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by AggregatedDatapoints associated with the Services. |
characteristic - NestedCharacteristicQuery
|
|
code - StringQueryField
|
Filter by the code field of a Service. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by CurrentDatapoints associated with the Services. |
datapoints - NestedDatapointsWhereQuery
|
Filter by Datapoints associated with the Services. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name of the Service. |
serviceIndex - IntQueryField
|
Filter ServiceOnComponent relation using index. |
status - StatusQueryField
|
Filter by status of a Service. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"_and": [ServiceOnComponentQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ServiceOnComponentQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"code": StringQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"serviceIndex": IntQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedServiceQuery
Fields
| Input Field | Description |
|---|---|
_and - [ServiceQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ServiceQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by AggregatedDatapoints associated with the Services. |
characteristic - NestedCharacteristicQuery
|
|
code - StringQueryField
|
Filter by the code field of a Service. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by CurrentDatapoints associated with the Services. |
datapoints - NestedDatapointsWhereQuery
|
Filter by Datapoints associated with the Services. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name of the Service. |
status - StatusQueryField
|
Filter by status of a Service. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"_and": [ServiceQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ServiceQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"code": StringQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedSystemQuery
Fields
| Input Field | Description |
|---|---|
_and - [SystemQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [SystemQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filters that can be used to filter and retrieve AggregatedDatapoints associated with the System. |
code - StringQueryField
|
Filter by the code of the System. |
components - NestedComponentQuery
|
Filters that can be used to filter and retrieve Components associated with the System. |
connectionState - SystemConnectionStateQueryField
|
Filter by the connection state of the System. |
connectionStateUpdatedAt - DateTimeQueryField
|
Filter by the date and time the connection state was updated for the System. |
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filters that can be used to filter and retrieve CurrentDatapoints associated with the System. |
datapoints - NestedDatapointsWhereQuery
|
Filters that can be used to filter and retrieve Datapoints associated with the System. |
description - StringQueryField
|
Filter by the description of the System. |
events - NestedEventFilterQuery
|
Filters that can be used to filter and retrieve Events associated with the System. |
locationUuid - UuidQueryField
|
Filter by the UUID of the location where the System is located. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by the name of the System. |
ownerUuid - UuidQueryField
|
Filter by the UUID of the owner of the System. |
status - StatusQueryField
|
Filter by the status of the System. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by the UUID of the System. |
Example
{
"_and": [SystemQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [SystemQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"code": StringQueryField,
"components": NestedComponentQuery,
"connectionState": SystemConnectionStateQueryField,
"connectionStateUpdatedAt": DateTimeQueryField,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"description": StringQueryField,
"events": NestedEventFilterQuery,
"locationUuid": UuidQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"ownerUuid": UuidQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedTimeStreamQuery
Fields
| Input Field | Description |
|---|---|
_and - [TimeStreamQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [TimeStreamQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by aggregated DataPoints. |
characteristic - NestedCharacteristicQuery
|
Filter by Characteristic. |
characteristicUuid - UuidQueryField
|
Filter by Characteristic uuid. |
component - NestedComponentQuery
|
|
componentUuid - UuidQueryField
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoint - NestedCurrentDatapointsWhereQuery
|
Filter by current DataPoints. |
datapoints - NestedDatapointsWhereQuery
|
Filter by DataPoints. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service and ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
|
status - StatusQueryField
|
Filter by status. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [TimeStreamQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [TimeStreamQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentUuid": UuidQueryField,
"createdAt": DateTimeQueryField,
"currentDatapoint": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedUserQuery
Fields
| Input Field | Description |
|---|---|
_and - [UserQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [UserQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
email - StringQueryField
|
|
loginMethods - NestedLoginMethodQuery
|
Filter by the login methods of the User. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
|
organization - NestedOrganizationQuery
|
|
organizationUuid - UuidQueryField
|
|
sources - NestedUserSourceQuery
|
|
status - StatusQueryField
|
|
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"_and": [UserQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [UserQuery],
"createdAt": DateTimeQueryField,
"email": StringQueryField,
"loginMethods": NestedLoginMethodQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"organization": NestedOrganizationQuery,
"organizationUuid": UuidQueryField,
"sources": NestedUserSourceQuery,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
NestedUserSourceQuery
Fields
| Input Field | Description |
|---|---|
_and - [UserSourceQuery]
|
All passed queries must match |
_having - Having
|
|
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [UserSourceQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
dataSource - NestedDataSourceQuery
|
Filter by the DataSource associated with UserSource. |
dataSourceUuid - UuidQueryField
|
Filter by the DataSource UUID associated with UserSource. |
sourceId - StringQueryField
|
Filter by the sourceId of the UserSource. |
updatedAt - DateTimeQueryField
|
|
user - NestedUserQuery
|
Filter by the User associated with UserSource. |
userUuid - UuidQueryField
|
Filter by the User UUID associated with UserSource. |
uuid - UuidQueryField
|
Filter by the UUID of the UserSource. |
Example
{
"_and": [UserSourceQuery],
"_having": Having,
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [UserSourceQuery],
"createdAt": DateTimeQueryField,
"dataSource": NestedDataSourceQuery,
"dataSourceUuid": UuidQueryField,
"sourceId": StringQueryField,
"updatedAt": DateTimeQueryField,
"user": NestedUserQuery,
"userUuid": UuidQueryField,
"uuid": UuidQueryField
}
OpenIDBearerLoginMethod
Description
A LoginMethod is a method of authentication that a User can use to authenticate against DRIVR. This indicates the User to be able to authenticate via an Bearer token from a third party OpenID server and does not handle any OAuth flow within DRIVR.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainAuthenticationMethod - AuthenticationMethod
|
The entity's DomainAuthenticationMethod. |
domainAuthenticationMethodUuid - UUID
|
The UUID of the entity's DomainAuthenticationMethod. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
externalId - String
|
The ID the entity is known for on the referenced third party system. |
preferredUsername - String
|
The username which is the name indicated by another OAuth server the user should ideally have. |
type - LoginMethod
|
The login method type of the entity. Describes the type of authentication which can be used with this Entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
user - User
|
The User linked to the entity. This field provides more information about the User linked to the entity. |
userUuid - UUID
|
The UUID of the User linked to the entity. This is usually the owner or person who created the entity. They also could have been assigned to it after creation by another User. |
username - String
|
The name of the User used for login against DRIVR. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainAuthenticationMethod": AzureAuthenticationMethod,
"domainAuthenticationMethodUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"externalId": "xyz789",
"preferredUsername": "abc123",
"type": "OAUTH_AZURE",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"username": "abc123",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
OpenIdDelegatedAuthenticationMethod
Description
DomainAuthenticationMethod that uses existing OpenID Bearer tokens issued by third-party OAuth servers.
Fields
| Field Name | Description |
|---|---|
authenticationType - DomainAuthenticationMethod
|
The type of authentication method. |
configuration - OpenIdDelegatedAuthenticationMethodConfiguration
|
Configuration options for OpenID Bearer token delegation against third-party systems. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"authenticationType": "AZURE_AD",
"configuration": OpenIdDelegatedAuthenticationMethodConfiguration,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
OpenIdDelegatedAuthenticationMethodConfiguration
Description
Configuration options for OpenID Bearer token delegation.
Example
{
"clientId": "xyz789",
"issuer": "abc123"
}
OrderByDirection
Description
The direction in which items should be ordered while sorting. Valid order-by-direction values are ASC (sort items from least-to-greatest) and DESC (sort items from greatest-to-least). This enum can be particularly useful in specifying how to sort data within DRIVR.
Values
| Enum Value | Description |
|---|---|
|
|
Sort items from least-to-greatest. |
|
|
Sort items from greatest-to-least. |
Example
"ASC"
Organization
Description
A logically grouped collection of Users within a Domain, such as a team working together or a company. An Organization can own Systems.
Fields
| Field Name | Description |
|---|---|
alias - String
|
An additional unique field for referencing the entity. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
The non-unique, human-readable identifier for the Organization. |
owner - User
|
The User who owns the entity. This field provides more information about the User who owns the entity. |
ownerUuid - UUID
|
The UUID of the User who owns the entity. |
roleAssignments - PagedRoleAssignments!
|
A paged list of assigned RoleAssignments. |
Arguments
|
|
sources - PagedOrganizationSources!
|
A paged list of OrganizationSources belonging to the Organization. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
systems - PagedSystems!
|
A paged list of Systems belonging to the Organization. |
Arguments
|
|
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
users - PagedUsers!
|
A paged list of Users belonging to the Organization. |
Arguments
|
|
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"alias": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"owner": User,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"sources": PagedOrganizationSources,
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"users": PagedUsers,
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
OrganizationOrderByQuery
Description
Defines the sorting order for Organization.
Fields
| Input Field | Description |
|---|---|
alias - OrderByDirection
|
Order Organization by alias field. |
createdAt - OrderByDirection
|
Order Organization by createdAt field. |
name - OrderByDirection
|
Order Organization by name field. |
ownerUuid - OrderByDirection
|
Order Organization by uuid field of associated owner. |
status - OrderByDirection
|
Order Organization by status field. |
updatedAt - OrderByDirection
|
Order Organization by updatedAt field. |
uuid - OrderByDirection
|
Order Organization by uuid field. |
Example
{
"alias": "ASC",
"createdAt": "ASC",
"name": "ASC",
"ownerUuid": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
OrganizationQuery
Description
Allows filtering of Organizations using various filters.
Fields
| Input Field | Description |
|---|---|
_and - [OrganizationQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [OrganizationQuery]
|
One of the passed entities must match |
alias - StringQueryField
|
Filter by alias of the Organization. |
createdAt - DateTimeQueryField
|
|
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name of the Organization. |
owner - NestedUserQuery
|
Filter by owner of the Organization. |
ownerUuid - UuidQueryField
|
Filter by the UUID of the owner of the Organization. |
sources - NestedOrganizationSourceQuery
|
Filter by OrganizationSource associated with the Organization. |
status - StatusQueryField
|
Filter by status of the Organization. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid of the Organization. |
Example
{
"_and": [OrganizationQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [OrganizationQuery],
"alias": StringQueryField,
"createdAt": DateTimeQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"owner": NestedUserQuery,
"ownerUuid": UuidQueryField,
"sources": NestedOrganizationSourceQuery,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
OrganizationSource
Description
This node represents an Organization's source in DRIVR. An Organization can have multiple sources. They represent a link to another third party application and describes the unique ID of the Organization in that application.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataSource - DataSource
|
The DataSource linked to the the entity. |
dataSourceUuid - UUID
|
The UUID of the DataSource linked to the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
organization - Organization
|
The entity's Organization. |
organizationUuid - UUID
|
The UUID of the entity's Organization. |
sourceId - String
|
An identifier in an external system. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataSource": DataSource,
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"organization": Organization,
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sourceId": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
OrganizationSourceOrderByQuery
Description
Defines the sorting order for OrganizationSource.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
Order OrganizationSource by createdAt field. |
dataSourceUuid - OrderByDirection
|
Order OrganizationSource by uuid field of associated DataSource. |
organizationUuid - OrderByDirection
|
Order OrganizationSource by uuid field of associated Organization. |
sourceId - OrderByDirection
|
Order OrganizationSource by sourceId field. |
updatedAt - OrderByDirection
|
Order OrganizationSource by updatedAt field. |
uuid - OrderByDirection
|
Order OrganizationSource by uuid field. |
Example
{
"createdAt": "ASC",
"dataSourceUuid": "ASC",
"organizationUuid": "ASC",
"sourceId": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
OrganizationSourceQuery
Description
Allows filtering of OrganizationSources using various filters.
Fields
| Input Field | Description |
|---|---|
_and - [OrganizationSourceQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [OrganizationSourceQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
dataSource - NestedDataSourceQuery
|
Filter by DataSource associated with the OrganizationSource. |
dataSourceUuid - UuidQueryField
|
Filter by DataSource UUID associated with the OrganizationSource. |
organization - NestedOrganizationQuery
|
Filter by Organization associated with the OrganizationSource. |
organizationUuid - UuidQueryField
|
Filter by Organization UUID associated with the OrganizationSource. |
sourceId - StringQueryField
|
Filter by sourceId of the OrganizationSource. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid of the OrganizationSource. |
Example
{
"_and": [OrganizationSourceQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [OrganizationSourceQuery],
"createdAt": DateTimeQueryField,
"dataSource": NestedDataSourceQuery,
"dataSourceUuid": UuidQueryField,
"organization": NestedOrganizationQuery,
"organizationUuid": UuidQueryField,
"sourceId": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
PagedAggregatedDatapoints
Description
A paged list of aggregated datapoints.
Fields
| Field Name | Description |
|---|---|
cursor - String
|
The cursor for requesting the next batch of items. |
items - [AggregatedDatapoint!]!
|
|
limit - Int!
|
The maximum number of items requested. |
Example
{
"cursor": "xyz789",
"items": [AggregatedDatapoint],
"limit": 123
}
PagedAggregatedEvents
Description
A paged list for event aggregation results
Fields
| Field Name | Description |
|---|---|
cursor - String
|
The cursor for requesting the next batch of items. |
items - [AggregatedEvent!]!
|
A list of Event Aggregation results. |
limit - Int!
|
The maximum number of items requested. |
Example
{
"cursor": "abc123",
"items": [AggregatedEvent],
"limit": 123
}
PagedApplicationConsumers
Description
Retrieves a paged list of ApplicationConsumer instances within DRIVR, with optional offset and limit parameters for pagination.
Fields
| Field Name | Description |
|---|---|
items - [ApplicationConsumer!]!
|
A list of ApplicationConsumer instances within DRIVR. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [ApplicationConsumer],
"limit": 987,
"offset": 123,
"totalItems": 987
}
PagedAuthenticationMethods
Description
A paged list of AuthenticationMethods.
Fields
| Field Name | Description |
|---|---|
items - [AuthenticationMethod!]!
|
A list of AuthenticationMethods. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [AzureAuthenticationMethod],
"limit": 987,
"offset": 123,
"totalItems": 123
}
PagedCertificates
Description
A paged list of Certificates.
Fields
| Field Name | Description |
|---|---|
cursor - String
|
The cursor for requesting the next batch of items. |
items - [Certificate!]!
|
A list of Certificates. |
limit - Int!
|
The maximum number of items requested. |
Example
{
"cursor": "abc123",
"items": [Certificate],
"limit": 123
}
PagedCharacteristicValidValues
Description
A paged list of CharacteristicValidValues.
Fields
| Field Name | Description |
|---|---|
items - [CharacteristicValidValue!]!
|
A list of CharacteristicValidValues. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [CharacteristicValidValue],
"limit": 123,
"offset": 123,
"totalItems": 123
}
PagedCharacteristics
Description
A paged list of Characteristics.
Fields
| Field Name | Description |
|---|---|
items - [Characteristic!]!
|
A list of Characteristics. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [Characteristic],
"limit": 123,
"offset": 987,
"totalItems": 987
}
PagedComponentModels
Description
Retrieve paged ComponentModel's
Fields
| Field Name | Description |
|---|---|
items - [ComponentModel!]!
|
A list of ComponentModel objects. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [ComponentModel],
"limit": 987,
"offset": 987,
"totalItems": 987
}
PagedComponents
Description
A paged list of Components.
Fields
| Field Name | Description |
|---|---|
items - [Component!]!
|
A list of Components included in the page. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [Component],
"limit": 123,
"offset": 123,
"totalItems": 123
}
PagedDataSources
Description
A paginated list of DataSource entities.
Fields
| Field Name | Description |
|---|---|
items - [DataSource!]!
|
A list of DataSource entities. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [DataSource],
"limit": 987,
"offset": 123,
"totalItems": 987
}
PagedDatapoints
Description
A paged list of Datapoints.
Fields
| Field Name | Description |
|---|---|
cursor - String
|
The cursor for requesting the next batch of items. |
items - [Datapoint!]!
|
|
limit - Int!
|
The maximum number of items requested. |
Example
{
"cursor": "xyz789",
"items": [Datapoint],
"limit": 123
}
PagedDistinctAggregatedDatapoints
Description
A paged list of results for aggregated distinct datapoints.
Fields
| Field Name | Description |
|---|---|
cursor - String
|
The cursor for requesting the next batch of items. |
items - [DistinctAggregatedDatapoints!]!
|
A list of aggregated distinct datapoint results. |
limit - Int!
|
The maximum number of items requested. |
Example
{
"cursor": "xyz789",
"items": [DistinctAggregatedDatapoints],
"limit": 123
}
PagedDistinctDatapoints
Description
A paged list of distinct datapoints.
Fields
| Field Name | Description |
|---|---|
cursor - String
|
The cursor for requesting the next batch of items. |
items - [DistinctDatapoints!]!
|
A list of value distinct datapoints. |
limit - Int!
|
The maximum number of items requested. |
Example
{
"cursor": "abc123",
"items": [DistinctDatapoints],
"limit": 123
}
PagedDistinctMetadataValues
Description
A paged list of distinct metadata values.
Fields
| Field Name | Description |
|---|---|
cursor - String
|
The cursor for requesting the next batch of items. |
items - [DistinctMetadataValue!]!
|
A list of distinct metadata values. |
limit - Int!
|
The maximum number of items requested. |
Example
{
"cursor": "abc123",
"items": [DistinctMetadataValue],
"limit": 987
}
PagedDomainFeatures
Description
A paged list of DomainFeatures.
Fields
| Field Name | Description |
|---|---|
items - [DomainFeature!]!
|
A list of DomainFeatures. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [DomainFeature],
"limit": 123,
"offset": 987,
"totalItems": 123
}
PagedEventAcks
Description
A paged list of event Acknowledgments.
Fields
| Field Name | Description |
|---|---|
items - [EventAck!]!
|
A list of event Acknowledgments. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [EventAck],
"limit": 123,
"offset": 123,
"totalItems": 987
}
PagedEventModelLinks
Description
A paged list of EventModelLinks.
Fields
| Field Name | Description |
|---|---|
items - [EventModelLink!]!
|
A list of EventModelLinks. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [EventModelLink],
"limit": 987,
"offset": 123,
"totalItems": 987
}
PagedEventModels
Description
Returns a list of EventModels with the requested fields and pagination information.
Fields
| Field Name | Description |
|---|---|
items - [EventModel!]!
|
Retrieves a list of EventModels included in the current page. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [EventModel],
"limit": 123,
"offset": 123,
"totalItems": 123
}
PagedEvents
PagedIntegrations
Description
A paged list of Integrations.
Fields
| Field Name | Description |
|---|---|
items - [Integration!]!
|
A list of Integrations. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [Integration],
"limit": 123,
"offset": 123,
"totalItems": 123
}
PagedIssuers
Description
A paged list of Issuers.
Fields
| Field Name | Description |
|---|---|
items - [Issuer!]!
|
A list of Issuers. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [Issuer],
"limit": 123,
"offset": 987,
"totalItems": 123
}
PagedLoginMethods
Description
A paged list of LoginMethods.
Fields
| Field Name | Description |
|---|---|
items - [BaseLoginMethod!]!
|
A list of LoginMethods. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [BaseLoginMethod],
"limit": 123,
"offset": 987,
"totalItems": 123
}
PagedMachineUsers
Description
A paged list of MachineUsers.
Fields
| Field Name | Description |
|---|---|
items - [MachineUser!]!
|
A list of MachineUsers. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [MachineUser],
"limit": 123,
"offset": 987,
"totalItems": 987
}
PagedMetadataTypes
Description
A paged list of MetadataTypes.
Fields
| Field Name | Description |
|---|---|
items - [MetadataType!]!
|
A list of MetadataTypes. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [MetadataType],
"limit": 123,
"offset": 123,
"totalItems": 123
}
PagedMeteringRecords
Description
A paged list of MeteringRecords.
Fields
| Field Name | Description |
|---|---|
items - [MeteringRecord!]!
|
A list of MeteringRecords. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [MeteringRecord],
"limit": 987,
"offset": 123,
"totalItems": 123
}
PagedOrganizationSources
Description
A paged list of OrganizationSources.
Fields
| Field Name | Description |
|---|---|
items - [OrganizationSource!]!
|
A list of OrganizationSources. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [OrganizationSource],
"limit": 987,
"offset": 987,
"totalItems": 123
}
PagedOrganizations
Description
A paged list of Organizations.
Fields
| Field Name | Description |
|---|---|
items - [Organization!]!
|
A list of Organizations. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [Organization],
"limit": 123,
"offset": 123,
"totalItems": 123
}
PagedRoleAssignmentSources
Description
A paged list of RoleAssignmentSources.
Fields
| Field Name | Description |
|---|---|
items - [RoleAssignmentSource!]!
|
A list of RoleAssignmentSources. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [RoleAssignmentSource],
"limit": 123,
"offset": 123,
"totalItems": 987
}
PagedRoleAssignments
Description
A paged list of RoleAssignments.
Fields
| Field Name | Description |
|---|---|
items - [RoleAssignment!]!
|
A list of RoleAssignments. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [RoleAssignment],
"limit": 123,
"offset": 987,
"totalItems": 123
}
PagedRoles
Description
A paginated list of Role objects.
Example
{
"items": [Role],
"limit": 987,
"offset": 123,
"totalItems": 987
}
PagedServices
Description
A paged list of Services.
Fields
| Field Name | Description |
|---|---|
items - [Service!]!
|
A list of Services to be retrieved. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [Service],
"limit": 987,
"offset": 987,
"totalItems": 123
}
PagedServicesOnComponent
Description
A paged list of Services associated with a Component.
Fields
| Field Name | Description |
|---|---|
items - [ServiceOnComponent!]!
|
A list of Services associated with a Component. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [ServiceOnComponent],
"limit": 987,
"offset": 123,
"totalItems": 123
}
PagedServicesOnComponentModel
Description
A paged list of Services associated with a ComponentModel.
Fields
| Field Name | Description |
|---|---|
items - [ServiceOnComponentModel!]!
|
A list of Services associated with a ComponentModel. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [ServiceOnComponentModel],
"limit": 123,
"offset": 123,
"totalItems": 987
}
PagedSetpoints
Description
A paged list of Setpoints.
Fields
| Field Name | Description |
|---|---|
cursor - String
|
The cursor for requesting the next batch of items. |
items - [Setpoint!]!
|
|
limit - Int!
|
The maximum number of items requested. |
Example
{
"cursor": "xyz789",
"items": [Setpoint],
"limit": 123
}
PagedSystems
Description
A paged list of Systems.
Fields
| Field Name | Description |
|---|---|
items - [System!]!
|
A list of Systems. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [System],
"limit": 987,
"offset": 987,
"totalItems": 123
}
PagedTimeStreams
Description
A paged list of TimeStreams.
Fields
| Field Name | Description |
|---|---|
items - [TimeStream!]!
|
A list of TimeStreams. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [TimeStream],
"limit": 123,
"offset": 123,
"totalItems": 987
}
PagedUserSources
Description
A paged list of UserSources.
Fields
| Field Name | Description |
|---|---|
items - [UserSource!]!
|
A list of UserSources. |
limit - Int!
|
The maximum number of items requested. |
offset - Int!
|
The current offset of items requested. |
totalItems - Int!
|
The total number of available items. |
Example
{
"items": [UserSource],
"limit": 123,
"offset": 987,
"totalItems": 987
}
PagedUsers
Description
A paged list of Users.
Example
{
"items": [User],
"limit": 987,
"offset": 123,
"totalItems": 987
}
PasswordLoginMethod
Description
A LoginMethod is a method of authentication that a User can use to authenticate against DRIVR. It indicates that that the User has a password which can be used for authentication.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainAuthenticationMethod - AuthenticationMethod
|
The entity's DomainAuthenticationMethod. |
domainAuthenticationMethodUuid - UUID
|
The UUID of the entity's DomainAuthenticationMethod. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
type - LoginMethod
|
The login method type of the entity. Describes the type of authentication which can be used with this Entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
user - User
|
The User linked to the entity. This field provides more information about the User linked to the entity. |
userUuid - UUID
|
The UUID of the User linked to the entity. This is usually the owner or person who created the entity. They also could have been assigned to it after creation by another User. |
username - String
|
The name of the User used for login against DRIVR. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainAuthenticationMethod": AzureAuthenticationMethod,
"domainAuthenticationMethodUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "OAUTH_AZURE",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"username": "xyz789",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
ReceiptId
Description
Represents a receipt of a created Setpoint.
Example
{
"index": 987,
"receiptId": "abc123",
"time": "2007-12-03T10:15:30Z",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
ResourceOwners
Fields
| Input Field | Description |
|---|---|
organization - NestedOrganizationQuery
|
|
user - NestedUserQuery
|
Example
{
"organization": NestedOrganizationQuery,
"user": NestedUserQuery
}
Role
Description
A Role describes the function assigned to an assignee, such as a User or Organization, within DRIVR
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domainUuid - UUID
|
The domain UUID of the Role. |
entityType - RoleEntityType!
|
The type of entity that the Role pertains to. |
name - String!
|
The name of the Role. |
status - Status!
|
The status of the Role. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"entityType": "DOMAIN",
"name": "abc123",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
RoleAssigneeType
Description
The RoleAssigneeType class enumerates the possible types of models that can be assigned to a Role via a RoleAssignment.
Values
| Enum Value | Description |
|---|---|
|
|
Represents an Identity that is assigned to a Role object. |
|
|
Represents a Organization that is assigned to a Role object. |
|
|
Represents an User that is assigned to a Role object. |
Example
"IDENTITY"
RoleAssigneeTypeQueryField
Description
Apply the filter operation to role-assignee-type value.
Fields
| Input Field | Description |
|---|---|
_eq - RoleAssigneeType
|
Equals |
_in - [RoleAssigneeType]
|
Is in the list |
_neq - RoleAssigneeType
|
Does NOT equal |
_nin - [RoleAssigneeType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "IDENTITY",
"_in": ["IDENTITY"],
"_neq": "IDENTITY",
"_nin": ["IDENTITY"],
"_null": false
}
RoleAssignment
Description
The root node that contains all the details about a specific RoleAssignment.
Fields
| Field Name | Description |
|---|---|
assignee - RoleAssignmentAssignee!
|
The RoleAssignment's Assignee. |
assigneeUuid - UUID
|
The UUID of the Role's assignee. An assignee can be a User or an Organization or an Identity. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
entity - RoleAssignmentEntity!
|
The RoleAssignment's Entity. |
entityUuid - UUID
|
The UUID of the Role's Entity. |
role - Role
|
The entity's Role. |
roleUuid - UUID
|
The UUID of the entity's Role. |
sources - PagedRoleAssignmentSources!
|
A list of RoleAssignmentSource's associated with the RoleAssignment. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"assignee": MachineUser,
"assigneeUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"entity": Domain,
"entityUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"role": Role,
"roleUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sources": PagedRoleAssignmentSources,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
RoleAssignmentAssignee
Description
The assignee type of a RoleAssignment model
Types
| Union Types |
|---|
Example
MachineUser
RoleAssignmentEntity
RoleAssignmentOrderByQuery
Description
Defines the sorting order for RoleAssignments'
Fields
| Input Field | Description |
|---|---|
assigneeUuid - OrderByDirection
|
Order RoleAssignment by uuid field of associated assignee. |
createdAt - OrderByDirection
|
|
entityUuid - OrderByDirection
|
Order RoleAssignment by uuid field of associated entity. |
roleUuid - OrderByDirection
|
Order RoleAssignment by uuid field of associated Role. |
status - OrderByDirection
|
|
updatedAt - OrderByDirection
|
|
uuid - OrderByDirection
|
Example
{
"assigneeUuid": "ASC",
"createdAt": "ASC",
"entityUuid": "ASC",
"roleUuid": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
RoleAssignmentQuery
Description
RoleAssignmentQuery provides complex filter over RoleAssignments
Fields
| Input Field | Description |
|---|---|
_and - [RoleAssignmentQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [RoleAssignmentQuery]
|
One of the passed entities must match |
assigneeType - RoleAssigneeTypeQueryField
|
Filter by assignee_type. |
assigneeUuid - UuidQueryField
|
Filter by assignee_uuid. |
createdAt - DateTimeQueryField
|
|
entityType - RoleEntityTypeQueryField
|
Filter by entity_type. |
entityUuid - UuidQueryField
|
Filter by entity_uuid. |
roleUuid - UuidQueryField
|
Filter by role_uuid. |
sources - NestedRoleAssignmentSourceQuery
|
Filter by RoleAssignmentSource. |
status - StatusQueryField
|
Filter by status. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [RoleAssignmentQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [RoleAssignmentQuery],
"assigneeType": RoleAssigneeTypeQueryField,
"assigneeUuid": UuidQueryField,
"createdAt": DateTimeQueryField,
"entityType": RoleEntityTypeQueryField,
"entityUuid": UuidQueryField,
"roleUuid": UuidQueryField,
"sources": NestedRoleAssignmentSourceQuery,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
RoleAssignmentSource
Description
A RoleAssignmentSource is an assignment of a DataSource for a RoleAssignment.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataSource - DataSource
|
The DataSource linked to the the entity. |
dataSourceUuid - UUID
|
The UUID of the DataSource linked to the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
roleAssignment - RoleAssignment
|
The RoleAssignment linked to the the entity. |
roleAssignmentUuid - UUID
|
The UUID of the RoleAssignment linked to the entity. |
sourceId - String
|
An identifier in an external system. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataSource": DataSource,
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignment": RoleAssignment,
"roleAssignmentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sourceId": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
RoleAssignmentSourceOrderByQuery
Description
The RoleAssignmentSourceOrderByQuery provides the ability to order a list of RoleAssignmentSource by various fields associated with the RoleAssignmentSources.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
Order RoleAssignmentSource by createdAt field. |
dataSourceUuid - OrderByDirection
|
Order RoleAssignmentSource by uuid field of associated DataSource. |
roleAssignmentUuid - OrderByDirection
|
Order RoleAssignmentSource by uuid field of associated RoleAssignment. |
sourceId - OrderByDirection
|
Order RoleAssignmentSource by sourceId field. |
updatedAt - OrderByDirection
|
Order RoleAssignmentSource by updatedAt field. |
uuid - OrderByDirection
|
Order RoleAssignmentSource by uuid field. |
Example
{
"createdAt": "ASC",
"dataSourceUuid": "ASC",
"roleAssignmentUuid": "ASC",
"sourceId": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
RoleAssignmentSourceQuery
Description
RoleAssignmentSourceQuery provides complex filters over RoleAssignmentSources'
Fields
| Input Field | Description |
|---|---|
_and - [RoleAssignmentSourceQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [RoleAssignmentSourceQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
dataSource - NestedDataSourceQuery
|
Filter by DataSource. |
dataSourceUuid - UuidQueryField
|
Filter by the linked DataSource uuid. |
roleAssignment - NestedRoleAssignmentQuery
|
Filter by RoleAssignment. |
roleAssignmentUuid - UuidQueryField
|
Filter by RoleAssignment uuid. |
sourceId - StringQueryField
|
Filter by source_id. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [RoleAssignmentSourceQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [RoleAssignmentSourceQuery],
"createdAt": DateTimeQueryField,
"dataSource": NestedDataSourceQuery,
"dataSourceUuid": UuidQueryField,
"roleAssignment": NestedRoleAssignmentQuery,
"roleAssignmentUuid": UuidQueryField,
"sourceId": StringQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
RoleEntityType
Description
The RoleEntityTypeEnum class enumerates the possible types of entities that can be assigned to a Role via a RoleAssignment.
Values
| Enum Value | Description |
|---|---|
|
|
Represents a Domain on which a Role object has permission |
|
|
Represents a System on which a Role object has permission |
Example
"DOMAIN"
RoleEntityTypeQueryField
Description
Apply the filter operation to role-entity-type value.
Fields
| Input Field | Description |
|---|---|
_eq - RoleEntityType
|
Equals |
_in - [RoleEntityType]
|
Is in the list |
_neq - RoleEntityType
|
Does NOT equal |
_nin - [RoleEntityType]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "DOMAIN",
"_in": ["DOMAIN"],
"_neq": "DOMAIN",
"_nin": ["DOMAIN"],
"_null": true
}
RoleOrderByQuery
Description
A RoleOrderByQuery allows sorting of Role objects based on various fields. The available fields for sorting are name, entity_type, domain_uuid, and status
Fields
| Input Field | Description |
|---|---|
domainUuid - OrderByDirection
|
Order Role by uuid field of associated Domain. |
entityType - OrderByDirection
|
Order Role by entityType field. |
name - OrderByDirection
|
Order Role by name field. |
status - OrderByDirection
|
Order Role by status field. |
Example
{"domainUuid": "ASC", "entityType": "ASC", "name": "ASC", "status": "ASC"}
RoleWhereQuery
Description
A RoleWhereQuery allows for complex filtering of Role objects based on specific criteria.
Fields
| Input Field | Description |
|---|---|
_and - [RoleWhereQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [RoleWhereQuery]
|
One of the passed entities must match |
domainUuid - UuidQueryField
|
Filter Role objects by the assigned Domain's UUID. |
entityType - RoleEntityTypeQueryField
|
Filter Role objects by the type of entity that they pertain to. |
name - StringQueryField
|
Filter Role objects by name. |
status - StatusQueryField
|
Filter Role objects by status. |
Example
{
"_and": [RoleWhereQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [RoleWhereQuery],
"domainUuid": UuidQueryField,
"entityType": RoleEntityTypeQueryField,
"name": StringQueryField,
"status": StatusQueryField
}
Service
Description
A Service is an inventory of capabilities that a specific hardware component provides. It can be hardware, software, or a combination of both. For example, a hardware service might describe the functionality of a 4G module in a smartphone or an environmental sensor in a smart home device. A software service might describe the functionality of a backend for a web application or an API for an app.
Fields
| Field Name | Description |
|---|---|
characteristics - PagedCharacteristics!
|
A list of Characteristics linked to the Service. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
componentModels - PagedComponentModels!
|
A list of ComponentModels linked to the Service. |
Arguments
|
|
components - PagedComponents!
|
A list of Components linked to the Service. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String
|
A human-readable name representing the entity. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristics": PagedCharacteristics,
"code": "abc123",
"componentModels": PagedComponentModels,
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "abc123",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
ServiceComponentModelLink
Description
An individual ServiceComponentModel link object that represents the relationship between a single Service object and one or more ComponentModel objects. An example of this link could be a Service object with code "EC2" that is associated with a ComponentModel object for a web server that uses Amazon EC2 instances.
Fields
| Field Name | Description |
|---|---|
componentModel - ComponentModel!
|
The entity's ComponentModel. |
componentModelUuid - UUID!
|
The UUID of the entity's ComponentModel. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
index - Int
|
The integer index value of this entity. |
service - Service
|
The Service the entity references. |
serviceUuid - UUID
|
The UUID of the entity's corresponding Service object. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"componentModel": ComponentModel,
"componentModelUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"index": 123,
"service": Service,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
ServiceOnComponent
Description
An individual Service object that can be associated with one or more Component objects. For example could be a Service with code "S3" that is associated with a Component object for a data storage system that uses Amazon S3.
Fields
| Field Name | Description |
|---|---|
characteristics - PagedCharacteristics!
|
A list of Characteristics linked to the Service. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
componentModels - PagedComponentModels!
|
A list of ComponentModels linked to the Service. |
Arguments
|
|
components - PagedComponents!
|
A list of Components linked to the Service. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String
|
A human-readable name representing the entity. |
serviceIndex - Int!
|
The index of the Service & entity relationship to be retrieved. |
serviceUuid - UUID!
|
The UUID of the related Service entity. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristics": PagedCharacteristics,
"code": "abc123",
"componentModels": PagedComponentModels,
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
ServiceOnComponentModel
Description
An individual Service object that can be associated with one or more ComponentModel objects. For example, a Service with code "EC2" could be associated with a ComponentModel object for a web server that uses Amazon EC2 instance.
Fields
| Field Name | Description |
|---|---|
characteristics - PagedCharacteristics!
|
A list of Characteristics linked to the Service. |
Arguments
|
|
code - String
|
A human or machine-readable code representing the entity. |
components - PagedComponents!
|
A list of Components linked to the Service. |
Arguments
|
|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
name - String
|
A human-readable name representing the entity. |
serviceIndex - Int
|
The index of the Service & entity relationship to be retrieved. |
serviceUuid - UUID
|
The UUID of the related Service entity. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristics": PagedCharacteristics,
"code": "abc123",
"components": PagedComponents,
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"name": "abc123",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
ServiceOnComponentModelOrderByQuery
Description
Specifies which fields can be used to order the resultsof a Service and ComponentModel relation query.
Fields
| Input Field | Description |
|---|---|
code - OrderByDirection
|
Orders Service based on code field. |
createdAt - OrderByDirection
|
Orders Service based on createdAt field. |
name - OrderByDirection
|
Orders Service based on name field. |
serviceIndex - OrderByDirection
|
Orders ServiceOnComponentModel based on index field. |
status - OrderByDirection
|
Orders Service based on status field. |
updatedAt - OrderByDirection
|
Orders Service based on updatedAt field. |
uuid - OrderByDirection
|
Orders Service based on uuid field. |
Example
{
"code": "ASC",
"createdAt": "ASC",
"name": "ASC",
"serviceIndex": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
ServiceOnComponentModelQuery
Fields
| Input Field | Description |
|---|---|
_and - [ServiceOnComponentModelQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ServiceOnComponentModelQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by AggregatedDatapoints associated with the Services. |
characteristic - NestedCharacteristicQuery
|
|
code - StringQueryField
|
Filter by the code field of a Service. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by CurrentDatapoints associated with the Services. |
datapoints - NestedDatapointsWhereQuery
|
Filter by Datapoints associated with the Services. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name of the Service. |
serviceIndex - IntQueryField
|
Filter ServiceOnComponentModel relation using index. |
status - StatusQueryField
|
Filter by status of a Service. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"_and": [ServiceOnComponentModelQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ServiceOnComponentModelQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"code": StringQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"serviceIndex": IntQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
ServiceOnComponentOrderByQuery
Description
Specifies which fields can be used to order the results of a Service and Component relation query.
Fields
| Input Field | Description |
|---|---|
code - OrderByDirection
|
Orders Service based on code field. |
createdAt - OrderByDirection
|
Orders Service based on createdAt field. |
name - OrderByDirection
|
Orders Service based on name field. |
serviceIndex - OrderByDirection
|
Orders ServiceOnComponent based on index field. |
status - OrderByDirection
|
Orders Service based on status field. |
updatedAt - OrderByDirection
|
Orders Service based on updatedAt field. |
uuid - OrderByDirection
|
Orders Service based on uuid field. |
Example
{
"code": "ASC",
"createdAt": "ASC",
"name": "ASC",
"serviceIndex": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
ServiceOnComponentQuery
Description
The ServiceOnComponentQuery is a WHERE-query which allows you to specify complex filters for retrieving Service and Component relation objects based on their attributes.
Fields
| Input Field | Description |
|---|---|
_and - [ServiceOnComponentQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ServiceOnComponentQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by AggregatedDatapoints associated with the Services. |
characteristic - NestedCharacteristicQuery
|
|
code - StringQueryField
|
Filter by the code field of a Service. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by CurrentDatapoints associated with the Services. |
datapoints - NestedDatapointsWhereQuery
|
Filter by Datapoints associated with the Services. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name of the Service. |
serviceIndex - IntQueryField
|
Filter ServiceOnComponent relation using index. |
status - StatusQueryField
|
Filter by status of a Service. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"_and": [ServiceOnComponentQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ServiceOnComponentQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"code": StringQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"serviceIndex": IntQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
ServiceOrderByQuery
Description
Specifies which fields can be used to order the results of a Service query.
Fields
| Input Field | Description |
|---|---|
code - OrderByDirection
|
Orders Service based on code field. |
createdAt - OrderByDirection
|
Orders Service based on createdAt field. |
name - OrderByDirection
|
Orders Service based on name field. |
status - OrderByDirection
|
Orders Service based on status field. |
updatedAt - OrderByDirection
|
Orders Service based on updatedAt field. |
uuid - OrderByDirection
|
Orders Service based on uuid field. |
Example
{
"code": "ASC",
"createdAt": "ASC",
"name": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
ServiceQuery
Description
The ServiceQuery is a WHERE-query which allows you to specify complex filters for retrieving Service objects based on their attributes.
Fields
| Input Field | Description |
|---|---|
_and - [ServiceQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [ServiceQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by AggregatedDatapoints associated with the Services. |
characteristic - NestedCharacteristicQuery
|
|
code - StringQueryField
|
Filter by the code field of a Service. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filter by CurrentDatapoints associated with the Services. |
datapoints - NestedDatapointsWhereQuery
|
Filter by Datapoints associated with the Services. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by name of the Service. |
status - StatusQueryField
|
Filter by status of a Service. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"_and": [ServiceQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [ServiceQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"code": StringQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
Setpoint
Description
A Setpoint in the system.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
Possible Types
| Setpoint Types |
|---|
Example
{
"message": "xyz789",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
SetpointBlob
Description
A Setpoint containing a blob value.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - String!
|
The binary large object (blob) value contained in the Setpoint. |
Example
{
"message": "xyz789",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "xyz789"
}
SetpointBoolean
Description
A Setpoint containing a boolean value.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - Boolean!
|
The bool value contained in the Setpoint. |
Example
{
"message": "xyz789",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": false
}
SetpointDate
Description
A Setpoint containing a date value.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - Date!
|
The date value contained in the Setpoint. |
Example
{
"message": "xyz789",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "2007-12-03"
}
SetpointFloat
Description
A Setpoint containing a float value.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - Float!
|
The floating point value contained in the Setpoint. |
Example
{
"message": "xyz789",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 123.45
}
SetpointInputBlob
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - String!
|
The base64-encoded binary data which should be stored into DRIVR. |
Example
{
"characteristicCode": "xyz789",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "xyz789"
}
SetpointInputBoolean
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Boolean!
|
Store boolean values in DRIVR to represent true/false states. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": true
}
SetpointInputDate
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Date!
|
The date value which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "2007-12-03"
}
SetpointInputFloat
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Float!
|
The float value which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987.65
}
SetpointInputInteger
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Int!
|
The integer value which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987
}
SetpointInputJson
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - String!
|
The string representation of JSON data which should be stored into DRIVR. |
Example
{
"characteristicCode": "xyz789",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "abc123"
}
SetpointInputSelect
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - [String]!
|
The selected option or options which should be added. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": ["xyz789"]
}
SetpointInputString
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - String!
|
The string value which should be stored into DRIVR. |
Example
{
"characteristicCode": "xyz789",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "abc123",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "abc123",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "abc123"
}
SetpointInputTime
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Time!
|
The time value which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "abc123",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "10:15:30Z"
}
SetpointInputTimespan
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - Timespan!
|
The timespan value which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": Timespan
}
SetpointInputTimestamp
Fields
| Input Field | Description |
|---|---|
characteristicCode - String
|
The code of the datapoint/setpoint's characteristic. |
characteristicUuid - UUID
|
The uuid of the datapoint/setpoint's characteristic. |
componentCode - String
|
The code of the component which should be referenced. |
componentUuid - UUID
|
The UUID of the component which should be referenced. |
serviceCode - String
|
The code of the datapoint/setpoint's service. |
serviceIndex - Int
|
The index of the datapoint/setpoint's service/component_model relationship. Defaults to 0 if not provided. |
serviceUuid - UUID
|
The uuid of the datapoint/setpoint's service. |
systemCode - String
|
The code of the datapoint/setpoint's system. |
systemUuid - UUID
|
The uuid of the datapoint/setpoint's system. |
timeStreamUuid - UUID
|
The uuid of the datapoint/setpoint's TimeStream. |
value - DateTime!
|
The timestamp value which should be stored into DRIVR. |
Example
{
"characteristicCode": "abc123",
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"componentCode": "xyz789",
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"serviceCode": "xyz789",
"serviceIndex": 987,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"systemCode": "xyz789",
"systemUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "2007-12-03T10:15:30Z"
}
SetpointInteger
Description
A Setpoint that contains an integer value.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - Int!
|
The integer value contained in the Setpoint. |
Example
{
"message": "xyz789",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": 987
}
SetpointJson
Description
A Setpoint containing a JSON value.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - String!
|
The JSON value contained in the Setpoint. |
Example
{
"message": "abc123",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "abc123"
}
SetpointOrderByQuery
Description
Sorting and ordering options for setpoints.
Fields
| Input Field | Description |
|---|---|
characteristicUuid - OrderByDirection
|
|
componentUuid - OrderByDirection
|
|
message - OrderByDirection
|
Order setpoints by message field. |
serviceUuid - OrderByDirection
|
|
state - OrderByDirection
|
Order setpoints by state field. |
systemUuid - OrderByDirection
|
|
time - OrderByDirection
|
|
timeStreamUuid - OrderByDirection
|
Example
{
"characteristicUuid": "ASC",
"componentUuid": "ASC",
"message": "ASC",
"serviceUuid": "ASC",
"state": "ASC",
"systemUuid": "ASC",
"time": "ASC",
"timeStreamUuid": "ASC"
}
SetpointReceipts
Description
A Setpoint that contains the receipt IDs of the created Setpoints.
Fields
| Field Name | Description |
|---|---|
receiptIds - [ReceiptId!]!
|
A list of the receipts IDs that track the creation of the Setpoints. |
Example
{"receiptIds": [ReceiptId]}
SetpointSelect
Description
A Setpoint that contains a select value. This value describes one or multiple options which have been checked from the referenced Characteristic.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - [String!]!
|
The values contained by the Setpoint. This field represents the selected option(s) of the Characteristic belonging to the Setpoint. |
Example
{
"message": "abc123",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": ["xyz789"]
}
SetpointState
Description
The SetpointState enum represents the various states that a Setpoint object can be in.
Values
| Enum Value | Description |
|---|---|
|
|
This signifies that the Setpoint has been accepted, and its state cannot be updated again. |
|
|
This is the default state when a Setpoint object is created. |
|
|
This signifies that the Setpoint has been rejected, and its state cannot be updated again. |
Example
"ACCEPTED"
SetpointStateQueryField
Description
Apply the filter operation to setpoint-state value.
Fields
| Input Field | Description |
|---|---|
_eq - SetpointState
|
Equals |
_in - [SetpointState]
|
Is in the list |
_neq - SetpointState
|
Does NOT equal |
_nin - [SetpointState]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "ACCEPTED",
"_in": ["ACCEPTED"],
"_neq": "ACCEPTED",
"_nin": ["ACCEPTED"],
"_null": false
}
SetpointString
Description
A Setpoint that contains a string value.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - String!
|
The string value contained in the Setpoint. |
Example
{
"message": "xyz789",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "abc123"
}
SetpointTime
Description
A Setpoint that represents a specific time of day.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - Time!
|
The time value contained in the Setpoint. |
Example
{
"message": "abc123",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "10:15:30Z"
}
SetpointTimespan
Description
A Setpoint that represents a period of time between two datetime values.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - Timespan!
|
The timespan value contained in the Setpoint. |
Example
{
"message": "abc123",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": Timespan
}
SetpointTimestamp
Description
A Setpoint that contains a date and time value.
Fields
| Field Name | Description |
|---|---|
message - String
|
An optional message if a Setpoint is REJECTED. |
state - SetpointState!
|
The state of the Setpoint. |
time - DateTime!
|
|
timeStream - TimeStream!
|
The entity's TimeStream. |
timeStreamUuid - UUID!
|
The UUID of the entity's TimeStream. |
type - ValueDataType!
|
The type of data the Setpoint contains. |
uuid - UUID!
|
The unique ID for referencing the Setpoint. |
value - DateTime!
|
The date and time value of the Setpoint. |
Example
{
"message": "xyz789",
"state": "ACCEPTED",
"time": "2007-12-03T10:15:30Z",
"timeStream": TimeStream,
"timeStreamUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"type": "BLOB",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"value": "2007-12-03T10:15:30Z"
}
SetpointsWhereQuery
Description
SetpointsWhereQuery provides complex filter over setpoints
Fields
| Input Field | Description |
|---|---|
_and - [SetpointsWhereQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [SetpointsWhereQuery]
|
One of the passed entities must match |
characteristic - NestedCharacteristicQuery
|
|
characteristicUuid - UuidQueryField
|
Filter by Characteristic UUID. |
component - NestedComponentQuery
|
|
componentModel - NestedComponentModelQuery
|
|
componentModelUuid - UuidQueryField
|
Filter by ComponentModel UUID. |
componentUuid - UuidQueryField
|
Filter by Component UUID. |
domainUuid - UuidQueryField
|
Filter by Domain UUID. |
from - DateTime
|
The inclusive, earliest time from which data should be requested. |
message - StringQueryField
|
Filter by message of the setpoint. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service & ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
Filter by Service UUID. |
state - SetpointStateQueryField
|
Filter by state of the setpoint. |
system - NestedSystemQuery
|
|
systemUuid - UuidQueryField
|
Filter by System UUID. |
time - DateTimeQueryField
|
Filter by Setpoint occurrence. |
timeStream - NestedTimeStreamQuery
|
|
timeStreamUuid - UuidQueryField
|
Filter by TimeStream UUID. |
to - DateTime
|
The exclusive, latest time up to which data should be requested. |
value - ValueQueryField
|
Example
{
"_and": [SetpointsWhereQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [SetpointsWhereQuery],
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentModel": NestedComponentModelQuery,
"componentModelUuid": UuidQueryField,
"componentUuid": UuidQueryField,
"domainUuid": UuidQueryField,
"from": "2007-12-03T10:15:30Z",
"message": StringQueryField,
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"state": SetpointStateQueryField,
"system": NestedSystemQuery,
"systemUuid": UuidQueryField,
"time": DateTimeQueryField,
"timeStream": NestedTimeStreamQuery,
"timeStreamUuid": UuidQueryField,
"to": "2007-12-03T10:15:30Z",
"value": ValueQueryField
}
Status
Description
The status of an entity within DRIVR.
Values
| Enum Value | Description |
|---|---|
|
|
The entity is active and can be used / edited. |
|
|
The entity is archived and cannot be used anymore. Any change to the entity is not allowed. You can still delete the entity to remove it completely. |
|
|
The entity is deactivated and cannot be used anymore. Setting it back to ACTIVATED will enable it again. |
Example
"ACTIVATED"
StatusQueryField
Description
Apply the filter operation to status value.
Example
{
"_eq": "ACTIVATED",
"_in": ["ACTIVATED"],
"_neq": "ACTIVATED",
"_nin": ["ACTIVATED"],
"_null": false
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StringAggregates
Fields
| Input Field | Description |
|---|---|
count - IntQueryField
|
|
first - StringQueryField
|
|
last - StringQueryField
|
Example
{
"count": IntQueryField,
"first": StringQueryField,
"last": StringQueryField
}
StringQueryField
Description
Apply the filter operation to String value.
Fields
| Input Field | Description |
|---|---|
_eq - String
|
Equals |
_ilike - String
|
Case-insensitive filtering by like, allowing to do partial checks. The like call supports both % and _ which translates to many or one character. |
_in - [String]
|
Is in the list |
_like - String
|
Case-sensitive filtering by like, allowing to do partial checks. The like call supports both % and _ which translates to many or one character. |
_neq - String
|
Does NOT equal |
_nin - [String]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "abc123",
"_ilike": "abc123",
"_in": ["xyz789"],
"_like": "xyz789",
"_neq": "xyz789",
"_nin": ["xyz789"],
"_null": true
}
System
Description
A System serves as a logical group of one or more IoT components which are usually positioned at the same geographic location and serve a common system function in DRIVR.
Fields
| Field Name | Description |
|---|---|
certificate - Certificate
|
The entity's Certificate. |
code - String!
|
An identifier unique within all activated Systems belonging to the same Domain. |
components - PagedComponents!
|
A paged list of Components belonging to the System. |
Arguments
|
|
connectionState - SystemConnectionState!
|
The connection state of the System. |
connectionStateUpdatedAt - DateTime
|
The time when the connection state of the System has been set. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
description - String
|
A description of the System. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
locationUuid - UUID
|
The UUID of the Location at which the System is located. |
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String!
|
The name of the System. |
owner - Account
|
The Account which owns the entity. |
ownerUuid - UUID
|
The UUID of the Account which owns the entity. |
roleAssignments - PagedRoleAssignments!
|
A paged list of assigned RoleAssignments. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"certificate": Certificate,
"code": "xyz789",
"components": PagedComponents,
"connectionState": "CONNECTED",
"connectionStateUpdatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"locationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"owner": Organization,
"ownerUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
SystemConnectionState
Values
| Enum Value | Description |
|---|---|
|
|
The System has at least one ACTIVATED and CONNECTED Component but no ACTIVATED and DISCONNECTED Component. |
|
|
The System has no ACTIVATED and CONNECTED Component but at least one ACTIVATED and DISCONNECTED Component. |
|
|
The System has at least one ACTIVATED and CONNECTED Component and at least one ACTIVATED and DISCONNECTED Component. |
|
|
The Components of the System are either all DEACTIVATED or ARCHIVED. The Components do report a connection state of UNDEFINED or NOT_CONNECTIVE. The System status is ARCHIVED or DEACTIVATED. |
Example
"CONNECTED"
SystemConnectionStateQueryField
Description
Apply the filter operation to system-connection-state value.
Fields
| Input Field | Description |
|---|---|
_eq - SystemConnectionState
|
Equals |
_in - [SystemConnectionState]
|
Is in the list |
_neq - SystemConnectionState
|
Does NOT equal |
_nin - [SystemConnectionState]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "CONNECTED",
"_in": ["CONNECTED"],
"_neq": "CONNECTED",
"_nin": ["CONNECTED"],
"_null": true
}
SystemOrderByQuery
Description
The SystemOrderByQuery provides the ability to order a list of Systems by various fields associated with the Systems.
Fields
| Input Field | Description |
|---|---|
code - OrderByDirection
|
Orders the list by code of the System. |
connectionState - OrderByDirection
|
Orders the list by connectionState of the System. |
connectionStateUpdatedAt - OrderByDirection
|
Orders the list by updated date of the System's connectionState. |
createdAt - OrderByDirection
|
Orders the list by creation time of the System. |
description - OrderByDirection
|
Orders the list by the description of the System. |
locationUuid - OrderByDirection
|
Orders the list by the UUID of the Location where the System is located. |
name - OrderByDirection
|
Orders the list by the name of the System. |
ownerUuid - OrderByDirection
|
Orders the list by the UUID of the owner of the System. |
status - OrderByDirection
|
Orders the list by the status of the System. |
updatedAt - OrderByDirection
|
Orders the list by update time of the System. |
uuid - OrderByDirection
|
Orders the list by UUID of the System. |
Example
{
"code": "ASC",
"connectionState": "ASC",
"connectionStateUpdatedAt": "ASC",
"createdAt": "ASC",
"description": "ASC",
"locationUuid": "ASC",
"name": "ASC",
"ownerUuid": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
SystemQuery
Description
The SystemQuery is a WHERE-query which allows you to specify filters for retrieving System objects based on their attributes.
Fields
| Input Field | Description |
|---|---|
_and - [SystemQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [SystemQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filters that can be used to filter and retrieve AggregatedDatapoints associated with the System. |
code - StringQueryField
|
Filter by the code of the System. |
components - NestedComponentQuery
|
Filters that can be used to filter and retrieve Components associated with the System. |
connectionState - SystemConnectionStateQueryField
|
Filter by the connection state of the System. |
connectionStateUpdatedAt - DateTimeQueryField
|
Filter by the date and time the connection state was updated for the System. |
createdAt - DateTimeQueryField
|
|
currentDatapoints - NestedCurrentDatapointsWhereQuery
|
Filters that can be used to filter and retrieve CurrentDatapoints associated with the System. |
datapoints - NestedDatapointsWhereQuery
|
Filters that can be used to filter and retrieve Datapoints associated with the System. |
description - StringQueryField
|
Filter by the description of the System. |
events - NestedEventFilterQuery
|
Filters that can be used to filter and retrieve Events associated with the System. |
locationUuid - UuidQueryField
|
Filter by the UUID of the location where the System is located. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
Filter by the name of the System. |
ownerUuid - UuidQueryField
|
Filter by the UUID of the owner of the System. |
status - StatusQueryField
|
Filter by the status of the System. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by the UUID of the System. |
Example
{
"_and": [SystemQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [SystemQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"code": StringQueryField,
"components": NestedComponentQuery,
"connectionState": SystemConnectionStateQueryField,
"connectionStateUpdatedAt": DateTimeQueryField,
"createdAt": DateTimeQueryField,
"currentDatapoints": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"description": StringQueryField,
"events": NestedEventFilterQuery,
"locationUuid": UuidQueryField,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"ownerUuid": UuidQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
Time
Description
The Time type represents a Time value as specified by iso8601.
Example
"10:15:30Z"
TimeAggregates
Fields
| Input Field | Description |
|---|---|
count - IntQueryField
|
|
first - TimeQueryField
|
|
last - TimeQueryField
|
|
max - TimeQueryField
|
|
min - TimeQueryField
|
Example
{
"count": IntQueryField,
"first": TimeQueryField,
"last": TimeQueryField,
"max": TimeQueryField,
"min": TimeQueryField
}
TimeQueryField
Description
Apply the filter operation to Time value.
Example
{
"_eq": "10:15:30Z",
"_gt": "10:15:30Z",
"_gte": "10:15:30Z",
"_in": ["10:15:30Z"],
"_lt": "10:15:30Z",
"_lte": "10:15:30Z",
"_neq": "10:15:30Z",
"_nin": ["10:15:30Z"],
"_null": true
}
TimeStream
Description
A TimeStream represents a continuous series of datapoints associated with a specific Component, Service, and Characteristic.
Fields
| Field Name | Description |
|---|---|
characteristic - Characteristic!
|
The entity's Characteristic. |
characteristicUuid - UUID!
|
The UUID of the entity's Characteristic. |
component - Component!
|
The entity's Component. |
componentUuid - UUID!
|
The UUID of the entity's Component. |
createdAt - DateTime!
|
The date and time at which the entity was created. |
service - Service!
|
The Service the entity references. |
serviceIndex - Int!
|
The index of the Service & entity relationship to be retrieved. |
serviceUuid - UUID!
|
The UUID of the entity's corresponding Service object. |
status - Status!
|
The current status of the entity. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"characteristic": Characteristic,
"characteristicUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"component": Component,
"componentUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"createdAt": "2007-12-03T10:15:30Z",
"service": Service,
"serviceIndex": 123,
"serviceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"status": "ACTIVATED",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
TimeStreamOrderByQuery
Description
Sorting and ordering options for TimeStream's.
Fields
| Input Field | Description |
|---|---|
characteristicUuid - OrderByDirection
|
Order TimeStream by uuid field of associated Characteristic. |
componentUuid - OrderByDirection
|
Order TimeStream by uuid field of associated Component. |
createdAt - OrderByDirection
|
Order TimeStream by createdAt field. |
serviceIndex - OrderByDirection
|
Order TimeStream by serviceIndex field. |
serviceUuid - OrderByDirection
|
Order TimeStream by uuid field of associated Service. |
status - OrderByDirection
|
Order TimeStream by status field. |
updatedAt - OrderByDirection
|
Order TimeStream by updatedAt field. |
uuid - OrderByDirection
|
Order TimeStream by uuid field. |
Example
{
"characteristicUuid": "ASC",
"componentUuid": "ASC",
"createdAt": "ASC",
"serviceIndex": "ASC",
"serviceUuid": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
TimeStreamQuery
Description
TimeStreamQuery provides complex filters over TimeStream's
Fields
| Input Field | Description |
|---|---|
_and - [TimeStreamQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [TimeStreamQuery]
|
One of the passed entities must match |
aggregatedDatapoints - NestedAggregatedDatapointsWhereQuery
|
Filter by aggregated DataPoints. |
characteristic - NestedCharacteristicQuery
|
Filter by Characteristic. |
characteristicUuid - UuidQueryField
|
Filter by Characteristic uuid. |
component - NestedComponentQuery
|
|
componentUuid - UuidQueryField
|
|
createdAt - DateTimeQueryField
|
|
currentDatapoint - NestedCurrentDatapointsWhereQuery
|
Filter by current DataPoints. |
datapoints - NestedDatapointsWhereQuery
|
Filter by DataPoints. |
service - NestedServiceQuery
|
|
serviceIndex - IntQueryField
|
Filter by Service and ComponentModel relationship index. |
serviceUuid - UuidQueryField
|
|
status - StatusQueryField
|
Filter by status. |
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Filter by uuid. |
Example
{
"_and": [TimeStreamQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [TimeStreamQuery],
"aggregatedDatapoints": NestedAggregatedDatapointsWhereQuery,
"characteristic": NestedCharacteristicQuery,
"characteristicUuid": UuidQueryField,
"component": NestedComponentQuery,
"componentUuid": UuidQueryField,
"createdAt": DateTimeQueryField,
"currentDatapoint": NestedCurrentDatapointsWhereQuery,
"datapoints": NestedDatapointsWhereQuery,
"service": NestedServiceQuery,
"serviceIndex": IntQueryField,
"serviceUuid": UuidQueryField,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
Timespan
Description
The Timespan type represents an Duration value as specified by iso8601. Alternatively an integer can be set which represents the timespan in seconds. A timespan can be both negative and positive.
Example
Timespan
TimespanAggregates
Fields
| Input Field | Description |
|---|---|
avg - TimespanQueryField
|
|
count - IntQueryField
|
|
first - TimespanQueryField
|
|
last - TimespanQueryField
|
|
max - TimespanQueryField
|
|
min - TimespanQueryField
|
|
sum - TimespanQueryField
|
Example
{
"avg": TimespanQueryField,
"count": IntQueryField,
"first": TimespanQueryField,
"last": TimespanQueryField,
"max": TimespanQueryField,
"min": TimespanQueryField,
"sum": TimespanQueryField
}
TimespanQueryField
Description
Apply the filter operation to Timespan value.
Fields
| Input Field | Description |
|---|---|
_eq - Timespan
|
Equals |
_gt - Timespan
|
Greater than |
_gte - Timespan
|
Greater than or equal |
_in - [Timespan]
|
Is in the list |
_lt - Timespan
|
Less than |
_lte - Timespan
|
Less than or equal |
_neq - Timespan
|
Does NOT equal |
_nin - [Timespan]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": Timespan,
"_gt": Timespan,
"_gte": Timespan,
"_in": [Timespan],
"_lt": Timespan,
"_lte": Timespan,
"_neq": Timespan,
"_nin": [Timespan],
"_null": false
}
TimestampAggregates
Fields
| Input Field | Description |
|---|---|
count - IntQueryField
|
|
first - DateTimeQueryField
|
|
last - DateTimeQueryField
|
|
max - DateTimeQueryField
|
|
min - DateTimeQueryField
|
Example
{
"count": IntQueryField,
"first": DateTimeQueryField,
"last": DateTimeQueryField,
"max": DateTimeQueryField,
"min": DateTimeQueryField
}
UUID
Description
Represents a universally unique identifier (UUID) following the hex representation as described in RFC4122.
Example
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
UpdateAzureAuthenticationMethodConfiguration
Example
{
"clientId": "abc123",
"clientSecret": "abc123",
"tenant": "xyz789"
}
UpdateGoogleAuthenticationMethodConfiguration
Fields
| Input Field | Description |
|---|---|
clientId - String
|
The client id used to authenticate DRIVR against the authentication service. |
clientSecret - String
|
The secret used to authenticate DRIVR against the authentication service. |
scopes - [String]
|
The list of authentication scopes for the authentication service. |
Example
{
"clientId": "xyz789",
"clientSecret": "abc123",
"scopes": ["xyz789"]
}
UpdateOpenIdDelegatedAuthenticationMethodConfiguration
User
Description
A single User within a Domain. They can additionally belong to a single Organization.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
email - String
|
The email address of the User. |
loginMethods - PagedLoginMethods!
|
A paged list of LoginMethods belonging to the User. |
Arguments
|
|
metadataKeyValueStore - [MetadataKeyValuePair!]!
|
Metadata Key-Value store for this entity. |
name - String
|
The name of the User. |
organization - Organization
|
The entity's Organization. |
organizationUuid - UUID
|
The UUID of the entity's Organization. |
roleAssignments - PagedRoleAssignments!
|
A paged list of assigned RoleAssignments. |
Arguments
|
|
sources - PagedUserSources!
|
A paged list of UserSources belonging to the User. |
Arguments
|
|
status - Status!
|
The current status of the entity. |
systems - PagedSystems!
|
A paged list of Systems belonging to the User. |
Arguments
|
|
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"email": "xyz789",
"loginMethods": PagedLoginMethods,
"metadataKeyValueStore": [MetadataKeyValuePair],
"name": "xyz789",
"organization": Organization,
"organizationUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"roleAssignments": PagedRoleAssignments,
"sources": PagedUserSources,
"status": "ACTIVATED",
"systems": PagedSystems,
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
UserOrderByQuery
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
|
email - OrderByDirection
|
|
name - OrderByDirection
|
|
organizationUuid - OrderByDirection
|
|
status - OrderByDirection
|
|
updatedAt - OrderByDirection
|
|
uuid - OrderByDirection
|
Example
{
"createdAt": "ASC",
"email": "ASC",
"name": "ASC",
"organizationUuid": "ASC",
"status": "ASC",
"updatedAt": "ASC",
"uuid": "ASC"
}
UserQuery
Fields
| Input Field | Description |
|---|---|
_and - [UserQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [UserQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
email - StringQueryField
|
|
loginMethods - NestedLoginMethodQuery
|
Filter by the login methods of the User. |
metadataKeyValueStore - MetadataKeyValueStoreQueryField
|
|
name - StringQueryField
|
|
organization - NestedOrganizationQuery
|
|
organizationUuid - UuidQueryField
|
|
sources - NestedUserSourceQuery
|
|
status - StatusQueryField
|
|
updatedAt - DateTimeQueryField
|
|
uuid - UuidQueryField
|
Example
{
"_and": [UserQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [UserQuery],
"createdAt": DateTimeQueryField,
"email": StringQueryField,
"loginMethods": NestedLoginMethodQuery,
"metadataKeyValueStore": MetadataKeyValueStoreQueryField,
"name": StringQueryField,
"organization": NestedOrganizationQuery,
"organizationUuid": UuidQueryField,
"sources": NestedUserSourceQuery,
"status": StatusQueryField,
"updatedAt": DateTimeQueryField,
"uuid": UuidQueryField
}
UserSource
Description
A UserSource is used to connect a User account in DRIVR to a DataSource, and to store the identifier that the User has within the external system represented by that DataSource. For example, a UserSource might be used to connect a DRIVR User named "X" to a DataSource that represents X's account in a third-party scheduling system.
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
The date and time at which the entity was created. |
dataSource - DataSource
|
The DataSource linked to the the entity. |
dataSourceUuid - UUID
|
The UUID of the DataSource linked to the entity. |
domain - Domain!
|
The entity's Domain. |
domainUuid - UUID!
|
The UUID of the entity's Domain. |
sourceId - String
|
An identifier in an external system. |
updatedAt - DateTime
|
The date and time at which the entity was last updated. |
user - User
|
The User linked to the entity. This field provides more information about the User linked to the entity. |
userUuid - UUID
|
The UUID of the User linked to the entity. This is usually the owner or person who created the entity. They also could have been assigned to it after creation by another User. |
uuid - UUID!
|
The unique ID for referencing the entity. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataSource": DataSource,
"dataSourceUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"domain": Domain,
"domainUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"sourceId": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"userUuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"uuid": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
}
UserSourceOrderByQuery
Description
Sorting and ordering options for UserSources.
Fields
| Input Field | Description |
|---|---|
createdAt - OrderByDirection
|
Order UserSource by the createdAt field. |
dataSourceUuid - OrderByDirection
|
Order UserSource by the uuid field of associated DataSource. |
sourceId - OrderByDirection
|
Order UserSource by the sourceId field. |
updatedAt - OrderByDirection
|
Order UserSource by the updatedAt field. |
userUuid - OrderByDirection
|
Order UserSource by the uuid field of associated User. |
uuid - OrderByDirection
|
Order UserSource by the uuid field. |
Example
{
"createdAt": "ASC",
"dataSourceUuid": "ASC",
"sourceId": "ASC",
"updatedAt": "ASC",
"userUuid": "ASC",
"uuid": "ASC"
}
UserSourceQuery
Description
A complex filter allowing for more granular filtering over UserSources.
Fields
| Input Field | Description |
|---|---|
_and - [UserSourceQuery]
|
All passed queries must match |
_notOf - [UUID]
|
None of the passed UUIDs must be in the result set |
_oneOf - [UUID]
|
One of the passed UUIDs must be in the result set |
_or - [UserSourceQuery]
|
One of the passed entities must match |
createdAt - DateTimeQueryField
|
|
dataSource - NestedDataSourceQuery
|
Filter by the DataSource associated with UserSource. |
dataSourceUuid - UuidQueryField
|
Filter by the DataSource UUID associated with UserSource. |
sourceId - StringQueryField
|
Filter by the sourceId of the UserSource. |
updatedAt - DateTimeQueryField
|
|
user - NestedUserQuery
|
Filter by the User associated with UserSource. |
userUuid - UuidQueryField
|
Filter by the User UUID associated with UserSource. |
uuid - UuidQueryField
|
Filter by the UUID of the UserSource. |
Example
{
"_and": [UserSourceQuery],
"_notOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_oneOf": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_or": [UserSourceQuery],
"createdAt": DateTimeQueryField,
"dataSource": NestedDataSourceQuery,
"dataSourceUuid": UuidQueryField,
"sourceId": StringQueryField,
"updatedAt": DateTimeQueryField,
"user": NestedUserQuery,
"userUuid": UuidQueryField,
"uuid": UuidQueryField
}
UuidQueryField
Description
Apply the filter operation to UUID value.
Fields
| Input Field | Description |
|---|---|
_eq - UUID
|
Equals |
_ilike - String
|
Case-insensitive filtering by like, allowing to do partial checks. The like call supports both % and _ which translates to many or one character. |
_in - [UUID]
|
Is in the list |
_like - String
|
Case-sensitive filtering by like, allowing to do partial checks. The like call supports both % and _ which translates to many or one character. |
_neq - UUID
|
Does NOT equal |
_nin - [UUID]
|
Is NOT in the list |
_null - Boolean
|
Is NULL |
Example
{
"_eq": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"_ilike": "xyz789",
"_in": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_like": "abc123",
"_neq": "a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13",
"_nin": [
"a65ef5d4-0c36-40dc-98ce-2b6ba0bbbf13"
],
"_null": false
}
ValueAggregate
Values
| Enum Value | Description |
|---|---|
|
|
This aggregation returns the average of datapoints. Requires a number-like datapoint type. |
|
|
This aggregation returns the number of datapoints. |
|
|
This aggregation returns the earliest datapoint. |
|
|
This aggregation returns the latest datapoint. |
|
|
This aggregation returns the maximal datapoint. Requires a comparable datapoint type. |
|
|
This aggregation returns the minimal datapoint. Requires a comparable datapoint type. |
|
|
This aggregation returns the sum of datapoints. Requires a number-like datapoint type. |
Example
"AVG"
ValueDataType
Description
A data type.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BLOB"
ValueQueryField
Description
Filter by the value of datapoints and setpoints
Fields
| Input Field | Description |
|---|---|
blob - BlobQueryField
|
|
boolean - BoolQueryField
|
|
date - DateQueryField
|
|
float - FloatQueryField
|
|
integer - IntQueryField
|
|
string - StringQueryField
|
|
time - TimeQueryField
|
|
timespan - TimespanQueryField
|
|
timestamp - DateTimeQueryField
|
Example
{
"blob": BlobQueryField,
"boolean": BoolQueryField,
"date": DateQueryField,
"float": FloatQueryField,
"integer": IntQueryField,
"string": StringQueryField,
"time": TimeQueryField,
"timespan": TimespanQueryField,
"timestamp": DateTimeQueryField
}