PixelCore GraphQL API Reference

Welcome to the PixelCore GraphQL API reference! This reference includes the complete set of GraphQL types, queries, mutations, and their parameters for working with Objects, Schemas, Properties, RPC/Controls and so on. For more tutorial-oriented API documentation, please check out our API Guide.

Contact

Pixel Networks Support
support@pixel-networks.com

License

Pixel License
https://pixel-networks.atlassian.net/wiki/spaces/PCV3/

API Endpoints

Production:
https://platform.your-domain-name.iot.pn/graphql

Queries

`controlExecution`

Returns a ControlExecution

Name	Description
`id` - `Int!`

Example

Query

query controlExecution($id: Int!) {
  controlExecution(id: $id) {
    nodeId
    id
    objectId
    controller
    createdAt
    type
    name
    params
    ack
    done
    error
    linkedControlId
    callerId
    helperParams
    object {
      ...ObjectFragment
    }
    caller {
      ...UserFragment
    }
  }
}

Variables

{"id": 987}

Response

{
  "data": {
    "controlExecution": {
      "nodeId": ID,
      "id": 123,
      "objectId": UUID,
      "controller": UUID,
      "createdAt": Datetime,
      "type": ControlTypes,
      "name": "xyz789",
      "params": {},
      "ack": true,
      "done": false,
      "error": "abc123",
      "linkedControlId": BigInt,
      "callerId": UUID,
      "helperParams": {},
      "object": Object,
      "caller": User
    }
  }
}

Queries

`controlExecutionByNodeId`

Reads a single ControlExecution using its globally unique ID

Returns a ControlExecution

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `ControlExecution`

Example

Query

query controlExecutionByNodeId($nodeId: ID!) {
  controlExecutionByNodeId(nodeId: $nodeId) {
    nodeId
    id
    objectId
    controller
    createdAt
    type
    name
    params
    ack
    done
    error
    linkedControlId
    callerId
    helperParams
    object {
      ...ObjectFragment
    }
    caller {
      ...UserFragment
    }
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "controlExecutionByNodeId": {
      "nodeId": ID,
      "id": 987,
      "objectId": UUID,
      "controller": UUID,
      "createdAt": Datetime,
      "type": ControlTypes,
      "name": "xyz789",
      "params": {},
      "ack": false,
      "done": true,
      "error": "xyz789",
      "linkedControlId": BigInt,
      "callerId": UUID,
      "helperParams": {},
      "object": Object,
      "caller": User
    }
  }
}

Queries

`controlExecutions`

Reads a set of ControlExecution

Returns [ControlExecution!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[ControlExecutionsSort!]`	The specification of how the `ControlExecution` records should be sorted
`orderBy` - `[ControlExecutionsOrderBy!]`	The method to use when ordering `ControlExecution`
`condition` - `ControlExecutionCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ControlExecutionFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query controlExecutions($first: Int, $offset: Int, $sort: [ControlExecutionsSort!], $orderBy: [ControlExecutionsOrderBy!], $condition: ControlExecutionCondition, $filter: ControlExecutionFilter) {
  controlExecutions(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    objectId
    controller
    createdAt
    type
    name
    params
    ack
    done
    error
    linkedControlId
    callerId
    helperParams
    object {
      ...ObjectFragment
    }
    caller {
      ...UserFragment
    }
  }
}

Variables

{
  "first": 987,
  "offset": 987,
  "sort": [ControlExecutionsSort],
  "orderBy": [ControlExecutionsOrderBy],
  "condition": ControlExecutionCondition,
  "filter": ControlExecutionFilter
}

Response

{
  "data": {
    "controlExecutions": [
      {
        "nodeId": ID,
        "id": 987,
        "objectId": UUID,
        "controller": UUID,
        "createdAt": Datetime,
        "type": ControlTypes,
        "name": "xyz789",
        "params": {},
        "ack": true,
        "done": true,
        "error": "abc123",
        "linkedControlId": BigInt,
        "callerId": UUID,
        "helperParams": {},
        "object": Object,
        "caller": User
      }
    ]
  }
}

Queries

`controlExecutionsConnection`

Reads and enables pagination through a set of ControlExecution

Returns a ControlExecutionsConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[ControlExecutionsSort!]`	The specification of how the `ControlExecution` records should be sorted
`orderBy` - `[ControlExecutionsOrderBy!]`	The method to use when ordering `ControlExecution`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `ControlExecutionCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ControlExecutionFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query controlExecutionsConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [ControlExecutionsSort!], $orderBy: [ControlExecutionsOrderBy!], $condition: ControlExecutionCondition, $filter: ControlExecutionFilter) {
  controlExecutionsConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...ControlExecutionFragment
    }
    edges {
      ...ControlExecutionsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 123,
  "last": 123,
  "offset": 987,
  "before": Cursor,
  "after": Cursor,
  "sort": [ControlExecutionsSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": ControlExecutionCondition,
  "filter": ControlExecutionFilter
}

Response

{
  "data": {
    "controlExecutionsConnection": {
      "nodes": [ControlExecution],
      "edges": [ControlExecutionsEdge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Queries

`exportSchema`

Export schema from the platform in JSON format.

Returns a String

Name	Description
`schemaId` - `UUID`

Example

Query

query exportSchema($schemaId: UUID) {
  exportSchema(schemaId: $schemaId)
}

Variables

{"schemaId": UUID}

Response

{"data": {"exportSchema": "xyz789"}}

Queries

`getDbInfo`

Returns DB space usage and information.

Returns a DbInfo

Example

Query

query getDbInfo {
  getDbInfo {
    version
    tsVersion
    retention
    dbSize
    mediaSize
    pps
    props10Min
    devices
    devicesOffline
    users
    usersDisabled
    appUsers
    userGroups
    objects
    historySize
    notifications
    notificationsSize
    deliveries
    deliveriesSize
    controls
    controlsSize
  }
}

Response

{
  "data": {
    "getDbInfo": {
      "version": "abc123",
      "tsVersion": "abc123",
      "retention": "abc123",
      "dbSize": BigInt,
      "mediaSize": BigInt,
      "pps": 987,
      "props10Min": 987,
      "devices": 987,
      "devicesOffline": 123,
      "users": 123,
      "usersDisabled": 123,
      "appUsers": 987,
      "userGroups": 123,
      "objects": 123,
      "historySize": BigInt,
      "notifications": 987,
      "notificationsSize": BigInt,
      "deliveries": 987,
      "deliveriesSize": BigInt,
      "controls": 987,
      "controlsSize": BigInt
    }
  }
}

Queries

`getDetailedNotificationsHistory`

Returns detailed notifications history for given time interval and object list

Returns [DetailedNotificationHistoryItem]

Name	Description
`objectIds` - `[UUID]`
`timeFrom` - `Datetime`
`timeTo` - `Datetime`
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`filter` - `DetailedNotificationHistoryItemFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query getDetailedNotificationsHistory($objectIds: [UUID], $timeFrom: Datetime, $timeTo: Datetime, $first: Int, $offset: Int, $filter: DetailedNotificationHistoryItemFilter) {
  getDetailedNotificationsHistory(objectIds: $objectIds, timeFrom: $timeFrom, timeTo: $timeTo, first: $first, offset: $offset, filter: $filter) {
    objectId
    objectName
    enabled
    message
    spec
    tags
    createdAt
    by
    schemaName
    schemaType
    schemaTags
  }
}

Variables

{
  "objectIds": [UUID],
  "timeFrom": Datetime,
  "timeTo": Datetime,
  "first": 123,
  "offset": 123,
  "filter": DetailedNotificationHistoryItemFilter
}

Response

{
  "data": {
    "getDetailedNotificationsHistory": [
      {
        "objectId": UUID,
        "objectName": "xyz789",
        "enabled": false,
        "message": "xyz789",
        "spec": {},
        "tags": ["abc123"],
        "createdAt": Datetime,
        "by": "xyz789",
        "schemaName": "abc123",
        "schemaType": "abc123",
        "schemaTags": ["xyz789"]
      }
    ]
  }
}

Queries

`getDetailedNotificationsHistoryConnection`

Returns detailed notifications history for given time interval and object list

Returns a DetailedNotificationHistoryItemsConnection

Name	Description
`objectIds` - `[UUID]`
`timeFrom` - `Datetime`
`timeTo` - `Datetime`
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`filter` - `DetailedNotificationHistoryItemFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query getDetailedNotificationsHistoryConnection($objectIds: [UUID], $timeFrom: Datetime, $timeTo: Datetime, $first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $filter: DetailedNotificationHistoryItemFilter) {
  getDetailedNotificationsHistoryConnection(objectIds: $objectIds, timeFrom: $timeFrom, timeTo: $timeTo, first: $first, last: $last, offset: $offset, before: $before, after: $after, filter: $filter) {
    nodes {
      ...DetailedNotificationHistoryItemFragment
    }
    edges {
      ...DetailedNotificationHistoryItemsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "objectIds": [UUID],
  "timeFrom": Datetime,
  "timeTo": Datetime,
  "first": 123,
  "last": 123,
  "offset": 987,
  "before": Cursor,
  "after": Cursor,
  "filter": DetailedNotificationHistoryItemFilter
}

Response

{
  "data": {
    "getDetailedNotificationsHistoryConnection": {
      "nodes": [DetailedNotificationHistoryItem],
      "edges": [DetailedNotificationHistoryItemsEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`getDetailedObjectPropertiesHistory`

Returns detailed object properties hsitory for given time interval

Returns [DetailedPropertyHistoryItem]

Name	Description
`userIds` - `[UUID]`
`timeFrom` - `Datetime`
`timeTo` - `Datetime`
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`filter` - `DetailedPropertyHistoryItemFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query getDetailedObjectPropertiesHistory($userIds: [UUID], $timeFrom: Datetime, $timeTo: Datetime, $first: Int, $offset: Int, $filter: DetailedPropertyHistoryItemFilter) {
  getDetailedObjectPropertiesHistory(userIds: $userIds, timeFrom: $timeFrom, timeTo: $timeTo, first: $first, offset: $offset, filter: $filter) {
    objectId
    groupName
    property
    value
    recordedAt
    by
    objectName
    enabled
    schemaName
    schemaType
    schemaTags
    units
    stealth
    valueType
    notNull
    parentObjectName
    parentSchemaName
    parentSchemaType
  }
}

Variables

{
  "userIds": [UUID],
  "timeFrom": Datetime,
  "timeTo": Datetime,
  "first": 987,
  "offset": 987,
  "filter": DetailedPropertyHistoryItemFilter
}

Response

{
  "data": {
    "getDetailedObjectPropertiesHistory": [
      {
        "objectId": UUID,
        "groupName": "xyz789",
        "property": "xyz789",
        "value": {},
        "recordedAt": Datetime,
        "by": "xyz789",
        "objectName": "abc123",
        "enabled": true,
        "schemaName": "abc123",
        "schemaType": "xyz789",
        "schemaTags": ["xyz789"],
        "units": "abc123",
        "stealth": false,
        "valueType": "abc123",
        "notNull": false,
        "parentObjectName": "xyz789",
        "parentSchemaName": "xyz789",
        "parentSchemaType": "abc123"
      }
    ]
  }
}

Queries

`getDetailedObjectPropertiesHistoryByPropertiesId`

Returns detailed object properties hsitory for given time interval

Returns [DetailedPropertyHistoryItem]

Name	Description
`userIds` - `[UUID]`
`schemaPropertyIds` - `[UUID]`
`timeFrom` - `Datetime`
`timeTo` - `Datetime`
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`filter` - `DetailedPropertyHistoryItemFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query getDetailedObjectPropertiesHistoryByPropertiesId($userIds: [UUID], $schemaPropertyIds: [UUID], $timeFrom: Datetime, $timeTo: Datetime, $first: Int, $offset: Int, $filter: DetailedPropertyHistoryItemFilter) {
  getDetailedObjectPropertiesHistoryByPropertiesId(userIds: $userIds, schemaPropertyIds: $schemaPropertyIds, timeFrom: $timeFrom, timeTo: $timeTo, first: $first, offset: $offset, filter: $filter) {
    objectId
    groupName
    property
    value
    recordedAt
    by
    objectName
    enabled
    schemaName
    schemaType
    schemaTags
    units
    stealth
    valueType
    notNull
    parentObjectName
    parentSchemaName
    parentSchemaType
  }
}

Variables

{
  "userIds": [UUID],
  "schemaPropertyIds": [UUID],
  "timeFrom": Datetime,
  "timeTo": Datetime,
  "first": 123,
  "offset": 123,
  "filter": DetailedPropertyHistoryItemFilter
}

Response

{
  "data": {
    "getDetailedObjectPropertiesHistoryByPropertiesId": [
      {
        "objectId": UUID,
        "groupName": "abc123",
        "property": "xyz789",
        "value": {},
        "recordedAt": Datetime,
        "by": "xyz789",
        "objectName": "abc123",
        "enabled": true,
        "schemaName": "abc123",
        "schemaType": "abc123",
        "schemaTags": ["abc123"],
        "units": "abc123",
        "stealth": true,
        "valueType": "abc123",
        "notNull": true,
        "parentObjectName": "xyz789",
        "parentSchemaName": "xyz789",
        "parentSchemaType": "xyz789"
      }
    ]
  }
}

Queries

`getDetailedObjectPropertiesHistoryByPropertiesIdConnection`

Returns detailed object properties hsitory for given time interval

Returns a DetailedPropertyHistoryItemsConnection

Name	Description
`userIds` - `[UUID]`
`schemaPropertyIds` - `[UUID]`
`timeFrom` - `Datetime`
`timeTo` - `Datetime`
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`filter` - `DetailedPropertyHistoryItemFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query getDetailedObjectPropertiesHistoryByPropertiesIdConnection($userIds: [UUID], $schemaPropertyIds: [UUID], $timeFrom: Datetime, $timeTo: Datetime, $first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $filter: DetailedPropertyHistoryItemFilter) {
  getDetailedObjectPropertiesHistoryByPropertiesIdConnection(userIds: $userIds, schemaPropertyIds: $schemaPropertyIds, timeFrom: $timeFrom, timeTo: $timeTo, first: $first, last: $last, offset: $offset, before: $before, after: $after, filter: $filter) {
    nodes {
      ...DetailedPropertyHistoryItemFragment
    }
    edges {
      ...DetailedPropertyHistoryItemsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "userIds": [UUID],
  "schemaPropertyIds": [UUID],
  "timeFrom": Datetime,
  "timeTo": Datetime,
  "first": 123,
  "last": 123,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "filter": DetailedPropertyHistoryItemFilter
}

Response

{
  "data": {
    "getDetailedObjectPropertiesHistoryByPropertiesIdConnection": {
      "nodes": [DetailedPropertyHistoryItem],
      "edges": [DetailedPropertyHistoryItemsEdge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Queries

`getDetailedObjectPropertiesHistoryConnection`

Returns detailed object properties hsitory for given time interval

Returns a DetailedPropertyHistoryItemsConnection

Name	Description
`userIds` - `[UUID]`
`timeFrom` - `Datetime`
`timeTo` - `Datetime`
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`filter` - `DetailedPropertyHistoryItemFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query getDetailedObjectPropertiesHistoryConnection($userIds: [UUID], $timeFrom: Datetime, $timeTo: Datetime, $first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $filter: DetailedPropertyHistoryItemFilter) {
  getDetailedObjectPropertiesHistoryConnection(userIds: $userIds, timeFrom: $timeFrom, timeTo: $timeTo, first: $first, last: $last, offset: $offset, before: $before, after: $after, filter: $filter) {
    nodes {
      ...DetailedPropertyHistoryItemFragment
    }
    edges {
      ...DetailedPropertyHistoryItemsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "userIds": [UUID],
  "timeFrom": Datetime,
  "timeTo": Datetime,
  "first": 987,
  "last": 123,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "filter": DetailedPropertyHistoryItemFilter
}

Response

{
  "data": {
    "getDetailedObjectPropertiesHistoryConnection": {
      "nodes": [DetailedPropertyHistoryItem],
      "edges": [DetailedPropertyHistoryItemsEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`getDistinctNotificationTags`

Returns distinct tags from notifications table

Returns [String]

Example

Query

query getDistinctNotificationTags {
  getDistinctNotificationTags
}

Response

{"data": {"getDistinctNotificationTags": ["xyz789"]}}

Queries

`getDistinctPropertyValuesByKey`

Returns distinct values of chosen property for given schema objects

Returns [JSON]

Name	Description
`schemaId` - `UUID`
`keyedProperty` - `String`

Example

Query

query getDistinctPropertyValuesByKey($schemaId: UUID, $keyedProperty: String) {
  getDistinctPropertyValuesByKey(schemaId: $schemaId, keyedProperty: $keyedProperty)
}

Variables

{"schemaId": UUID, "keyedProperty": "xyz789"}

Response

{"data": {"getDistinctPropertyValuesByKey": [{}]}}

Queries

`getDistinctSchemas`

Returns distinct schemas of given type

Returns [String]

Name	Description
`schemaType` - `String`
`enabledOnly` - `Boolean`

Example

Query

query getDistinctSchemas($schemaType: String, $enabledOnly: Boolean) {
  getDistinctSchemas(schemaType: $schemaType, enabledOnly: $enabledOnly)
}

Variables

{"schemaType": "xyz789", "enabledOnly": false}

Response

{"data": {"getDistinctSchemas": ["abc123"]}}

Queries

`getObjectType`

Returns object schema type

Returns a String

Name	Description
`userId` - `UUID`

Example

Query

query getObjectType($userId: UUID) {
  getObjectType(userId: $userId)
}

Variables

{"userId": UUID}

Response

{"data": {"getObjectType": "abc123"}}

Queries

`getRefreshTokenId`

Returns refresh token id for the current session, can be used to form subscription topic name.

Returns a String

Example

Query

query getRefreshTokenId {
  getRefreshTokenId
}

Response

{"data": {"getRefreshTokenId": "abc123"}}

Queries

`getTime`

Get core DB time

Returns a String

Example

Query

query getTime {
  getTime
}

Response

{"data": {"getTime": "xyz789"}}

Queries

`getTimezone`

Returns Platform native Timezone used.

Returns a String

Example

Query

query getTimezone {
  getTimezone
}

Response

{"data": {"getTimezone": "xyz789"}}

Queries

`getTimezoneShift`

Get core DB timezone shift from UTC in minutes

Returns an Int

Example

Query

query getTimezoneShift {
  getTimezoneShift
}

Response

{"data": {"getTimezoneShift": 987}}

Queries

`getUserGroups`

Returns the current user's group list.

Returns [UUID]

Name	Description
`userId` - `UUID`

Example

Query

query getUserGroups($userId: UUID) {
  getUserGroups(userId: $userId)
}

Variables

{"userId": UUID}

Response

{"data": {"getUserGroups": [UUID]}}

Queries

`getUserId`

Returns current user id (uuid).

Returns a String

Example

Query

query getUserId {
  getUserId
}

Response

{"data": {"getUserId": "xyz789"}}

Queries

`getUserProfileId`

Returns UUID of the object which represents the profile for the current user and current application.

Returns a String

Example

Query

query getUserProfileId {
  getUserProfileId
}

Response

{"data": {"getUserProfileId": "abc123"}}

Queries

`getVersion`

Returns version information of the platform.

Returns a Version

Example

Query

query getVersion {
  getVersion {
    short
    long
  }
}

Response

{"data": {"getVersion": {"short": "xyz789", "long": "abc123"}}}

Queries

`nodeId`

The root query type must be a Node to work well with Relay 1 mutations. This just resolves to query

Returns an ID!

Example

Query

query nodeId {
  nodeId
}

Response

{"data": {"nodeId": ID}}

Queries

`notification`

Returns a Notification

Name	Description
`id` - `UUID!`

Example

Query

query notification($id: UUID!) {
  notification(id: $id) {
    nodeId
    id
    objectId
    objectName
    tags
    createdAt
    by
    spec
    message
    object {
      ...ObjectFragment
    }
    userByBy {
      ...UserFragment
    }
    notificationDeliveriesConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveries {
      ...NotificationDeliveryFragment
    }
    byName
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "notification": {
      "nodeId": ID,
      "id": UUID,
      "objectId": UUID,
      "objectName": "xyz789",
      "tags": ["xyz789"],
      "createdAt": Datetime,
      "by": UUID,
      "spec": {},
      "message": "abc123",
      "object": Object,
      "userByBy": User,
      "notificationDeliveriesConnection": NotificationDeliveriesConnection,
      "notificationDeliveries": [NotificationDelivery],
      "byName": "xyz789"
    }
  }
}

Queries

`notificationByNodeId`

Reads a single Notification using its globally unique ID

Returns a Notification

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `Notification`

Example

Query

query notificationByNodeId($nodeId: ID!) {
  notificationByNodeId(nodeId: $nodeId) {
    nodeId
    id
    objectId
    objectName
    tags
    createdAt
    by
    spec
    message
    object {
      ...ObjectFragment
    }
    userByBy {
      ...UserFragment
    }
    notificationDeliveriesConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveries {
      ...NotificationDeliveryFragment
    }
    byName
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "notificationByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "objectId": UUID,
      "objectName": "xyz789",
      "tags": ["abc123"],
      "createdAt": Datetime,
      "by": UUID,
      "spec": {},
      "message": "xyz789",
      "object": Object,
      "userByBy": User,
      "notificationDeliveriesConnection": NotificationDeliveriesConnection,
      "notificationDeliveries": [NotificationDelivery],
      "byName": "xyz789"
    }
  }
}

Queries

`notificationDeliveries`

Reads a set of NotificationDelivery

Returns [NotificationDelivery!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[NotificationDeliveriesSort!]`	The specification of how the `NotificationDelivery` records should be sorted
`orderBy` - `[NotificationDeliveriesOrderBy!]`	The method to use when ordering `NotificationDelivery`
`condition` - `NotificationDeliveryCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `NotificationDeliveryFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query notificationDeliveries($first: Int, $offset: Int, $sort: [NotificationDeliveriesSort!], $orderBy: [NotificationDeliveriesOrderBy!], $condition: NotificationDeliveryCondition, $filter: NotificationDeliveryFilter) {
  notificationDeliveries(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    user
    userLogin
    notificationId
    delivered
    deliveryPath
    message
    error
    deliveryConfigId
    createdAt
    by
    userByUser {
      ...UserFragment
    }
    deliveryConfig {
      ...ObjectFragment
    }
    notification {
      ...NotificationFragment
    }
  }
}

Variables

{
  "first": 123,
  "offset": 987,
  "sort": [NotificationDeliveriesSort],
  "orderBy": [NotificationDeliveriesOrderBy],
  "condition": NotificationDeliveryCondition,
  "filter": NotificationDeliveryFilter
}

Response

{
  "data": {
    "notificationDeliveries": [
      {
        "nodeId": ID,
        "id": UUID,
        "user": UUID,
        "userLogin": "abc123",
        "notificationId": UUID,
        "delivered": false,
        "deliveryPath": "abc123",
        "message": "xyz789",
        "error": "abc123",
        "deliveryConfigId": UUID,
        "createdAt": Datetime,
        "by": UUID,
        "userByUser": User,
        "deliveryConfig": Object,
        "notification": Notification
      }
    ]
  }
}

Queries

`notificationDeliveriesConnection`

Reads and enables pagination through a set of NotificationDelivery

Returns a NotificationDeliveriesConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[NotificationDeliveriesSort!]`	The specification of how the `NotificationDelivery` records should be sorted
`orderBy` - `[NotificationDeliveriesOrderBy!]`	The method to use when ordering `NotificationDelivery`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `NotificationDeliveryCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `NotificationDeliveryFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query notificationDeliveriesConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [NotificationDeliveriesSort!], $orderBy: [NotificationDeliveriesOrderBy!], $condition: NotificationDeliveryCondition, $filter: NotificationDeliveryFilter) {
  notificationDeliveriesConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...NotificationDeliveryFragment
    }
    edges {
      ...NotificationDeliveriesEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 987,
  "last": 987,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [NotificationDeliveriesSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": NotificationDeliveryCondition,
  "filter": NotificationDeliveryFilter
}

Response

{
  "data": {
    "notificationDeliveriesConnection": {
      "nodes": [NotificationDelivery],
      "edges": [NotificationDeliveriesEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`notificationDelivery`

Returns a NotificationDelivery

Name	Description
`id` - `UUID!`

Example

Query

query notificationDelivery($id: UUID!) {
  notificationDelivery(id: $id) {
    nodeId
    id
    user
    userLogin
    notificationId
    delivered
    deliveryPath
    message
    error
    deliveryConfigId
    createdAt
    by
    userByUser {
      ...UserFragment
    }
    deliveryConfig {
      ...ObjectFragment
    }
    notification {
      ...NotificationFragment
    }
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "notificationDelivery": {
      "nodeId": ID,
      "id": UUID,
      "user": UUID,
      "userLogin": "xyz789",
      "notificationId": UUID,
      "delivered": false,
      "deliveryPath": "xyz789",
      "message": "xyz789",
      "error": "abc123",
      "deliveryConfigId": UUID,
      "createdAt": Datetime,
      "by": UUID,
      "userByUser": User,
      "deliveryConfig": Object,
      "notification": Notification
    }
  }
}

Queries

`notificationDeliveryByNodeId`

Reads a single NotificationDelivery using its globally unique ID

Returns a NotificationDelivery

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `NotificationDelivery`

Example

Query

query notificationDeliveryByNodeId($nodeId: ID!) {
  notificationDeliveryByNodeId(nodeId: $nodeId) {
    nodeId
    id
    user
    userLogin
    notificationId
    delivered
    deliveryPath
    message
    error
    deliveryConfigId
    createdAt
    by
    userByUser {
      ...UserFragment
    }
    deliveryConfig {
      ...ObjectFragment
    }
    notification {
      ...NotificationFragment
    }
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "notificationDeliveryByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "user": UUID,
      "userLogin": "xyz789",
      "notificationId": UUID,
      "delivered": true,
      "deliveryPath": "abc123",
      "message": "abc123",
      "error": "abc123",
      "deliveryConfigId": UUID,
      "createdAt": Datetime,
      "by": UUID,
      "userByUser": User,
      "deliveryConfig": Object,
      "notification": Notification
    }
  }
}

Queries

`notifications`

Reads a set of Notification

Returns [Notification!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[NotificationsSort!]`	The specification of how the `Notification` records should be sorted
`orderBy` - `[NotificationsOrderBy!]`	The method to use when ordering `Notification`
`condition` - `NotificationCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `NotificationFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query notifications($first: Int, $offset: Int, $sort: [NotificationsSort!], $orderBy: [NotificationsOrderBy!], $condition: NotificationCondition, $filter: NotificationFilter) {
  notifications(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    objectId
    objectName
    tags
    createdAt
    by
    spec
    message
    object {
      ...ObjectFragment
    }
    userByBy {
      ...UserFragment
    }
    notificationDeliveriesConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveries {
      ...NotificationDeliveryFragment
    }
    byName
  }
}

Variables

{
  "first": 123,
  "offset": 123,
  "sort": [NotificationsSort],
  "orderBy": [NotificationsOrderBy],
  "condition": NotificationCondition,
  "filter": NotificationFilter
}

Response

{
  "data": {
    "notifications": [
      {
        "nodeId": ID,
        "id": UUID,
        "objectId": UUID,
        "objectName": "xyz789",
        "tags": ["xyz789"],
        "createdAt": Datetime,
        "by": UUID,
        "spec": {},
        "message": "xyz789",
        "object": Object,
        "userByBy": User,
        "notificationDeliveriesConnection": NotificationDeliveriesConnection,
        "notificationDeliveries": [NotificationDelivery],
        "byName": "xyz789"
      }
    ]
  }
}

Queries

`notificationsConnection`

Reads and enables pagination through a set of Notification

Returns a NotificationsConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[NotificationsSort!]`	The specification of how the `Notification` records should be sorted
`orderBy` - `[NotificationsOrderBy!]`	The method to use when ordering `Notification`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `NotificationCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `NotificationFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query notificationsConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [NotificationsSort!], $orderBy: [NotificationsOrderBy!], $condition: NotificationCondition, $filter: NotificationFilter) {
  notificationsConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...NotificationFragment
    }
    edges {
      ...NotificationsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 123,
  "last": 123,
  "offset": 987,
  "before": Cursor,
  "after": Cursor,
  "sort": [NotificationsSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": NotificationCondition,
  "filter": NotificationFilter
}

Response

{
  "data": {
    "notificationsConnection": {
      "nodes": [Notification],
      "edges": [NotificationsEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`object`

Returns an Object

Name	Description
`id` - `UUID!`

Example

Query

query object($id: UUID!) {
  object(id: $id) {
    nodeId
    id
    name
    enabled
    description
    editorgroup
    usergroup
    readergroup
    createdAt
    updatedAt
    by
    schemaId
    tags
    previousEnabled
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    notificationsConnection {
      ...NotificationsConnectionFragment
    }
    notifications {
      ...NotificationFragment
    }
    objectPropertiesConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectProperties {
      ...ObjectPropertyFragment
    }
    controlExecutionsConnection {
      ...ControlExecutionsConnectionFragment
    }
    controlExecutions {
      ...ControlExecutionFragment
    }
    notificationDeliveriesByDeliveryConfigIdConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveriesByDeliveryConfigId {
      ...NotificationDeliveryFragment
    }
    objectsToObjectsByObject1IdConnection {
      ...ObjectsToObjectsConnectionFragment
    }
    objectsToObjectsByObject1Id {
      ...ObjectsToObjectFragment
    }
    objectsToObjectsByObject2IdConnection {
      ...ObjectsToObjectsConnectionFragment
    }
    objectsToObjectsByObject2Id {
      ...ObjectsToObjectFragment
    }
    userProfilesConnection {
      ...UserProfilesConnectionFragment
    }
    userProfiles {
      ...UserProfileFragment
    }
    usersToObjectsConnection {
      ...UsersToObjectsConnectionFragment
    }
    usersToObjects {
      ...UsersToObjectFragment
    }
    deviceBatteryLevel
    deviceBatteryType
    deviceEmulation
    deviceResponseStatus
    favourite
    groupName
    hardLinked
    mediaFilename
    mediaSize
    mediaType
    muted
    propertiesUpdatedAt
    property
    propertyBool
    propertyDouble
    propertyInt
    propertyTs
    schemaName
    schemaTags
    schemaTagsString
    schemaType
    stringId
    dynamicAttribute
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "object": {
      "nodeId": ID,
      "id": UUID,
      "name": "abc123",
      "enabled": false,
      "description": "xyz789",
      "editorgroup": UUID,
      "usergroup": UUID,
      "readergroup": UUID,
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "schemaId": UUID,
      "tags": ["abc123"],
      "previousEnabled": false,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "notificationsConnection": NotificationsConnection,
      "notifications": [Notification],
      "objectPropertiesConnection": ObjectPropertiesConnection,
      "objectProperties": [ObjectProperty],
      "controlExecutionsConnection": ControlExecutionsConnection,
      "controlExecutions": [ControlExecution],
      "notificationDeliveriesByDeliveryConfigIdConnection": NotificationDeliveriesConnection,
      "notificationDeliveriesByDeliveryConfigId": [
        NotificationDelivery
      ],
      "objectsToObjectsByObject1IdConnection": ObjectsToObjectsConnection,
      "objectsToObjectsByObject1Id": [ObjectsToObject],
      "objectsToObjectsByObject2IdConnection": ObjectsToObjectsConnection,
      "objectsToObjectsByObject2Id": [ObjectsToObject],
      "userProfilesConnection": UserProfilesConnection,
      "userProfiles": [UserProfile],
      "usersToObjectsConnection": UsersToObjectsConnection,
      "usersToObjects": [UsersToObject],
      "deviceBatteryLevel": {},
      "deviceBatteryType": {},
      "deviceEmulation": {},
      "deviceResponseStatus": {},
      "favourite": true,
      "groupName": "xyz789",
      "hardLinked": false,
      "mediaFilename": {},
      "mediaSize": {},
      "mediaType": {},
      "muted": false,
      "propertiesUpdatedAt": Datetime,
      "property": {},
      "propertyBool": false,
      "propertyDouble": 987.65,
      "propertyInt": 123,
      "propertyTs": Datetime,
      "schemaName": "xyz789",
      "schemaTags": ["xyz789"],
      "schemaTagsString": "xyz789",
      "schemaType": "xyz789",
      "stringId": "xyz789",
      "dynamicAttribute": {}
    }
  }
}

Queries

`objectByNodeId`

Reads a single Object using its globally unique ID

Returns an Object

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `Object`

Example

Query

query objectByNodeId($nodeId: ID!) {
  objectByNodeId(nodeId: $nodeId) {
    nodeId
    id
    name
    enabled
    description
    editorgroup
    usergroup
    readergroup
    createdAt
    updatedAt
    by
    schemaId
    tags
    previousEnabled
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    notificationsConnection {
      ...NotificationsConnectionFragment
    }
    notifications {
      ...NotificationFragment
    }
    objectPropertiesConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectProperties {
      ...ObjectPropertyFragment
    }
    controlExecutionsConnection {
      ...ControlExecutionsConnectionFragment
    }
    controlExecutions {
      ...ControlExecutionFragment
    }
    notificationDeliveriesByDeliveryConfigIdConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveriesByDeliveryConfigId {
      ...NotificationDeliveryFragment
    }
    objectsToObjectsByObject1IdConnection {
      ...ObjectsToObjectsConnectionFragment
    }
    objectsToObjectsByObject1Id {
      ...ObjectsToObjectFragment
    }
    objectsToObjectsByObject2IdConnection {
      ...ObjectsToObjectsConnectionFragment
    }
    objectsToObjectsByObject2Id {
      ...ObjectsToObjectFragment
    }
    userProfilesConnection {
      ...UserProfilesConnectionFragment
    }
    userProfiles {
      ...UserProfileFragment
    }
    usersToObjectsConnection {
      ...UsersToObjectsConnectionFragment
    }
    usersToObjects {
      ...UsersToObjectFragment
    }
    deviceBatteryLevel
    deviceBatteryType
    deviceEmulation
    deviceResponseStatus
    favourite
    groupName
    hardLinked
    mediaFilename
    mediaSize
    mediaType
    muted
    propertiesUpdatedAt
    property
    propertyBool
    propertyDouble
    propertyInt
    propertyTs
    schemaName
    schemaTags
    schemaTagsString
    schemaType
    stringId
    dynamicAttribute
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "objectByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "name": "abc123",
      "enabled": true,
      "description": "abc123",
      "editorgroup": UUID,
      "usergroup": UUID,
      "readergroup": UUID,
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "schemaId": UUID,
      "tags": ["xyz789"],
      "previousEnabled": false,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "notificationsConnection": NotificationsConnection,
      "notifications": [Notification],
      "objectPropertiesConnection": ObjectPropertiesConnection,
      "objectProperties": [ObjectProperty],
      "controlExecutionsConnection": ControlExecutionsConnection,
      "controlExecutions": [ControlExecution],
      "notificationDeliveriesByDeliveryConfigIdConnection": NotificationDeliveriesConnection,
      "notificationDeliveriesByDeliveryConfigId": [
        NotificationDelivery
      ],
      "objectsToObjectsByObject1IdConnection": ObjectsToObjectsConnection,
      "objectsToObjectsByObject1Id": [ObjectsToObject],
      "objectsToObjectsByObject2IdConnection": ObjectsToObjectsConnection,
      "objectsToObjectsByObject2Id": [ObjectsToObject],
      "userProfilesConnection": UserProfilesConnection,
      "userProfiles": [UserProfile],
      "usersToObjectsConnection": UsersToObjectsConnection,
      "usersToObjects": [UsersToObject],
      "deviceBatteryLevel": {},
      "deviceBatteryType": {},
      "deviceEmulation": {},
      "deviceResponseStatus": {},
      "favourite": true,
      "groupName": "xyz789",
      "hardLinked": false,
      "mediaFilename": {},
      "mediaSize": {},
      "mediaType": {},
      "muted": true,
      "propertiesUpdatedAt": Datetime,
      "property": {},
      "propertyBool": true,
      "propertyDouble": 987.65,
      "propertyInt": 123,
      "propertyTs": Datetime,
      "schemaName": "abc123",
      "schemaTags": ["xyz789"],
      "schemaTagsString": "abc123",
      "schemaType": "abc123",
      "stringId": "xyz789",
      "dynamicAttribute": {}
    }
  }
}

Queries

`objectProperties`

Reads a set of ObjectProperty

Returns [ObjectProperty!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[ObjectPropertiesSort!]`	The specification of how the `ObjectProperty` records should be sorted
`orderBy` - `[ObjectPropertiesOrderBy!]`	The method to use when ordering `ObjectProperty`
`condition` - `ObjectPropertyCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ObjectPropertyFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query objectProperties($first: Int, $offset: Int, $sort: [ObjectPropertiesSort!], $orderBy: [ObjectPropertiesOrderBy!], $condition: ObjectPropertyCondition, $filter: ObjectPropertyFilter) {
  objectProperties(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    objectId
    groupName
    property
    value
    updatedAt
    id
    transactionId
    linkedPropertyId
    index
    stealth
    by
    editorgroup
    usergroup
    readergroup
    typeId
    previousValue
    object {
      ...ObjectFragment
    }
    linkedProperty {
      ...ObjectPropertyFragment
    }
    userByBy {
      ...UserFragment
    }
    objectPropertiesByLinkedPropertyIdConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectPropertiesByLinkedPropertyId {
      ...ObjectPropertyFragment
    }
    key
    spec {
      ...SchemaPropertyFragment
    }
    type
  }
}

Variables

{
  "first": 987,
  "offset": 987,
  "sort": [ObjectPropertiesSort],
  "orderBy": [ObjectPropertiesOrderBy],
  "condition": ObjectPropertyCondition,
  "filter": ObjectPropertyFilter
}

Response

{
  "data": {
    "objectProperties": [
      {
        "nodeId": ID,
        "objectId": UUID,
        "groupName": "xyz789",
        "property": "xyz789",
        "value": {},
        "updatedAt": Datetime,
        "id": UUID,
        "transactionId": BigInt,
        "linkedPropertyId": UUID,
        "index": BigInt,
        "stealth": false,
        "by": UUID,
        "editorgroup": UUID,
        "usergroup": UUID,
        "readergroup": UUID,
        "typeId": UUID,
        "previousValue": {},
        "object": Object,
        "linkedProperty": ObjectProperty,
        "userByBy": User,
        "objectPropertiesByLinkedPropertyIdConnection": ObjectPropertiesConnection,
        "objectPropertiesByLinkedPropertyId": [
          ObjectProperty
        ],
        "key": "abc123",
        "spec": SchemaProperty,
        "type": "abc123"
      }
    ]
  }
}

Queries

`objectPropertiesConnection`

Reads and enables pagination through a set of ObjectProperty

Returns an ObjectPropertiesConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[ObjectPropertiesSort!]`	The specification of how the `ObjectProperty` records should be sorted
`orderBy` - `[ObjectPropertiesOrderBy!]`	The method to use when ordering `ObjectProperty`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `ObjectPropertyCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ObjectPropertyFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query objectPropertiesConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [ObjectPropertiesSort!], $orderBy: [ObjectPropertiesOrderBy!], $condition: ObjectPropertyCondition, $filter: ObjectPropertyFilter) {
  objectPropertiesConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...ObjectPropertyFragment
    }
    edges {
      ...ObjectPropertiesEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 987,
  "last": 123,
  "offset": 987,
  "before": Cursor,
  "after": Cursor,
  "sort": [ObjectPropertiesSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": ObjectPropertyCondition,
  "filter": ObjectPropertyFilter
}

Response

{
  "data": {
    "objectPropertiesConnection": {
      "nodes": [ObjectProperty],
      "edges": [ObjectPropertiesEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`objectPropertiesHistories`

Reads a set of ObjectPropertiesHistory

Returns [ObjectPropertiesHistory!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[ObjectPropertiesHistorySort!]`	The specification of how the `ObjectPropertiesHistory` records should be sorted
`orderBy` - `[ObjectPropertiesHistoriesOrderBy!]`	The method to use when ordering `ObjectPropertiesHistory`
`condition` - `ObjectPropertiesHistoryCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ObjectPropertiesHistoryFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query objectPropertiesHistories($first: Int, $offset: Int, $sort: [ObjectPropertiesHistorySort!], $orderBy: [ObjectPropertiesHistoriesOrderBy!], $condition: ObjectPropertiesHistoryCondition, $filter: ObjectPropertiesHistoryFilter) {
  objectPropertiesHistories(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    objectId
    groupName
    property
    value
    recordedAt
    propertyId
    by
    transactionId
    userByBy {
      ...UserFragment
    }
    jsonbValue
  }
}

Variables

{
  "first": 123,
  "offset": 123,
  "sort": [ObjectPropertiesHistorySort],
  "orderBy": [ObjectPropertiesHistoriesOrderBy],
  "condition": ObjectPropertiesHistoryCondition,
  "filter": ObjectPropertiesHistoryFilter
}

Response

{
  "data": {
    "objectPropertiesHistories": [
      {
        "nodeId": ID,
        "id": 123,
        "objectId": UUID,
        "groupName": "abc123",
        "property": "abc123",
        "value": {},
        "recordedAt": Datetime,
        "propertyId": UUID,
        "by": UUID,
        "transactionId": BigInt,
        "userByBy": User,
        "jsonbValue": {}
      }
    ]
  }
}

Queries

`objectPropertiesHistoriesConnection`

Reads and enables pagination through a set of ObjectPropertiesHistory

Returns an ObjectPropertiesHistoriesConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[ObjectPropertiesHistorySort!]`	The specification of how the `ObjectPropertiesHistory` records should be sorted
`orderBy` - `[ObjectPropertiesHistoriesOrderBy!]`	The method to use when ordering `ObjectPropertiesHistory`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `ObjectPropertiesHistoryCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ObjectPropertiesHistoryFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query objectPropertiesHistoriesConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [ObjectPropertiesHistorySort!], $orderBy: [ObjectPropertiesHistoriesOrderBy!], $condition: ObjectPropertiesHistoryCondition, $filter: ObjectPropertiesHistoryFilter) {
  objectPropertiesHistoriesConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...ObjectPropertiesHistoryFragment
    }
    edges {
      ...ObjectPropertiesHistoriesEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 987,
  "last": 987,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [ObjectPropertiesHistorySort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": ObjectPropertiesHistoryCondition,
  "filter": ObjectPropertiesHistoryFilter
}

Response

{
  "data": {
    "objectPropertiesHistoriesConnection": {
      "nodes": [ObjectPropertiesHistory],
      "edges": [ObjectPropertiesHistoriesEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`objectPropertiesHistory`

Returns an ObjectPropertiesHistory

Name	Description
`recordedAt` - `Datetime!`
`id` - `Int!`

Example

Query

query objectPropertiesHistory($recordedAt: Datetime!, $id: Int!) {
  objectPropertiesHistory(recordedAt: $recordedAt, id: $id) {
    nodeId
    id
    objectId
    groupName
    property
    value
    recordedAt
    propertyId
    by
    transactionId
    userByBy {
      ...UserFragment
    }
    jsonbValue
  }
}

Variables

{"recordedAt": Datetime, "id": 123}

Response

{
  "data": {
    "objectPropertiesHistory": {
      "nodeId": ID,
      "id": 987,
      "objectId": UUID,
      "groupName": "xyz789",
      "property": "abc123",
      "value": {},
      "recordedAt": Datetime,
      "propertyId": UUID,
      "by": UUID,
      "transactionId": BigInt,
      "userByBy": User,
      "jsonbValue": {}
    }
  }
}

Queries

`objectPropertiesHistoryByNodeId`

Reads a single ObjectPropertiesHistory using its globally unique ID

Returns an ObjectPropertiesHistory

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `ObjectPropertiesHistory`

Example

Query

query objectPropertiesHistoryByNodeId($nodeId: ID!) {
  objectPropertiesHistoryByNodeId(nodeId: $nodeId) {
    nodeId
    id
    objectId
    groupName
    property
    value
    recordedAt
    propertyId
    by
    transactionId
    userByBy {
      ...UserFragment
    }
    jsonbValue
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "objectPropertiesHistoryByNodeId": {
      "nodeId": ID,
      "id": 987,
      "objectId": UUID,
      "groupName": "abc123",
      "property": "abc123",
      "value": {},
      "recordedAt": Datetime,
      "propertyId": UUID,
      "by": UUID,
      "transactionId": BigInt,
      "userByBy": User,
      "jsonbValue": {}
    }
  }
}

Queries

`objectProperty`

Returns an ObjectProperty

Name	Description
`id` - `UUID!`

Example

Query

query objectProperty($id: UUID!) {
  objectProperty(id: $id) {
    nodeId
    objectId
    groupName
    property
    value
    updatedAt
    id
    transactionId
    linkedPropertyId
    index
    stealth
    by
    editorgroup
    usergroup
    readergroup
    typeId
    previousValue
    object {
      ...ObjectFragment
    }
    linkedProperty {
      ...ObjectPropertyFragment
    }
    userByBy {
      ...UserFragment
    }
    objectPropertiesByLinkedPropertyIdConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectPropertiesByLinkedPropertyId {
      ...ObjectPropertyFragment
    }
    key
    spec {
      ...SchemaPropertyFragment
    }
    type
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "objectProperty": {
      "nodeId": ID,
      "objectId": UUID,
      "groupName": "xyz789",
      "property": "xyz789",
      "value": {},
      "updatedAt": Datetime,
      "id": UUID,
      "transactionId": BigInt,
      "linkedPropertyId": UUID,
      "index": BigInt,
      "stealth": true,
      "by": UUID,
      "editorgroup": UUID,
      "usergroup": UUID,
      "readergroup": UUID,
      "typeId": UUID,
      "previousValue": {},
      "object": Object,
      "linkedProperty": ObjectProperty,
      "userByBy": User,
      "objectPropertiesByLinkedPropertyIdConnection": ObjectPropertiesConnection,
      "objectPropertiesByLinkedPropertyId": [
        ObjectProperty
      ],
      "key": "xyz789",
      "spec": SchemaProperty,
      "type": "xyz789"
    }
  }
}

Queries

`objectPropertyByNodeId`

Reads a single ObjectProperty using its globally unique ID

Returns an ObjectProperty

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `ObjectProperty`

Example

Query

query objectPropertyByNodeId($nodeId: ID!) {
  objectPropertyByNodeId(nodeId: $nodeId) {
    nodeId
    objectId
    groupName
    property
    value
    updatedAt
    id
    transactionId
    linkedPropertyId
    index
    stealth
    by
    editorgroup
    usergroup
    readergroup
    typeId
    previousValue
    object {
      ...ObjectFragment
    }
    linkedProperty {
      ...ObjectPropertyFragment
    }
    userByBy {
      ...UserFragment
    }
    objectPropertiesByLinkedPropertyIdConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectPropertiesByLinkedPropertyId {
      ...ObjectPropertyFragment
    }
    key
    spec {
      ...SchemaPropertyFragment
    }
    type
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "objectPropertyByNodeId": {
      "nodeId": ID,
      "objectId": UUID,
      "groupName": "abc123",
      "property": "abc123",
      "value": {},
      "updatedAt": Datetime,
      "id": UUID,
      "transactionId": BigInt,
      "linkedPropertyId": UUID,
      "index": BigInt,
      "stealth": true,
      "by": UUID,
      "editorgroup": UUID,
      "usergroup": UUID,
      "readergroup": UUID,
      "typeId": UUID,
      "previousValue": {},
      "object": Object,
      "linkedProperty": ObjectProperty,
      "userByBy": User,
      "objectPropertiesByLinkedPropertyIdConnection": ObjectPropertiesConnection,
      "objectPropertiesByLinkedPropertyId": [
        ObjectProperty
      ],
      "key": "xyz789",
      "spec": SchemaProperty,
      "type": "abc123"
    }
  }
}

Queries

`objects`

Reads a set of Object

Returns [Object!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[ObjectsSort!]`	The specification of how the `Object` records should be sorted
`orderBy` - `[ObjectsOrderBy!]`	The method to use when ordering `Object`
`condition` - `ObjectCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ObjectFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query objects($first: Int, $offset: Int, $sort: [ObjectsSort!], $orderBy: [ObjectsOrderBy!], $condition: ObjectCondition, $filter: ObjectFilter) {
  objects(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    name
    enabled
    description
    editorgroup
    usergroup
    readergroup
    createdAt
    updatedAt
    by
    schemaId
    tags
    previousEnabled
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    notificationsConnection {
      ...NotificationsConnectionFragment
    }
    notifications {
      ...NotificationFragment
    }
    objectPropertiesConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectProperties {
      ...ObjectPropertyFragment
    }
    controlExecutionsConnection {
      ...ControlExecutionsConnectionFragment
    }
    controlExecutions {
      ...ControlExecutionFragment
    }
    notificationDeliveriesByDeliveryConfigIdConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveriesByDeliveryConfigId {
      ...NotificationDeliveryFragment
    }
    objectsToObjectsByObject1IdConnection {
      ...ObjectsToObjectsConnectionFragment
    }
    objectsToObjectsByObject1Id {
      ...ObjectsToObjectFragment
    }
    objectsToObjectsByObject2IdConnection {
      ...ObjectsToObjectsConnectionFragment
    }
    objectsToObjectsByObject2Id {
      ...ObjectsToObjectFragment
    }
    userProfilesConnection {
      ...UserProfilesConnectionFragment
    }
    userProfiles {
      ...UserProfileFragment
    }
    usersToObjectsConnection {
      ...UsersToObjectsConnectionFragment
    }
    usersToObjects {
      ...UsersToObjectFragment
    }
    deviceBatteryLevel
    deviceBatteryType
    deviceEmulation
    deviceResponseStatus
    favourite
    groupName
    hardLinked
    mediaFilename
    mediaSize
    mediaType
    muted
    propertiesUpdatedAt
    property
    propertyBool
    propertyDouble
    propertyInt
    propertyTs
    schemaName
    schemaTags
    schemaTagsString
    schemaType
    stringId
    dynamicAttribute
  }
}

Variables

{
  "first": 123,
  "offset": 987,
  "sort": [ObjectsSort],
  "orderBy": [ObjectsOrderBy],
  "condition": ObjectCondition,
  "filter": ObjectFilter
}

Response

{
  "data": {
    "objects": [
      {
        "nodeId": ID,
        "id": UUID,
        "name": "abc123",
        "enabled": false,
        "description": "xyz789",
        "editorgroup": UUID,
        "usergroup": UUID,
        "readergroup": UUID,
        "createdAt": Datetime,
        "updatedAt": Datetime,
        "by": UUID,
        "schemaId": UUID,
        "tags": ["abc123"],
        "previousEnabled": false,
        "userGroupByEditorgroup": UserGroup,
        "userGroupByUsergroup": UserGroup,
        "userGroupByReadergroup": UserGroup,
        "userByBy": User,
        "schema": Schema,
        "notificationsConnection": NotificationsConnection,
        "notifications": [Notification],
        "objectPropertiesConnection": ObjectPropertiesConnection,
        "objectProperties": [ObjectProperty],
        "controlExecutionsConnection": ControlExecutionsConnection,
        "controlExecutions": [ControlExecution],
        "notificationDeliveriesByDeliveryConfigIdConnection": NotificationDeliveriesConnection,
        "notificationDeliveriesByDeliveryConfigId": [
          NotificationDelivery
        ],
        "objectsToObjectsByObject1IdConnection": ObjectsToObjectsConnection,
        "objectsToObjectsByObject1Id": [ObjectsToObject],
        "objectsToObjectsByObject2IdConnection": ObjectsToObjectsConnection,
        "objectsToObjectsByObject2Id": [ObjectsToObject],
        "userProfilesConnection": UserProfilesConnection,
        "userProfiles": [UserProfile],
        "usersToObjectsConnection": UsersToObjectsConnection,
        "usersToObjects": [UsersToObject],
        "deviceBatteryLevel": {},
        "deviceBatteryType": {},
        "deviceEmulation": {},
        "deviceResponseStatus": {},
        "favourite": false,
        "groupName": "abc123",
        "hardLinked": false,
        "mediaFilename": {},
        "mediaSize": {},
        "mediaType": {},
        "muted": false,
        "propertiesUpdatedAt": Datetime,
        "property": {},
        "propertyBool": false,
        "propertyDouble": 987.65,
        "propertyInt": 987,
        "propertyTs": Datetime,
        "schemaName": "abc123",
        "schemaTags": ["abc123"],
        "schemaTagsString": "xyz789",
        "schemaType": "abc123",
        "stringId": "abc123",
        "dynamicAttribute": {}
      }
    ]
  }
}

Queries

`objectsConnection`

Reads and enables pagination through a set of Object

Returns an ObjectsConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[ObjectsSort!]`	The specification of how the `Object` records should be sorted
`orderBy` - `[ObjectsOrderBy!]`	The method to use when ordering `Object`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `ObjectCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ObjectFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query objectsConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [ObjectsSort!], $orderBy: [ObjectsOrderBy!], $condition: ObjectCondition, $filter: ObjectFilter) {
  objectsConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...ObjectFragment
    }
    edges {
      ...ObjectsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 123,
  "last": 987,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [ObjectsSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": ObjectCondition,
  "filter": ObjectFilter
}

Response

{
  "data": {
    "objectsConnection": {
      "nodes": [Object],
      "edges": [ObjectsEdge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Queries

`objectsToObject`

Returns an ObjectsToObject

Name	Description
`id` - `UUID!`

Example

Query

query objectsToObject($id: UUID!) {
  objectsToObject(id: $id) {
    nodeId
    object1Id
    object2Id
    id
    forced
    object1 {
      ...ObjectFragment
    }
    object2 {
      ...ObjectFragment
    }
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "objectsToObject": {
      "nodeId": ID,
      "object1Id": UUID,
      "object2Id": UUID,
      "id": UUID,
      "forced": 987,
      "object1": Object,
      "object2": Object
    }
  }
}

Queries

`objectsToObjectByNodeId`

Reads a single ObjectsToObject using its globally unique ID

Returns an ObjectsToObject

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `ObjectsToObject`

Example

Query

query objectsToObjectByNodeId($nodeId: ID!) {
  objectsToObjectByNodeId(nodeId: $nodeId) {
    nodeId
    object1Id
    object2Id
    id
    forced
    object1 {
      ...ObjectFragment
    }
    object2 {
      ...ObjectFragment
    }
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "objectsToObjectByNodeId": {
      "nodeId": ID,
      "object1Id": UUID,
      "object2Id": UUID,
      "id": UUID,
      "forced": 123,
      "object1": Object,
      "object2": Object
    }
  }
}

Queries

`objectsToObjectByObject1IdAndObject2Id`

Returns an ObjectsToObject

Name	Description
`object1Id` - `UUID!`
`object2Id` - `UUID!`

Example

Query

query objectsToObjectByObject1IdAndObject2Id($object1Id: UUID!, $object2Id: UUID!) {
  objectsToObjectByObject1IdAndObject2Id(object1Id: $object1Id, object2Id: $object2Id) {
    nodeId
    object1Id
    object2Id
    id
    forced
    object1 {
      ...ObjectFragment
    }
    object2 {
      ...ObjectFragment
    }
  }
}

Variables

{
  "object1Id": UUID,
  "object2Id": UUID
}

Response

{
  "data": {
    "objectsToObjectByObject1IdAndObject2Id": {
      "nodeId": ID,
      "object1Id": UUID,
      "object2Id": UUID,
      "id": UUID,
      "forced": 987,
      "object1": Object,
      "object2": Object
    }
  }
}

Queries

`objectsToObjects`

Reads a set of ObjectsToObject

Returns [ObjectsToObject!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[ObjectsToObjectsSort!]`	The specification of how the `ObjectsToObject` records should be sorted
`orderBy` - `[ObjectsToObjectsOrderBy!]`	The method to use when ordering `ObjectsToObject`
`condition` - `ObjectsToObjectCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ObjectsToObjectFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query objectsToObjects($first: Int, $offset: Int, $sort: [ObjectsToObjectsSort!], $orderBy: [ObjectsToObjectsOrderBy!], $condition: ObjectsToObjectCondition, $filter: ObjectsToObjectFilter) {
  objectsToObjects(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    object1Id
    object2Id
    id
    forced
    object1 {
      ...ObjectFragment
    }
    object2 {
      ...ObjectFragment
    }
  }
}

Variables

{
  "first": 987,
  "offset": 123,
  "sort": [ObjectsToObjectsSort],
  "orderBy": [ObjectsToObjectsOrderBy],
  "condition": ObjectsToObjectCondition,
  "filter": ObjectsToObjectFilter
}

Response

{
  "data": {
    "objectsToObjects": [
      {
        "nodeId": ID,
        "object1Id": UUID,
        "object2Id": UUID,
        "id": UUID,
        "forced": 987,
        "object1": Object,
        "object2": Object
      }
    ]
  }
}

Queries

`objectsToObjectsConnection`

Reads and enables pagination through a set of ObjectsToObject

Returns an ObjectsToObjectsConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[ObjectsToObjectsSort!]`	The specification of how the `ObjectsToObject` records should be sorted
`orderBy` - `[ObjectsToObjectsOrderBy!]`	The method to use when ordering `ObjectsToObject`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `ObjectsToObjectCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ObjectsToObjectFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query objectsToObjectsConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [ObjectsToObjectsSort!], $orderBy: [ObjectsToObjectsOrderBy!], $condition: ObjectsToObjectCondition, $filter: ObjectsToObjectFilter) {
  objectsToObjectsConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...ObjectsToObjectFragment
    }
    edges {
      ...ObjectsToObjectsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 123,
  "last": 123,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [ObjectsToObjectsSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": ObjectsToObjectCondition,
  "filter": ObjectsToObjectFilter
}

Response

{
  "data": {
    "objectsToObjectsConnection": {
      "nodes": [ObjectsToObject],
      "edges": [ObjectsToObjectsEdge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Queries

`propertyType`

Returns a PropertyType

Name	Description
`id` - `UUID!`

Example

Query

query propertyType($id: UUID!) {
  propertyType(id: $id) {
    nodeId
    id
    name
    description
    schema
    schemaPropertiesByTypeIdConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaPropertiesByTypeId {
      ...SchemaPropertyFragment
    }
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "propertyType": {
      "nodeId": ID,
      "id": UUID,
      "name": "xyz789",
      "description": "xyz789",
      "schema": {},
      "schemaPropertiesByTypeIdConnection": SchemaPropertiesConnection,
      "schemaPropertiesByTypeId": [SchemaProperty]
    }
  }
}

Queries

`propertyTypeByName`

Returns a PropertyType

Name	Description
`name` - `String!`

Example

Query

query propertyTypeByName($name: String!) {
  propertyTypeByName(name: $name) {
    nodeId
    id
    name
    description
    schema
    schemaPropertiesByTypeIdConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaPropertiesByTypeId {
      ...SchemaPropertyFragment
    }
  }
}

Variables

{"name": "abc123"}

Response

{
  "data": {
    "propertyTypeByName": {
      "nodeId": ID,
      "id": UUID,
      "name": "xyz789",
      "description": "abc123",
      "schema": {},
      "schemaPropertiesByTypeIdConnection": SchemaPropertiesConnection,
      "schemaPropertiesByTypeId": [SchemaProperty]
    }
  }
}

Queries

`propertyTypeByNodeId`

Reads a single PropertyType using its globally unique ID

Returns a PropertyType

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `PropertyType`

Example

Query

query propertyTypeByNodeId($nodeId: ID!) {
  propertyTypeByNodeId(nodeId: $nodeId) {
    nodeId
    id
    name
    description
    schema
    schemaPropertiesByTypeIdConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaPropertiesByTypeId {
      ...SchemaPropertyFragment
    }
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "propertyTypeByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "name": "xyz789",
      "description": "xyz789",
      "schema": {},
      "schemaPropertiesByTypeIdConnection": SchemaPropertiesConnection,
      "schemaPropertiesByTypeId": [SchemaProperty]
    }
  }
}

Queries

`propertyTypes`

Reads a set of PropertyType

Returns [PropertyType!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[PropertyTypesSort!]`	The specification of how the `PropertyType` records should be sorted
`orderBy` - `[PropertyTypesOrderBy!]`	The method to use when ordering `PropertyType`
`condition` - `PropertyTypeCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `PropertyTypeFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query propertyTypes($first: Int, $offset: Int, $sort: [PropertyTypesSort!], $orderBy: [PropertyTypesOrderBy!], $condition: PropertyTypeCondition, $filter: PropertyTypeFilter) {
  propertyTypes(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    name
    description
    schema
    schemaPropertiesByTypeIdConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaPropertiesByTypeId {
      ...SchemaPropertyFragment
    }
  }
}

Variables

{
  "first": 123,
  "offset": 987,
  "sort": [PropertyTypesSort],
  "orderBy": [PropertyTypesOrderBy],
  "condition": PropertyTypeCondition,
  "filter": PropertyTypeFilter
}

Response

{
  "data": {
    "propertyTypes": [
      {
        "nodeId": ID,
        "id": UUID,
        "name": "xyz789",
        "description": "xyz789",
        "schema": {},
        "schemaPropertiesByTypeIdConnection": SchemaPropertiesConnection,
        "schemaPropertiesByTypeId": [SchemaProperty]
      }
    ]
  }
}

Queries

`propertyTypesConnection`

Reads and enables pagination through a set of PropertyType

Returns a PropertyTypesConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[PropertyTypesSort!]`	The specification of how the `PropertyType` records should be sorted
`orderBy` - `[PropertyTypesOrderBy!]`	The method to use when ordering `PropertyType`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `PropertyTypeCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `PropertyTypeFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query propertyTypesConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [PropertyTypesSort!], $orderBy: [PropertyTypesOrderBy!], $condition: PropertyTypeCondition, $filter: PropertyTypeFilter) {
  propertyTypesConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...PropertyTypeFragment
    }
    edges {
      ...PropertyTypesEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 123,
  "last": 987,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [PropertyTypesSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": PropertyTypeCondition,
  "filter": PropertyTypeFilter
}

Response

{
  "data": {
    "propertyTypesConnection": {
      "nodes": [PropertyType],
      "edges": [PropertyTypesEdge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Queries

`schema`

Returns a Schema

Name	Description
`id` - `UUID!`

Example

Query

query schema($id: UUID!) {
  schema(id: $id) {
    nodeId
    id
    name
    applicationOwner
    type
    enabled
    defaultTtl {
      ...IntervalFragment
    }
    description
    mLongname
    mVersion
    mManufacturer
    mAuthor
    mEmail
    mExternalId
    editorgroup
    usergroup
    readergroup
    createdAt
    updatedAt
    by
    mTags
    mPicture
    mIcon
    parentSchemaId
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaPropertiesConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaProperties {
      ...SchemaPropertyFragment
    }
    objectsConnection {
      ...ObjectsConnectionFragment
    }
    objects {
      ...ObjectFragment
    }
    schemaControlsConnection {
      ...SchemaControlsConnectionFragment
    }
    schemaControls {
      ...SchemaControlFragment
    }
    schemataByParentSchemaIdConnection {
      ...SchemataConnectionFragment
    }
    schemataByParentSchemaId {
      ...SchemaFragment
    }
    groupName
    objectsCount
    parentSchemaName
    property
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "schema": {
      "nodeId": ID,
      "id": UUID,
      "name": "abc123",
      "applicationOwner": UUID,
      "type": SchemaTypes,
      "enabled": false,
      "defaultTtl": Interval,
      "description": "xyz789",
      "mLongname": "xyz789",
      "mVersion": "xyz789",
      "mManufacturer": "xyz789",
      "mAuthor": "abc123",
      "mEmail": "abc123",
      "mExternalId": UUID,
      "editorgroup": UUID,
      "usergroup": UUID,
      "readergroup": UUID,
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "mTags": ["xyz789"],
      "mPicture": "abc123",
      "mIcon": "xyz789",
      "parentSchemaId": UUID,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaPropertiesConnection": SchemaPropertiesConnection,
      "schemaProperties": [SchemaProperty],
      "objectsConnection": ObjectsConnection,
      "objects": [Object],
      "schemaControlsConnection": SchemaControlsConnection,
      "schemaControls": [SchemaControl],
      "schemataByParentSchemaIdConnection": SchemataConnection,
      "schemataByParentSchemaId": [Schema],
      "groupName": "abc123",
      "objectsCount": 987,
      "parentSchemaName": "xyz789",
      "property": {}
    }
  }
}

Queries

`schemaByNodeId`

Reads a single Schema using its globally unique ID

Returns a Schema

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `Schema`

Example

Query

query schemaByNodeId($nodeId: ID!) {
  schemaByNodeId(nodeId: $nodeId) {
    nodeId
    id
    name
    applicationOwner
    type
    enabled
    defaultTtl {
      ...IntervalFragment
    }
    description
    mLongname
    mVersion
    mManufacturer
    mAuthor
    mEmail
    mExternalId
    editorgroup
    usergroup
    readergroup
    createdAt
    updatedAt
    by
    mTags
    mPicture
    mIcon
    parentSchemaId
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaPropertiesConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaProperties {
      ...SchemaPropertyFragment
    }
    objectsConnection {
      ...ObjectsConnectionFragment
    }
    objects {
      ...ObjectFragment
    }
    schemaControlsConnection {
      ...SchemaControlsConnectionFragment
    }
    schemaControls {
      ...SchemaControlFragment
    }
    schemataByParentSchemaIdConnection {
      ...SchemataConnectionFragment
    }
    schemataByParentSchemaId {
      ...SchemaFragment
    }
    groupName
    objectsCount
    parentSchemaName
    property
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "schemaByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "name": "xyz789",
      "applicationOwner": UUID,
      "type": SchemaTypes,
      "enabled": false,
      "defaultTtl": Interval,
      "description": "xyz789",
      "mLongname": "abc123",
      "mVersion": "xyz789",
      "mManufacturer": "xyz789",
      "mAuthor": "abc123",
      "mEmail": "xyz789",
      "mExternalId": UUID,
      "editorgroup": UUID,
      "usergroup": UUID,
      "readergroup": UUID,
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "mTags": ["abc123"],
      "mPicture": "xyz789",
      "mIcon": "abc123",
      "parentSchemaId": UUID,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaPropertiesConnection": SchemaPropertiesConnection,
      "schemaProperties": [SchemaProperty],
      "objectsConnection": ObjectsConnection,
      "objects": [Object],
      "schemaControlsConnection": SchemaControlsConnection,
      "schemaControls": [SchemaControl],
      "schemataByParentSchemaIdConnection": SchemataConnection,
      "schemataByParentSchemaId": [Schema],
      "groupName": "xyz789",
      "objectsCount": 987,
      "parentSchemaName": "abc123",
      "property": {}
    }
  }
}

Queries

`schemaControl`

Returns a SchemaControl

Name	Description
`id` - `UUID!`

Example

Query

query schemaControl($id: UUID!) {
  schemaControl(id: $id) {
    nodeId
    id
    rpc
    description
    argument
    typeSpec
    hidden
    schemaId
    units
    regex
    valueRange
    valueSet
    mask
    defaultValue
    createdAt
    updatedAt
    by
    notNull
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    argumentDefault
    isRpc
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "schemaControl": {
      "nodeId": ID,
      "id": UUID,
      "rpc": "xyz789",
      "description": "xyz789",
      "argument": "xyz789",
      "typeSpec": "abc123",
      "hidden": false,
      "schemaId": UUID,
      "units": "xyz789",
      "regex": "xyz789",
      "valueRange": {},
      "valueSet": {},
      "mask": "abc123",
      "defaultValue": {},
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "notNull": false,
      "schema": Schema,
      "userByBy": User,
      "argumentDefault": "xyz789",
      "isRpc": false
    }
  }
}

Queries

`schemaControlByNodeId`

Reads a single SchemaControl using its globally unique ID

Returns a SchemaControl

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `SchemaControl`

Example

Query

query schemaControlByNodeId($nodeId: ID!) {
  schemaControlByNodeId(nodeId: $nodeId) {
    nodeId
    id
    rpc
    description
    argument
    typeSpec
    hidden
    schemaId
    units
    regex
    valueRange
    valueSet
    mask
    defaultValue
    createdAt
    updatedAt
    by
    notNull
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    argumentDefault
    isRpc
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "schemaControlByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "rpc": "abc123",
      "description": "abc123",
      "argument": "xyz789",
      "typeSpec": "xyz789",
      "hidden": true,
      "schemaId": UUID,
      "units": "abc123",
      "regex": "xyz789",
      "valueRange": {},
      "valueSet": {},
      "mask": "xyz789",
      "defaultValue": {},
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "notNull": true,
      "schema": Schema,
      "userByBy": User,
      "argumentDefault": "xyz789",
      "isRpc": true
    }
  }
}

Queries

`schemaControls`

Reads a set of SchemaControl

Returns [SchemaControl!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[SchemaControlsSort!]`	The specification of how the `SchemaControl` records should be sorted
`orderBy` - `[SchemaControlsOrderBy!]`	The method to use when ordering `SchemaControl`
`condition` - `SchemaControlCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `SchemaControlFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query schemaControls($first: Int, $offset: Int, $sort: [SchemaControlsSort!], $orderBy: [SchemaControlsOrderBy!], $condition: SchemaControlCondition, $filter: SchemaControlFilter) {
  schemaControls(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    rpc
    description
    argument
    typeSpec
    hidden
    schemaId
    units
    regex
    valueRange
    valueSet
    mask
    defaultValue
    createdAt
    updatedAt
    by
    notNull
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    argumentDefault
    isRpc
  }
}

Variables

{
  "first": 987,
  "offset": 123,
  "sort": [SchemaControlsSort],
  "orderBy": [SchemaControlsOrderBy],
  "condition": SchemaControlCondition,
  "filter": SchemaControlFilter
}

Response

{
  "data": {
    "schemaControls": [
      {
        "nodeId": ID,
        "id": UUID,
        "rpc": "xyz789",
        "description": "abc123",
        "argument": "xyz789",
        "typeSpec": "abc123",
        "hidden": true,
        "schemaId": UUID,
        "units": "xyz789",
        "regex": "abc123",
        "valueRange": {},
        "valueSet": {},
        "mask": "abc123",
        "defaultValue": {},
        "createdAt": Datetime,
        "updatedAt": Datetime,
        "by": UUID,
        "notNull": false,
        "schema": Schema,
        "userByBy": User,
        "argumentDefault": "xyz789",
        "isRpc": true
      }
    ]
  }
}

Queries

`schemaControlsConnection`

Reads and enables pagination through a set of SchemaControl

Returns a SchemaControlsConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[SchemaControlsSort!]`	The specification of how the `SchemaControl` records should be sorted
`orderBy` - `[SchemaControlsOrderBy!]`	The method to use when ordering `SchemaControl`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `SchemaControlCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `SchemaControlFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query schemaControlsConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [SchemaControlsSort!], $orderBy: [SchemaControlsOrderBy!], $condition: SchemaControlCondition, $filter: SchemaControlFilter) {
  schemaControlsConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...SchemaControlFragment
    }
    edges {
      ...SchemaControlsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 123,
  "last": 123,
  "offset": 987,
  "before": Cursor,
  "after": Cursor,
  "sort": [SchemaControlsSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": SchemaControlCondition,
  "filter": SchemaControlFilter
}

Response

{
  "data": {
    "schemaControlsConnection": {
      "nodes": [SchemaControl],
      "edges": [SchemaControlsEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`schemaProperties`

Reads a set of SchemaProperty

Returns [SchemaProperty!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[SchemaPropertiesSort!]`	The specification of how the `SchemaProperty` records should be sorted
`orderBy` - `[SchemaPropertiesOrderBy!]`	The method to use when ordering `SchemaProperty`
`condition` - `SchemaPropertyCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `SchemaPropertyFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query schemaProperties($first: Int, $offset: Int, $sort: [SchemaPropertiesSort!], $orderBy: [SchemaPropertiesOrderBy!], $condition: SchemaPropertyCondition, $filter: SchemaPropertyFilter) {
  schemaProperties(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    property
    groupName
    groupDescription
    hidden
    schemaId
    units
    regex
    valueRange
    valueSet
    mask
    defaultValue
    description
    createdAt
    updatedAt
    by
    index
    stealth
    typeId
    jsonSchema
    notNull
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    type {
      ...PropertyTypeFragment
    }
    key
    propertyI18N
  }
}

Variables

{
  "first": 123,
  "offset": 123,
  "sort": [SchemaPropertiesSort],
  "orderBy": [SchemaPropertiesOrderBy],
  "condition": SchemaPropertyCondition,
  "filter": SchemaPropertyFilter
}

Response

{
  "data": {
    "schemaProperties": [
      {
        "nodeId": ID,
        "id": UUID,
        "property": "abc123",
        "groupName": "xyz789",
        "groupDescription": "xyz789",
        "hidden": true,
        "schemaId": UUID,
        "units": "abc123",
        "regex": "xyz789",
        "valueRange": {},
        "valueSet": {},
        "mask": "abc123",
        "defaultValue": {},
        "description": "abc123",
        "createdAt": Datetime,
        "updatedAt": Datetime,
        "by": UUID,
        "index": BigInt,
        "stealth": true,
        "typeId": UUID,
        "jsonSchema": {},
        "notNull": true,
        "schema": Schema,
        "userByBy": User,
        "type": PropertyType,
        "key": "abc123",
        "propertyI18N": "abc123"
      }
    ]
  }
}

Queries

`schemaPropertiesConnection`

Reads and enables pagination through a set of SchemaProperty

Returns a SchemaPropertiesConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[SchemaPropertiesSort!]`	The specification of how the `SchemaProperty` records should be sorted
`orderBy` - `[SchemaPropertiesOrderBy!]`	The method to use when ordering `SchemaProperty`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `SchemaPropertyCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `SchemaPropertyFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query schemaPropertiesConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [SchemaPropertiesSort!], $orderBy: [SchemaPropertiesOrderBy!], $condition: SchemaPropertyCondition, $filter: SchemaPropertyFilter) {
  schemaPropertiesConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...SchemaPropertyFragment
    }
    edges {
      ...SchemaPropertiesEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 987,
  "last": 987,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [SchemaPropertiesSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": SchemaPropertyCondition,
  "filter": SchemaPropertyFilter
}

Response

{
  "data": {
    "schemaPropertiesConnection": {
      "nodes": [SchemaProperty],
      "edges": [SchemaPropertiesEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`schemaProperty`

Returns a SchemaProperty

Name	Description
`id` - `UUID!`

Example

Query

query schemaProperty($id: UUID!) {
  schemaProperty(id: $id) {
    nodeId
    id
    property
    groupName
    groupDescription
    hidden
    schemaId
    units
    regex
    valueRange
    valueSet
    mask
    defaultValue
    description
    createdAt
    updatedAt
    by
    index
    stealth
    typeId
    jsonSchema
    notNull
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    type {
      ...PropertyTypeFragment
    }
    key
    propertyI18N
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "schemaProperty": {
      "nodeId": ID,
      "id": UUID,
      "property": "xyz789",
      "groupName": "abc123",
      "groupDescription": "abc123",
      "hidden": true,
      "schemaId": UUID,
      "units": "abc123",
      "regex": "xyz789",
      "valueRange": {},
      "valueSet": {},
      "mask": "abc123",
      "defaultValue": {},
      "description": "abc123",
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "index": BigInt,
      "stealth": true,
      "typeId": UUID,
      "jsonSchema": {},
      "notNull": true,
      "schema": Schema,
      "userByBy": User,
      "type": PropertyType,
      "key": "xyz789",
      "propertyI18N": "abc123"
    }
  }
}

Queries

`schemaPropertyByNodeId`

Reads a single SchemaProperty using its globally unique ID

Returns a SchemaProperty

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `SchemaProperty`

Example

Query

query schemaPropertyByNodeId($nodeId: ID!) {
  schemaPropertyByNodeId(nodeId: $nodeId) {
    nodeId
    id
    property
    groupName
    groupDescription
    hidden
    schemaId
    units
    regex
    valueRange
    valueSet
    mask
    defaultValue
    description
    createdAt
    updatedAt
    by
    index
    stealth
    typeId
    jsonSchema
    notNull
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    type {
      ...PropertyTypeFragment
    }
    key
    propertyI18N
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "schemaPropertyByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "property": "abc123",
      "groupName": "xyz789",
      "groupDescription": "abc123",
      "hidden": true,
      "schemaId": UUID,
      "units": "xyz789",
      "regex": "abc123",
      "valueRange": {},
      "valueSet": {},
      "mask": "xyz789",
      "defaultValue": {},
      "description": "xyz789",
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "index": BigInt,
      "stealth": false,
      "typeId": UUID,
      "jsonSchema": {},
      "notNull": false,
      "schema": Schema,
      "userByBy": User,
      "type": PropertyType,
      "key": "xyz789",
      "propertyI18N": "abc123"
    }
  }
}

Queries

`schemata`

Reads a set of Schema

Returns [Schema!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[SchemasSort!]`	The specification of how the `Schema` records should be sorted
`orderBy` - `[SchemataOrderBy!]`	The method to use when ordering `Schema`
`condition` - `SchemaCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `SchemaFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query schemata($first: Int, $offset: Int, $sort: [SchemasSort!], $orderBy: [SchemataOrderBy!], $condition: SchemaCondition, $filter: SchemaFilter) {
  schemata(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    name
    applicationOwner
    type
    enabled
    defaultTtl {
      ...IntervalFragment
    }
    description
    mLongname
    mVersion
    mManufacturer
    mAuthor
    mEmail
    mExternalId
    editorgroup
    usergroup
    readergroup
    createdAt
    updatedAt
    by
    mTags
    mPicture
    mIcon
    parentSchemaId
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaPropertiesConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaProperties {
      ...SchemaPropertyFragment
    }
    objectsConnection {
      ...ObjectsConnectionFragment
    }
    objects {
      ...ObjectFragment
    }
    schemaControlsConnection {
      ...SchemaControlsConnectionFragment
    }
    schemaControls {
      ...SchemaControlFragment
    }
    schemataByParentSchemaIdConnection {
      ...SchemataConnectionFragment
    }
    schemataByParentSchemaId {
      ...SchemaFragment
    }
    groupName
    objectsCount
    parentSchemaName
    property
  }
}

Variables

{
  "first": 987,
  "offset": 987,
  "sort": [SchemasSort],
  "orderBy": [SchemataOrderBy],
  "condition": SchemaCondition,
  "filter": SchemaFilter
}

Response

{
  "data": {
    "schemata": [
      {
        "nodeId": ID,
        "id": UUID,
        "name": "xyz789",
        "applicationOwner": UUID,
        "type": SchemaTypes,
        "enabled": true,
        "defaultTtl": Interval,
        "description": "abc123",
        "mLongname": "xyz789",
        "mVersion": "xyz789",
        "mManufacturer": "abc123",
        "mAuthor": "abc123",
        "mEmail": "abc123",
        "mExternalId": UUID,
        "editorgroup": UUID,
        "usergroup": UUID,
        "readergroup": UUID,
        "createdAt": Datetime,
        "updatedAt": Datetime,
        "by": UUID,
        "mTags": ["xyz789"],
        "mPicture": "abc123",
        "mIcon": "abc123",
        "parentSchemaId": UUID,
        "userByApplicationOwner": User,
        "userGroupByEditorgroup": UserGroup,
        "userGroupByUsergroup": UserGroup,
        "userGroupByReadergroup": UserGroup,
        "userByBy": User,
        "parentSchema": Schema,
        "schemaPropertiesConnection": SchemaPropertiesConnection,
        "schemaProperties": [SchemaProperty],
        "objectsConnection": ObjectsConnection,
        "objects": [Object],
        "schemaControlsConnection": SchemaControlsConnection,
        "schemaControls": [SchemaControl],
        "schemataByParentSchemaIdConnection": SchemataConnection,
        "schemataByParentSchemaId": [Schema],
        "groupName": "abc123",
        "objectsCount": 123,
        "parentSchemaName": "xyz789",
        "property": {}
      }
    ]
  }
}

Queries

`schemataConnection`

Reads and enables pagination through a set of Schema

Returns a SchemataConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[SchemasSort!]`	The specification of how the `Schema` records should be sorted
`orderBy` - `[SchemataOrderBy!]`	The method to use when ordering `Schema`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `SchemaCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `SchemaFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query schemataConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [SchemasSort!], $orderBy: [SchemataOrderBy!], $condition: SchemaCondition, $filter: SchemaFilter) {
  schemataConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...SchemaFragment
    }
    edges {
      ...SchemataEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 987,
  "last": 123,
  "offset": 987,
  "before": Cursor,
  "after": Cursor,
  "sort": [SchemasSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": SchemaCondition,
  "filter": SchemaFilter
}

Response

{
  "data": {
    "schemataConnection": {
      "nodes": [Schema],
      "edges": [SchemataEdge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Queries

`translation`

Returns a Translation

Name	Description
`uuid` - `UUID!`

Example

Query

query translation($uuid: UUID!) {
  translation(uuid: $uuid) {
    nodeId
    uuid
    query
    key
    ru
    en
    th
    cn
  }
}

Variables

{"uuid": UUID}

Response

{
  "data": {
    "translation": {
      "nodeId": ID,
      "uuid": UUID,
      "query": "xyz789",
      "key": "xyz789",
      "ru": "abc123",
      "en": "xyz789",
      "th": "xyz789",
      "cn": "abc123"
    }
  }
}

Queries

`translationByNodeId`

Reads a single Translation using its globally unique ID

Returns a Translation

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `Translation`

Example

Query

query translationByNodeId($nodeId: ID!) {
  translationByNodeId(nodeId: $nodeId) {
    nodeId
    uuid
    query
    key
    ru
    en
    th
    cn
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "translationByNodeId": {
      "nodeId": ID,
      "uuid": UUID,
      "query": "abc123",
      "key": "abc123",
      "ru": "xyz789",
      "en": "xyz789",
      "th": "xyz789",
      "cn": "abc123"
    }
  }
}

Queries

`translations`

Reads a set of Translation

Returns [Translation!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[TranslationsSort!]`	The specification of how the `Translation` records should be sorted
`orderBy` - `[TranslationsOrderBy!]`	The method to use when ordering `Translation`
`condition` - `TranslationCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `TranslationFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query translations($first: Int, $offset: Int, $sort: [TranslationsSort!], $orderBy: [TranslationsOrderBy!], $condition: TranslationCondition, $filter: TranslationFilter) {
  translations(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    uuid
    query
    key
    ru
    en
    th
    cn
  }
}

Variables

{
  "first": 987,
  "offset": 987,
  "sort": [TranslationsSort],
  "orderBy": [TranslationsOrderBy],
  "condition": TranslationCondition,
  "filter": TranslationFilter
}

Response

{
  "data": {
    "translations": [
      {
        "nodeId": ID,
        "uuid": UUID,
        "query": "xyz789",
        "key": "xyz789",
        "ru": "xyz789",
        "en": "xyz789",
        "th": "abc123",
        "cn": "abc123"
      }
    ]
  }
}

Queries

`translationsConnection`

Reads and enables pagination through a set of Translation

Returns a TranslationsConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[TranslationsSort!]`	The specification of how the `Translation` records should be sorted
`orderBy` - `[TranslationsOrderBy!]`	The method to use when ordering `Translation`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `TranslationCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `TranslationFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query translationsConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [TranslationsSort!], $orderBy: [TranslationsOrderBy!], $condition: TranslationCondition, $filter: TranslationFilter) {
  translationsConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...TranslationFragment
    }
    edges {
      ...TranslationsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 123,
  "last": 123,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [TranslationsSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": TranslationCondition,
  "filter": TranslationFilter
}

Response

{
  "data": {
    "translationsConnection": {
      "nodes": [Translation],
      "edges": [TranslationsEdge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Queries

`user`

Returns a User

Name	Description
`id` - `UUID!`

Example

Query

query user($id: UUID!) {
  user(id: $id) {
    nodeId
    id
    login
    password
    showhidden
    enabled
    description
    mName
    mExternalId
    mPhone
    mEmail
    mPicture
    mIcon
    createdAt
    updatedAt
    by
    type
    tokenExp
    activated
    passwordReset
    mTags
    defaultEditorgroup
    defaultUsergroup
    defaultReadergroup
    um
    passwordExpireAt
    logonStatus
    twoFaType
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    notificationsByByConnection {
      ...NotificationsConnectionFragment
    }
    notificationsByBy {
      ...NotificationFragment
    }
    schemaPropertiesByByConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaPropertiesByBy {
      ...SchemaPropertyFragment
    }
    objectPropertiesByByConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectPropertiesByBy {
      ...ObjectPropertyFragment
    }
    objectsByByConnection {
      ...ObjectsConnectionFragment
    }
    objectsByBy {
      ...ObjectFragment
    }
    schemaControlsByByConnection {
      ...SchemaControlsConnectionFragment
    }
    schemaControlsByBy {
      ...SchemaControlFragment
    }
    schemataByApplicationOwnerConnection {
      ...SchemataConnectionFragment
    }
    schemataByApplicationOwner {
      ...SchemaFragment
    }
    schemataByByConnection {
      ...SchemataConnectionFragment
    }
    schemataByBy {
      ...SchemaFragment
    }
    objectPropertiesHistoriesByByConnection {
      ...ObjectPropertiesHistoriesConnectionFragment
    }
    objectPropertiesHistoriesByBy {
      ...ObjectPropertiesHistoryFragment
    }
    controlExecutionsByCallerIdConnection {
      ...ControlExecutionsConnectionFragment
    }
    controlExecutionsByCallerId {
      ...ControlExecutionFragment
    }
    notificationDeliveriesByUserConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveriesByUser {
      ...NotificationDeliveryFragment
    }
    userGroupsByByConnection {
      ...UserGroupsConnectionFragment
    }
    userGroupsByBy {
      ...UserGroupFragment
    }
    userProfilesConnection {
      ...UserProfilesConnectionFragment
    }
    userProfiles {
      ...UserProfileFragment
    }
    usersToGroupsConnection {
      ...UsersToGroupsConnectionFragment
    }
    usersToGroups {
      ...UsersToGroupFragment
    }
    usersToObjectsConnection {
      ...UsersToObjectsConnectionFragment
    }
    usersToObjects {
      ...UsersToObjectFragment
    }
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "user": {
      "nodeId": ID,
      "id": UUID,
      "login": "xyz789",
      "password": "abc123",
      "showhidden": false,
      "enabled": true,
      "description": "xyz789",
      "mName": "abc123",
      "mExternalId": {},
      "mPhone": "xyz789",
      "mEmail": "abc123",
      "mPicture": UUID,
      "mIcon": UUID,
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "type": UserTypes,
      "tokenExp": BigInt,
      "activated": false,
      "passwordReset": false,
      "mTags": ["abc123"],
      "defaultEditorgroup": UUID,
      "defaultUsergroup": UUID,
      "defaultReadergroup": UUID,
      "um": true,
      "passwordExpireAt": Datetime,
      "logonStatus": "abc123",
      "twoFaType": TwoFaTypes,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "notificationsByByConnection": NotificationsConnection,
      "notificationsByBy": [Notification],
      "schemaPropertiesByByConnection": SchemaPropertiesConnection,
      "schemaPropertiesByBy": [SchemaProperty],
      "objectPropertiesByByConnection": ObjectPropertiesConnection,
      "objectPropertiesByBy": [ObjectProperty],
      "objectsByByConnection": ObjectsConnection,
      "objectsByBy": [Object],
      "schemaControlsByByConnection": SchemaControlsConnection,
      "schemaControlsByBy": [SchemaControl],
      "schemataByApplicationOwnerConnection": SchemataConnection,
      "schemataByApplicationOwner": [Schema],
      "schemataByByConnection": SchemataConnection,
      "schemataByBy": [Schema],
      "objectPropertiesHistoriesByByConnection": ObjectPropertiesHistoriesConnection,
      "objectPropertiesHistoriesByBy": [
        ObjectPropertiesHistory
      ],
      "controlExecutionsByCallerIdConnection": ControlExecutionsConnection,
      "controlExecutionsByCallerId": [ControlExecution],
      "notificationDeliveriesByUserConnection": NotificationDeliveriesConnection,
      "notificationDeliveriesByUser": [
        NotificationDelivery
      ],
      "userGroupsByByConnection": UserGroupsConnection,
      "userGroupsByBy": [UserGroup],
      "userProfilesConnection": UserProfilesConnection,
      "userProfiles": [UserProfile],
      "usersToGroupsConnection": UsersToGroupsConnection,
      "usersToGroups": [UsersToGroup],
      "usersToObjectsConnection": UsersToObjectsConnection,
      "usersToObjects": [UsersToObject]
    }
  }
}

Queries

`userByLogin`

Returns a User

Name	Description
`login` - `String!`

Example

Query

query userByLogin($login: String!) {
  userByLogin(login: $login) {
    nodeId
    id
    login
    password
    showhidden
    enabled
    description
    mName
    mExternalId
    mPhone
    mEmail
    mPicture
    mIcon
    createdAt
    updatedAt
    by
    type
    tokenExp
    activated
    passwordReset
    mTags
    defaultEditorgroup
    defaultUsergroup
    defaultReadergroup
    um
    passwordExpireAt
    logonStatus
    twoFaType
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    notificationsByByConnection {
      ...NotificationsConnectionFragment
    }
    notificationsByBy {
      ...NotificationFragment
    }
    schemaPropertiesByByConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaPropertiesByBy {
      ...SchemaPropertyFragment
    }
    objectPropertiesByByConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectPropertiesByBy {
      ...ObjectPropertyFragment
    }
    objectsByByConnection {
      ...ObjectsConnectionFragment
    }
    objectsByBy {
      ...ObjectFragment
    }
    schemaControlsByByConnection {
      ...SchemaControlsConnectionFragment
    }
    schemaControlsByBy {
      ...SchemaControlFragment
    }
    schemataByApplicationOwnerConnection {
      ...SchemataConnectionFragment
    }
    schemataByApplicationOwner {
      ...SchemaFragment
    }
    schemataByByConnection {
      ...SchemataConnectionFragment
    }
    schemataByBy {
      ...SchemaFragment
    }
    objectPropertiesHistoriesByByConnection {
      ...ObjectPropertiesHistoriesConnectionFragment
    }
    objectPropertiesHistoriesByBy {
      ...ObjectPropertiesHistoryFragment
    }
    controlExecutionsByCallerIdConnection {
      ...ControlExecutionsConnectionFragment
    }
    controlExecutionsByCallerId {
      ...ControlExecutionFragment
    }
    notificationDeliveriesByUserConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveriesByUser {
      ...NotificationDeliveryFragment
    }
    userGroupsByByConnection {
      ...UserGroupsConnectionFragment
    }
    userGroupsByBy {
      ...UserGroupFragment
    }
    userProfilesConnection {
      ...UserProfilesConnectionFragment
    }
    userProfiles {
      ...UserProfileFragment
    }
    usersToGroupsConnection {
      ...UsersToGroupsConnectionFragment
    }
    usersToGroups {
      ...UsersToGroupFragment
    }
    usersToObjectsConnection {
      ...UsersToObjectsConnectionFragment
    }
    usersToObjects {
      ...UsersToObjectFragment
    }
  }
}

Variables

{"login": "abc123"}

Response

{
  "data": {
    "userByLogin": {
      "nodeId": ID,
      "id": UUID,
      "login": "abc123",
      "password": "xyz789",
      "showhidden": false,
      "enabled": false,
      "description": "abc123",
      "mName": "xyz789",
      "mExternalId": {},
      "mPhone": "abc123",
      "mEmail": "abc123",
      "mPicture": UUID,
      "mIcon": UUID,
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "type": UserTypes,
      "tokenExp": BigInt,
      "activated": false,
      "passwordReset": false,
      "mTags": ["abc123"],
      "defaultEditorgroup": UUID,
      "defaultUsergroup": UUID,
      "defaultReadergroup": UUID,
      "um": true,
      "passwordExpireAt": Datetime,
      "logonStatus": "abc123",
      "twoFaType": TwoFaTypes,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "notificationsByByConnection": NotificationsConnection,
      "notificationsByBy": [Notification],
      "schemaPropertiesByByConnection": SchemaPropertiesConnection,
      "schemaPropertiesByBy": [SchemaProperty],
      "objectPropertiesByByConnection": ObjectPropertiesConnection,
      "objectPropertiesByBy": [ObjectProperty],
      "objectsByByConnection": ObjectsConnection,
      "objectsByBy": [Object],
      "schemaControlsByByConnection": SchemaControlsConnection,
      "schemaControlsByBy": [SchemaControl],
      "schemataByApplicationOwnerConnection": SchemataConnection,
      "schemataByApplicationOwner": [Schema],
      "schemataByByConnection": SchemataConnection,
      "schemataByBy": [Schema],
      "objectPropertiesHistoriesByByConnection": ObjectPropertiesHistoriesConnection,
      "objectPropertiesHistoriesByBy": [
        ObjectPropertiesHistory
      ],
      "controlExecutionsByCallerIdConnection": ControlExecutionsConnection,
      "controlExecutionsByCallerId": [ControlExecution],
      "notificationDeliveriesByUserConnection": NotificationDeliveriesConnection,
      "notificationDeliveriesByUser": [
        NotificationDelivery
      ],
      "userGroupsByByConnection": UserGroupsConnection,
      "userGroupsByBy": [UserGroup],
      "userProfilesConnection": UserProfilesConnection,
      "userProfiles": [UserProfile],
      "usersToGroupsConnection": UsersToGroupsConnection,
      "usersToGroups": [UsersToGroup],
      "usersToObjectsConnection": UsersToObjectsConnection,
      "usersToObjects": [UsersToObject]
    }
  }
}

Queries

`userByNodeId`

Reads a single User using its globally unique ID

Returns a User

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `User`

Example

Query

query userByNodeId($nodeId: ID!) {
  userByNodeId(nodeId: $nodeId) {
    nodeId
    id
    login
    password
    showhidden
    enabled
    description
    mName
    mExternalId
    mPhone
    mEmail
    mPicture
    mIcon
    createdAt
    updatedAt
    by
    type
    tokenExp
    activated
    passwordReset
    mTags
    defaultEditorgroup
    defaultUsergroup
    defaultReadergroup
    um
    passwordExpireAt
    logonStatus
    twoFaType
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    notificationsByByConnection {
      ...NotificationsConnectionFragment
    }
    notificationsByBy {
      ...NotificationFragment
    }
    schemaPropertiesByByConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaPropertiesByBy {
      ...SchemaPropertyFragment
    }
    objectPropertiesByByConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectPropertiesByBy {
      ...ObjectPropertyFragment
    }
    objectsByByConnection {
      ...ObjectsConnectionFragment
    }
    objectsByBy {
      ...ObjectFragment
    }
    schemaControlsByByConnection {
      ...SchemaControlsConnectionFragment
    }
    schemaControlsByBy {
      ...SchemaControlFragment
    }
    schemataByApplicationOwnerConnection {
      ...SchemataConnectionFragment
    }
    schemataByApplicationOwner {
      ...SchemaFragment
    }
    schemataByByConnection {
      ...SchemataConnectionFragment
    }
    schemataByBy {
      ...SchemaFragment
    }
    objectPropertiesHistoriesByByConnection {
      ...ObjectPropertiesHistoriesConnectionFragment
    }
    objectPropertiesHistoriesByBy {
      ...ObjectPropertiesHistoryFragment
    }
    controlExecutionsByCallerIdConnection {
      ...ControlExecutionsConnectionFragment
    }
    controlExecutionsByCallerId {
      ...ControlExecutionFragment
    }
    notificationDeliveriesByUserConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveriesByUser {
      ...NotificationDeliveryFragment
    }
    userGroupsByByConnection {
      ...UserGroupsConnectionFragment
    }
    userGroupsByBy {
      ...UserGroupFragment
    }
    userProfilesConnection {
      ...UserProfilesConnectionFragment
    }
    userProfiles {
      ...UserProfileFragment
    }
    usersToGroupsConnection {
      ...UsersToGroupsConnectionFragment
    }
    usersToGroups {
      ...UsersToGroupFragment
    }
    usersToObjectsConnection {
      ...UsersToObjectsConnectionFragment
    }
    usersToObjects {
      ...UsersToObjectFragment
    }
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "userByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "login": "xyz789",
      "password": "abc123",
      "showhidden": true,
      "enabled": false,
      "description": "xyz789",
      "mName": "xyz789",
      "mExternalId": {},
      "mPhone": "xyz789",
      "mEmail": "abc123",
      "mPicture": UUID,
      "mIcon": UUID,
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "type": UserTypes,
      "tokenExp": BigInt,
      "activated": false,
      "passwordReset": true,
      "mTags": ["abc123"],
      "defaultEditorgroup": UUID,
      "defaultUsergroup": UUID,
      "defaultReadergroup": UUID,
      "um": false,
      "passwordExpireAt": Datetime,
      "logonStatus": "xyz789",
      "twoFaType": TwoFaTypes,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "notificationsByByConnection": NotificationsConnection,
      "notificationsByBy": [Notification],
      "schemaPropertiesByByConnection": SchemaPropertiesConnection,
      "schemaPropertiesByBy": [SchemaProperty],
      "objectPropertiesByByConnection": ObjectPropertiesConnection,
      "objectPropertiesByBy": [ObjectProperty],
      "objectsByByConnection": ObjectsConnection,
      "objectsByBy": [Object],
      "schemaControlsByByConnection": SchemaControlsConnection,
      "schemaControlsByBy": [SchemaControl],
      "schemataByApplicationOwnerConnection": SchemataConnection,
      "schemataByApplicationOwner": [Schema],
      "schemataByByConnection": SchemataConnection,
      "schemataByBy": [Schema],
      "objectPropertiesHistoriesByByConnection": ObjectPropertiesHistoriesConnection,
      "objectPropertiesHistoriesByBy": [
        ObjectPropertiesHistory
      ],
      "controlExecutionsByCallerIdConnection": ControlExecutionsConnection,
      "controlExecutionsByCallerId": [ControlExecution],
      "notificationDeliveriesByUserConnection": NotificationDeliveriesConnection,
      "notificationDeliveriesByUser": [
        NotificationDelivery
      ],
      "userGroupsByByConnection": UserGroupsConnection,
      "userGroupsByBy": [UserGroup],
      "userProfilesConnection": UserProfilesConnection,
      "userProfiles": [UserProfile],
      "usersToGroupsConnection": UsersToGroupsConnection,
      "usersToGroups": [UsersToGroup],
      "usersToObjectsConnection": UsersToObjectsConnection,
      "usersToObjects": [UsersToObject]
    }
  }
}

Queries

`userGroup`

Returns a UserGroup

Name	Description
`id` - `UUID!`

Example

Query

query userGroup($id: UUID!) {
  userGroup(id: $id) {
    nodeId
    id
    groupName
    description
    createdAt
    updatedAt
    by
    isSystem
    userByBy {
      ...UserFragment
    }
    objectsByEditorgroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByEditorgroup {
      ...ObjectFragment
    }
    objectsByUsergroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByUsergroup {
      ...ObjectFragment
    }
    objectsByReadergroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByReadergroup {
      ...ObjectFragment
    }
    schemataByEditorgroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByEditorgroup {
      ...SchemaFragment
    }
    schemataByUsergroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByUsergroup {
      ...SchemaFragment
    }
    schemataByReadergroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByReadergroup {
      ...SchemaFragment
    }
    usersByDefaultEditorgroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultEditorgroup {
      ...UserFragment
    }
    usersByDefaultUsergroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultUsergroup {
      ...UserFragment
    }
    usersByDefaultReadergroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultReadergroup {
      ...UserFragment
    }
    usersToGroupsConnection {
      ...UsersToGroupsConnectionFragment
    }
    usersToGroups {
      ...UsersToGroupFragment
    }
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "userGroup": {
      "nodeId": ID,
      "id": UUID,
      "groupName": "abc123",
      "description": "xyz789",
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "isSystem": false,
      "userByBy": User,
      "objectsByEditorgroupConnection": ObjectsConnection,
      "objectsByEditorgroup": [Object],
      "objectsByUsergroupConnection": ObjectsConnection,
      "objectsByUsergroup": [Object],
      "objectsByReadergroupConnection": ObjectsConnection,
      "objectsByReadergroup": [Object],
      "schemataByEditorgroupConnection": SchemataConnection,
      "schemataByEditorgroup": [Schema],
      "schemataByUsergroupConnection": SchemataConnection,
      "schemataByUsergroup": [Schema],
      "schemataByReadergroupConnection": SchemataConnection,
      "schemataByReadergroup": [Schema],
      "usersByDefaultEditorgroupConnection": UsersConnection,
      "usersByDefaultEditorgroup": [User],
      "usersByDefaultUsergroupConnection": UsersConnection,
      "usersByDefaultUsergroup": [User],
      "usersByDefaultReadergroupConnection": UsersConnection,
      "usersByDefaultReadergroup": [User],
      "usersToGroupsConnection": UsersToGroupsConnection,
      "usersToGroups": [UsersToGroup]
    }
  }
}

Queries

`userGroupByGroupName`

Returns a UserGroup

Name	Description
`groupName` - `String!`

Example

Query

query userGroupByGroupName($groupName: String!) {
  userGroupByGroupName(groupName: $groupName) {
    nodeId
    id
    groupName
    description
    createdAt
    updatedAt
    by
    isSystem
    userByBy {
      ...UserFragment
    }
    objectsByEditorgroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByEditorgroup {
      ...ObjectFragment
    }
    objectsByUsergroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByUsergroup {
      ...ObjectFragment
    }
    objectsByReadergroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByReadergroup {
      ...ObjectFragment
    }
    schemataByEditorgroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByEditorgroup {
      ...SchemaFragment
    }
    schemataByUsergroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByUsergroup {
      ...SchemaFragment
    }
    schemataByReadergroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByReadergroup {
      ...SchemaFragment
    }
    usersByDefaultEditorgroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultEditorgroup {
      ...UserFragment
    }
    usersByDefaultUsergroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultUsergroup {
      ...UserFragment
    }
    usersByDefaultReadergroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultReadergroup {
      ...UserFragment
    }
    usersToGroupsConnection {
      ...UsersToGroupsConnectionFragment
    }
    usersToGroups {
      ...UsersToGroupFragment
    }
  }
}

Variables

{"groupName": "xyz789"}

Response

{
  "data": {
    "userGroupByGroupName": {
      "nodeId": ID,
      "id": UUID,
      "groupName": "xyz789",
      "description": "abc123",
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "isSystem": true,
      "userByBy": User,
      "objectsByEditorgroupConnection": ObjectsConnection,
      "objectsByEditorgroup": [Object],
      "objectsByUsergroupConnection": ObjectsConnection,
      "objectsByUsergroup": [Object],
      "objectsByReadergroupConnection": ObjectsConnection,
      "objectsByReadergroup": [Object],
      "schemataByEditorgroupConnection": SchemataConnection,
      "schemataByEditorgroup": [Schema],
      "schemataByUsergroupConnection": SchemataConnection,
      "schemataByUsergroup": [Schema],
      "schemataByReadergroupConnection": SchemataConnection,
      "schemataByReadergroup": [Schema],
      "usersByDefaultEditorgroupConnection": UsersConnection,
      "usersByDefaultEditorgroup": [User],
      "usersByDefaultUsergroupConnection": UsersConnection,
      "usersByDefaultUsergroup": [User],
      "usersByDefaultReadergroupConnection": UsersConnection,
      "usersByDefaultReadergroup": [User],
      "usersToGroupsConnection": UsersToGroupsConnection,
      "usersToGroups": [UsersToGroup]
    }
  }
}

Queries

`userGroupByNodeId`

Reads a single UserGroup using its globally unique ID

Returns a UserGroup

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `UserGroup`

Example

Query

query userGroupByNodeId($nodeId: ID!) {
  userGroupByNodeId(nodeId: $nodeId) {
    nodeId
    id
    groupName
    description
    createdAt
    updatedAt
    by
    isSystem
    userByBy {
      ...UserFragment
    }
    objectsByEditorgroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByEditorgroup {
      ...ObjectFragment
    }
    objectsByUsergroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByUsergroup {
      ...ObjectFragment
    }
    objectsByReadergroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByReadergroup {
      ...ObjectFragment
    }
    schemataByEditorgroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByEditorgroup {
      ...SchemaFragment
    }
    schemataByUsergroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByUsergroup {
      ...SchemaFragment
    }
    schemataByReadergroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByReadergroup {
      ...SchemaFragment
    }
    usersByDefaultEditorgroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultEditorgroup {
      ...UserFragment
    }
    usersByDefaultUsergroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultUsergroup {
      ...UserFragment
    }
    usersByDefaultReadergroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultReadergroup {
      ...UserFragment
    }
    usersToGroupsConnection {
      ...UsersToGroupsConnectionFragment
    }
    usersToGroups {
      ...UsersToGroupFragment
    }
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "userGroupByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "groupName": "abc123",
      "description": "abc123",
      "createdAt": Datetime,
      "updatedAt": Datetime,
      "by": UUID,
      "isSystem": true,
      "userByBy": User,
      "objectsByEditorgroupConnection": ObjectsConnection,
      "objectsByEditorgroup": [Object],
      "objectsByUsergroupConnection": ObjectsConnection,
      "objectsByUsergroup": [Object],
      "objectsByReadergroupConnection": ObjectsConnection,
      "objectsByReadergroup": [Object],
      "schemataByEditorgroupConnection": SchemataConnection,
      "schemataByEditorgroup": [Schema],
      "schemataByUsergroupConnection": SchemataConnection,
      "schemataByUsergroup": [Schema],
      "schemataByReadergroupConnection": SchemataConnection,
      "schemataByReadergroup": [Schema],
      "usersByDefaultEditorgroupConnection": UsersConnection,
      "usersByDefaultEditorgroup": [User],
      "usersByDefaultUsergroupConnection": UsersConnection,
      "usersByDefaultUsergroup": [User],
      "usersByDefaultReadergroupConnection": UsersConnection,
      "usersByDefaultReadergroup": [User],
      "usersToGroupsConnection": UsersToGroupsConnection,
      "usersToGroups": [UsersToGroup]
    }
  }
}

Queries

`userGroups`

Reads a set of UserGroup

Returns [UserGroup!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[UserGroupsSort!]`	The specification of how the `UserGroup` records should be sorted
`orderBy` - `[UserGroupsOrderBy!]`	The method to use when ordering `UserGroup`
`condition` - `UserGroupCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UserGroupFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query userGroups($first: Int, $offset: Int, $sort: [UserGroupsSort!], $orderBy: [UserGroupsOrderBy!], $condition: UserGroupCondition, $filter: UserGroupFilter) {
  userGroups(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    groupName
    description
    createdAt
    updatedAt
    by
    isSystem
    userByBy {
      ...UserFragment
    }
    objectsByEditorgroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByEditorgroup {
      ...ObjectFragment
    }
    objectsByUsergroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByUsergroup {
      ...ObjectFragment
    }
    objectsByReadergroupConnection {
      ...ObjectsConnectionFragment
    }
    objectsByReadergroup {
      ...ObjectFragment
    }
    schemataByEditorgroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByEditorgroup {
      ...SchemaFragment
    }
    schemataByUsergroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByUsergroup {
      ...SchemaFragment
    }
    schemataByReadergroupConnection {
      ...SchemataConnectionFragment
    }
    schemataByReadergroup {
      ...SchemaFragment
    }
    usersByDefaultEditorgroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultEditorgroup {
      ...UserFragment
    }
    usersByDefaultUsergroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultUsergroup {
      ...UserFragment
    }
    usersByDefaultReadergroupConnection {
      ...UsersConnectionFragment
    }
    usersByDefaultReadergroup {
      ...UserFragment
    }
    usersToGroupsConnection {
      ...UsersToGroupsConnectionFragment
    }
    usersToGroups {
      ...UsersToGroupFragment
    }
  }
}

Variables

{
  "first": 123,
  "offset": 123,
  "sort": [UserGroupsSort],
  "orderBy": [UserGroupsOrderBy],
  "condition": UserGroupCondition,
  "filter": UserGroupFilter
}

Response

{
  "data": {
    "userGroups": [
      {
        "nodeId": ID,
        "id": UUID,
        "groupName": "xyz789",
        "description": "xyz789",
        "createdAt": Datetime,
        "updatedAt": Datetime,
        "by": UUID,
        "isSystem": false,
        "userByBy": User,
        "objectsByEditorgroupConnection": ObjectsConnection,
        "objectsByEditorgroup": [Object],
        "objectsByUsergroupConnection": ObjectsConnection,
        "objectsByUsergroup": [Object],
        "objectsByReadergroupConnection": ObjectsConnection,
        "objectsByReadergroup": [Object],
        "schemataByEditorgroupConnection": SchemataConnection,
        "schemataByEditorgroup": [Schema],
        "schemataByUsergroupConnection": SchemataConnection,
        "schemataByUsergroup": [Schema],
        "schemataByReadergroupConnection": SchemataConnection,
        "schemataByReadergroup": [Schema],
        "usersByDefaultEditorgroupConnection": UsersConnection,
        "usersByDefaultEditorgroup": [User],
        "usersByDefaultUsergroupConnection": UsersConnection,
        "usersByDefaultUsergroup": [User],
        "usersByDefaultReadergroupConnection": UsersConnection,
        "usersByDefaultReadergroup": [User],
        "usersToGroupsConnection": UsersToGroupsConnection,
        "usersToGroups": [UsersToGroup]
      }
    ]
  }
}

Queries

`userGroupsConnection`

Reads and enables pagination through a set of UserGroup

Returns a UserGroupsConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[UserGroupsSort!]`	The specification of how the `UserGroup` records should be sorted
`orderBy` - `[UserGroupsOrderBy!]`	The method to use when ordering `UserGroup`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `UserGroupCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UserGroupFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query userGroupsConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [UserGroupsSort!], $orderBy: [UserGroupsOrderBy!], $condition: UserGroupCondition, $filter: UserGroupFilter) {
  userGroupsConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...UserGroupFragment
    }
    edges {
      ...UserGroupsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 987,
  "last": 123,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [UserGroupsSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": UserGroupCondition,
  "filter": UserGroupFilter
}

Response

{
  "data": {
    "userGroupsConnection": {
      "nodes": [UserGroup],
      "edges": [UserGroupsEdge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Queries

`userProfile`

Returns a UserProfile

Name	Description
`id` - `UUID!`

Example

Query

query userProfile($id: UUID!) {
  userProfile(id: $id) {
    nodeId
    id
    userId
    objectId
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "userProfile": {
      "nodeId": ID,
      "id": UUID,
      "userId": UUID,
      "objectId": UUID,
      "user": User,
      "object": Object
    }
  }
}

Queries

`userProfileByNodeId`

Reads a single UserProfile using its globally unique ID

Returns a UserProfile

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `UserProfile`

Example

Query

query userProfileByNodeId($nodeId: ID!) {
  userProfileByNodeId(nodeId: $nodeId) {
    nodeId
    id
    userId
    objectId
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "userProfileByNodeId": {
      "nodeId": ID,
      "id": UUID,
      "userId": UUID,
      "objectId": UUID,
      "user": User,
      "object": Object
    }
  }
}

Queries

`userProfileByUserIdAndObjectId`

Returns a UserProfile

Name	Description
`userId` - `UUID!`
`objectId` - `UUID!`

Example

Query

query userProfileByUserIdAndObjectId($userId: UUID!, $objectId: UUID!) {
  userProfileByUserIdAndObjectId(userId: $userId, objectId: $objectId) {
    nodeId
    id
    userId
    objectId
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
  }
}

Variables

{"userId": UUID, "objectId": UUID}

Response

{
  "data": {
    "userProfileByUserIdAndObjectId": {
      "nodeId": ID,
      "id": UUID,
      "userId": UUID,
      "objectId": UUID,
      "user": User,
      "object": Object
    }
  }
}

Queries

`userProfiles`

Reads a set of UserProfile

Returns [UserProfile!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[UserProfilesSort!]`	The specification of how the `UserProfile` records should be sorted
`orderBy` - `[UserProfilesOrderBy!]`	The method to use when ordering `UserProfile`
`condition` - `UserProfileCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UserProfileFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query userProfiles($first: Int, $offset: Int, $sort: [UserProfilesSort!], $orderBy: [UserProfilesOrderBy!], $condition: UserProfileCondition, $filter: UserProfileFilter) {
  userProfiles(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    userId
    objectId
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
  }
}

Variables

{
  "first": 987,
  "offset": 987,
  "sort": [UserProfilesSort],
  "orderBy": [UserProfilesOrderBy],
  "condition": UserProfileCondition,
  "filter": UserProfileFilter
}

Response

{
  "data": {
    "userProfiles": [
      {
        "nodeId": ID,
        "id": UUID,
        "userId": UUID,
        "objectId": UUID,
        "user": User,
        "object": Object
      }
    ]
  }
}

Queries

`userProfilesConnection`

Reads and enables pagination through a set of UserProfile

Returns a UserProfilesConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[UserProfilesSort!]`	The specification of how the `UserProfile` records should be sorted
`orderBy` - `[UserProfilesOrderBy!]`	The method to use when ordering `UserProfile`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `UserProfileCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UserProfileFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query userProfilesConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [UserProfilesSort!], $orderBy: [UserProfilesOrderBy!], $condition: UserProfileCondition, $filter: UserProfileFilter) {
  userProfilesConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...UserProfileFragment
    }
    edges {
      ...UserProfilesEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 987,
  "last": 123,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [UserProfilesSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": UserProfileCondition,
  "filter": UserProfileFilter
}

Response

{
  "data": {
    "userProfilesConnection": {
      "nodes": [UserProfile],
      "edges": [UserProfilesEdge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Queries

`users`

Reads a set of User

Returns [User!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[UsersSort!]`	The specification of how the `User` records should be sorted
`orderBy` - `[UsersOrderBy!]`	The method to use when ordering `User`
`condition` - `UserCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UserFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query users($first: Int, $offset: Int, $sort: [UsersSort!], $orderBy: [UsersOrderBy!], $condition: UserCondition, $filter: UserFilter) {
  users(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    id
    login
    password
    showhidden
    enabled
    description
    mName
    mExternalId
    mPhone
    mEmail
    mPicture
    mIcon
    createdAt
    updatedAt
    by
    type
    tokenExp
    activated
    passwordReset
    mTags
    defaultEditorgroup
    defaultUsergroup
    defaultReadergroup
    um
    passwordExpireAt
    logonStatus
    twoFaType
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    notificationsByByConnection {
      ...NotificationsConnectionFragment
    }
    notificationsByBy {
      ...NotificationFragment
    }
    schemaPropertiesByByConnection {
      ...SchemaPropertiesConnectionFragment
    }
    schemaPropertiesByBy {
      ...SchemaPropertyFragment
    }
    objectPropertiesByByConnection {
      ...ObjectPropertiesConnectionFragment
    }
    objectPropertiesByBy {
      ...ObjectPropertyFragment
    }
    objectsByByConnection {
      ...ObjectsConnectionFragment
    }
    objectsByBy {
      ...ObjectFragment
    }
    schemaControlsByByConnection {
      ...SchemaControlsConnectionFragment
    }
    schemaControlsByBy {
      ...SchemaControlFragment
    }
    schemataByApplicationOwnerConnection {
      ...SchemataConnectionFragment
    }
    schemataByApplicationOwner {
      ...SchemaFragment
    }
    schemataByByConnection {
      ...SchemataConnectionFragment
    }
    schemataByBy {
      ...SchemaFragment
    }
    objectPropertiesHistoriesByByConnection {
      ...ObjectPropertiesHistoriesConnectionFragment
    }
    objectPropertiesHistoriesByBy {
      ...ObjectPropertiesHistoryFragment
    }
    controlExecutionsByCallerIdConnection {
      ...ControlExecutionsConnectionFragment
    }
    controlExecutionsByCallerId {
      ...ControlExecutionFragment
    }
    notificationDeliveriesByUserConnection {
      ...NotificationDeliveriesConnectionFragment
    }
    notificationDeliveriesByUser {
      ...NotificationDeliveryFragment
    }
    userGroupsByByConnection {
      ...UserGroupsConnectionFragment
    }
    userGroupsByBy {
      ...UserGroupFragment
    }
    userProfilesConnection {
      ...UserProfilesConnectionFragment
    }
    userProfiles {
      ...UserProfileFragment
    }
    usersToGroupsConnection {
      ...UsersToGroupsConnectionFragment
    }
    usersToGroups {
      ...UsersToGroupFragment
    }
    usersToObjectsConnection {
      ...UsersToObjectsConnectionFragment
    }
    usersToObjects {
      ...UsersToObjectFragment
    }
  }
}

Variables

{
  "first": 123,
  "offset": 123,
  "sort": [UsersSort],
  "orderBy": [UsersOrderBy],
  "condition": UserCondition,
  "filter": UserFilter
}

Response

{
  "data": {
    "users": [
      {
        "nodeId": ID,
        "id": UUID,
        "login": "abc123",
        "password": "abc123",
        "showhidden": true,
        "enabled": false,
        "description": "abc123",
        "mName": "xyz789",
        "mExternalId": {},
        "mPhone": "xyz789",
        "mEmail": "xyz789",
        "mPicture": UUID,
        "mIcon": UUID,
        "createdAt": Datetime,
        "updatedAt": Datetime,
        "by": UUID,
        "type": UserTypes,
        "tokenExp": BigInt,
        "activated": false,
        "passwordReset": false,
        "mTags": ["xyz789"],
        "defaultEditorgroup": UUID,
        "defaultUsergroup": UUID,
        "defaultReadergroup": UUID,
        "um": true,
        "passwordExpireAt": Datetime,
        "logonStatus": "abc123",
        "twoFaType": TwoFaTypes,
        "userGroupByDefaultEditorgroup": UserGroup,
        "userGroupByDefaultUsergroup": UserGroup,
        "userGroupByDefaultReadergroup": UserGroup,
        "notificationsByByConnection": NotificationsConnection,
        "notificationsByBy": [Notification],
        "schemaPropertiesByByConnection": SchemaPropertiesConnection,
        "schemaPropertiesByBy": [SchemaProperty],
        "objectPropertiesByByConnection": ObjectPropertiesConnection,
        "objectPropertiesByBy": [ObjectProperty],
        "objectsByByConnection": ObjectsConnection,
        "objectsByBy": [Object],
        "schemaControlsByByConnection": SchemaControlsConnection,
        "schemaControlsByBy": [SchemaControl],
        "schemataByApplicationOwnerConnection": SchemataConnection,
        "schemataByApplicationOwner": [Schema],
        "schemataByByConnection": SchemataConnection,
        "schemataByBy": [Schema],
        "objectPropertiesHistoriesByByConnection": ObjectPropertiesHistoriesConnection,
        "objectPropertiesHistoriesByBy": [
          ObjectPropertiesHistory
        ],
        "controlExecutionsByCallerIdConnection": ControlExecutionsConnection,
        "controlExecutionsByCallerId": [ControlExecution],
        "notificationDeliveriesByUserConnection": NotificationDeliveriesConnection,
        "notificationDeliveriesByUser": [
          NotificationDelivery
        ],
        "userGroupsByByConnection": UserGroupsConnection,
        "userGroupsByBy": [UserGroup],
        "userProfilesConnection": UserProfilesConnection,
        "userProfiles": [UserProfile],
        "usersToGroupsConnection": UsersToGroupsConnection,
        "usersToGroups": [UsersToGroup],
        "usersToObjectsConnection": UsersToObjectsConnection,
        "usersToObjects": [UsersToObject]
      }
    ]
  }
}

Queries

`usersConnection`

Reads and enables pagination through a set of User

Returns a UsersConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[UsersSort!]`	The specification of how the `User` records should be sorted
`orderBy` - `[UsersOrderBy!]`	The method to use when ordering `User`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `UserCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UserFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query usersConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [UsersSort!], $orderBy: [UsersOrderBy!], $condition: UserCondition, $filter: UserFilter) {
  usersConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...UserFragment
    }
    edges {
      ...UsersEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 987,
  "last": 987,
  "offset": 987,
  "before": Cursor,
  "after": Cursor,
  "sort": [UsersSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": UserCondition,
  "filter": UserFilter
}

Response

{
  "data": {
    "usersConnection": {
      "nodes": [User],
      "edges": [UsersEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`usersToGroup`

Returns a UsersToGroup

Name	Description
`id` - `UUID!`

Example

Query

query usersToGroup($id: UUID!) {
  usersToGroup(id: $id) {
    nodeId
    userId
    userGroupId
    id
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "usersToGroup": {
      "nodeId": ID,
      "userId": UUID,
      "userGroupId": UUID,
      "id": UUID,
      "user": User,
      "userGroup": UserGroup
    }
  }
}

Queries

`usersToGroupByNodeId`

Reads a single UsersToGroup using its globally unique ID

Returns a UsersToGroup

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `UsersToGroup`

Example

Query

query usersToGroupByNodeId($nodeId: ID!) {
  usersToGroupByNodeId(nodeId: $nodeId) {
    nodeId
    userId
    userGroupId
    id
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "usersToGroupByNodeId": {
      "nodeId": ID,
      "userId": UUID,
      "userGroupId": UUID,
      "id": UUID,
      "user": User,
      "userGroup": UserGroup
    }
  }
}

Queries

`usersToGroupByUserIdAndUserGroupId`

Returns a UsersToGroup

Name	Description
`userId` - `UUID!`
`userGroupId` - `UUID!`

Example

Query

query usersToGroupByUserIdAndUserGroupId($userId: UUID!, $userGroupId: UUID!) {
  usersToGroupByUserIdAndUserGroupId(userId: $userId, userGroupId: $userGroupId) {
    nodeId
    userId
    userGroupId
    id
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
  }
}

Variables

{
  "userId": UUID,
  "userGroupId": UUID
}

Response

{
  "data": {
    "usersToGroupByUserIdAndUserGroupId": {
      "nodeId": ID,
      "userId": UUID,
      "userGroupId": UUID,
      "id": UUID,
      "user": User,
      "userGroup": UserGroup
    }
  }
}

Queries

`usersToGroups`

Reads a set of UsersToGroup

Returns [UsersToGroup!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[UsersToGroupsSort!]`	The specification of how the `UsersToGroup` records should be sorted
`orderBy` - `[UsersToGroupsOrderBy!]`	The method to use when ordering `UsersToGroup`
`condition` - `UsersToGroupCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UsersToGroupFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query usersToGroups($first: Int, $offset: Int, $sort: [UsersToGroupsSort!], $orderBy: [UsersToGroupsOrderBy!], $condition: UsersToGroupCondition, $filter: UsersToGroupFilter) {
  usersToGroups(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    userId
    userGroupId
    id
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
  }
}

Variables

{
  "first": 987,
  "offset": 123,
  "sort": [UsersToGroupsSort],
  "orderBy": [UsersToGroupsOrderBy],
  "condition": UsersToGroupCondition,
  "filter": UsersToGroupFilter
}

Response

{
  "data": {
    "usersToGroups": [
      {
        "nodeId": ID,
        "userId": UUID,
        "userGroupId": UUID,
        "id": UUID,
        "user": User,
        "userGroup": UserGroup
      }
    ]
  }
}

Queries

`usersToGroupsConnection`

Reads and enables pagination through a set of UsersToGroup

Returns a UsersToGroupsConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[UsersToGroupsSort!]`	The specification of how the `UsersToGroup` records should be sorted
`orderBy` - `[UsersToGroupsOrderBy!]`	The method to use when ordering `UsersToGroup`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `UsersToGroupCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UsersToGroupFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query usersToGroupsConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [UsersToGroupsSort!], $orderBy: [UsersToGroupsOrderBy!], $condition: UsersToGroupCondition, $filter: UsersToGroupFilter) {
  usersToGroupsConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...UsersToGroupFragment
    }
    edges {
      ...UsersToGroupsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 123,
  "last": 987,
  "offset": 987,
  "before": Cursor,
  "after": Cursor,
  "sort": [UsersToGroupsSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": UsersToGroupCondition,
  "filter": UsersToGroupFilter
}

Response

{
  "data": {
    "usersToGroupsConnection": {
      "nodes": [UsersToGroup],
      "edges": [UsersToGroupsEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`usersToObject`

Returns a UsersToObject

Name	Description
`id` - `UUID!`

Example

Query

query usersToObject($id: UUID!) {
  usersToObject(id: $id) {
    nodeId
    userId
    objectId
    id
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
  }
}

Variables

{"id": UUID}

Response

{
  "data": {
    "usersToObject": {
      "nodeId": ID,
      "userId": UUID,
      "objectId": UUID,
      "id": UUID,
      "user": User,
      "object": Object
    }
  }
}

Queries

`usersToObjectByNodeId`

Reads a single UsersToObject using its globally unique ID

Returns a UsersToObject

Name	Description
`nodeId` - `ID!`	The globally unique `ID` to be used in selecting a single `UsersToObject`

Example

Query

query usersToObjectByNodeId($nodeId: ID!) {
  usersToObjectByNodeId(nodeId: $nodeId) {
    nodeId
    userId
    objectId
    id
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
  }
}

Variables

{"nodeId": ID}

Response

{
  "data": {
    "usersToObjectByNodeId": {
      "nodeId": ID,
      "userId": UUID,
      "objectId": UUID,
      "id": UUID,
      "user": User,
      "object": Object
    }
  }
}

Queries

`usersToObjectByUserIdAndObjectId`

Returns a UsersToObject

Name	Description
`userId` - `UUID!`
`objectId` - `UUID!`

Example

Query

query usersToObjectByUserIdAndObjectId($userId: UUID!, $objectId: UUID!) {
  usersToObjectByUserIdAndObjectId(userId: $userId, objectId: $objectId) {
    nodeId
    userId
    objectId
    id
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
  }
}

Variables

{"userId": UUID, "objectId": UUID}

Response

{
  "data": {
    "usersToObjectByUserIdAndObjectId": {
      "nodeId": ID,
      "userId": UUID,
      "objectId": UUID,
      "id": UUID,
      "user": User,
      "object": Object
    }
  }
}

Queries

`usersToObjects`

Reads a set of UsersToObject

Returns [UsersToObject!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[UsersToObjectsSort!]`	The specification of how the `UsersToObject` records should be sorted
`orderBy` - `[UsersToObjectsOrderBy!]`	The method to use when ordering `UsersToObject`
`condition` - `UsersToObjectCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UsersToObjectFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query usersToObjects($first: Int, $offset: Int, $sort: [UsersToObjectsSort!], $orderBy: [UsersToObjectsOrderBy!], $condition: UsersToObjectCondition, $filter: UsersToObjectFilter) {
  usersToObjects(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodeId
    userId
    objectId
    id
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
  }
}

Variables

{
  "first": 987,
  "offset": 987,
  "sort": [UsersToObjectsSort],
  "orderBy": [UsersToObjectsOrderBy],
  "condition": UsersToObjectCondition,
  "filter": UsersToObjectFilter
}

Response

{
  "data": {
    "usersToObjects": [
      {
        "nodeId": ID,
        "userId": UUID,
        "objectId": UUID,
        "id": UUID,
        "user": User,
        "object": Object
      }
    ]
  }
}

Queries

`usersToObjectsConnection`

Reads and enables pagination through a set of UsersToObject

Returns a UsersToObjectsConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[UsersToObjectsSort!]`	The specification of how the `UsersToObject` records should be sorted
`orderBy` - `[UsersToObjectsOrderBy!]`	The method to use when ordering `UsersToObject`. Default = `["PRIMARY_KEY_ASC"]`
`condition` - `UsersToObjectCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `UsersToObjectFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query usersToObjectsConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [UsersToObjectsSort!], $orderBy: [UsersToObjectsOrderBy!], $condition: UsersToObjectCondition, $filter: UsersToObjectFilter) {
  usersToObjectsConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...UsersToObjectFragment
    }
    edges {
      ...UsersToObjectsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 987,
  "last": 987,
  "offset": 123,
  "before": Cursor,
  "after": Cursor,
  "sort": [UsersToObjectsSort],
  "orderBy": [PRIMARY_KEY_ASC],
  "condition": UsersToObjectCondition,
  "filter": UsersToObjectFilter
}

Response

{
  "data": {
    "usersToObjectsConnection": {
      "nodes": [UsersToObject],
      "edges": [UsersToObjectsEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Queries

`validatePasswordChange`

Check whether user can change his password or no by user_id and new password given. Result is in JSON format

Returns a String

Name	Description
`userId` - `UUID`
`newPassword` - `String`

Example

Query

query validatePasswordChange($userId: UUID, $newPassword: String) {
  validatePasswordChange(userId: $userId, newPassword: $newPassword)
}

Variables

{"userId": UUID, "newPassword": "abc123"}

Response

{"data": {"validatePasswordChange": "xyz789"}}

Queries

`viewSearches`

Reads a set of ViewSearch

Returns [ViewSearch!]

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`offset` - `Int`	Skip the first `n` values
`sort` - `[ViewSearchSort!]`	The specification of how the `ViewSearch` records should be sorted
`orderBy` - `[ViewSearchesOrderBy!]`	The method to use when ordering `ViewSearch`
`condition` - `ViewSearchCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ViewSearchFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query viewSearches($first: Int, $offset: Int, $sort: [ViewSearchSort!], $orderBy: [ViewSearchesOrderBy!], $condition: ViewSearchCondition, $filter: ViewSearchFilter) {
  viewSearches(first: $first, offset: $offset, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    id
    name
    type
    stringId
  }
}

Variables

{
  "first": 123,
  "offset": 987,
  "sort": [ViewSearchSort],
  "orderBy": [ViewSearchesOrderBy],
  "condition": ViewSearchCondition,
  "filter": ViewSearchFilter
}

Response

{
  "data": {
    "viewSearches": [
      {
        "id": UUID,
        "name": "xyz789",
        "type": "xyz789",
        "stringId": "abc123"
      }
    ]
  }
}

Queries

`viewSearchesConnection`

Reads and enables pagination through a set of ViewSearch

Returns a ViewSearchesConnection

Name	Description
`first` - `Int`	Only read the first `n` values of the set
`last` - `Int`	Only read the last `n` values of the set
`offset` - `Int`	Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`
`before` - `Cursor`	Read all values in the set before (above) this cursor
`after` - `Cursor`	Read all values in the set after (below) this cursor
`sort` - `[ViewSearchSort!]`	The specification of how the `ViewSearch` records should be sorted
`orderBy` - `[ViewSearchesOrderBy!]`	The method to use when ordering `ViewSearch`. Default = `["NATURAL"]`
`condition` - `ViewSearchCondition`	A condition to be used in determining which values should be returned by the collection
`filter` - `ViewSearchFilter`	A filter to be used in determining which values should be returned by the collection

Example

Query

query viewSearchesConnection($first: Int, $last: Int, $offset: Int, $before: Cursor, $after: Cursor, $sort: [ViewSearchSort!], $orderBy: [ViewSearchesOrderBy!], $condition: ViewSearchCondition, $filter: ViewSearchFilter) {
  viewSearchesConnection(first: $first, last: $last, offset: $offset, before: $before, after: $after, sort: $sort, orderBy: $orderBy, condition: $condition, filter: $filter) {
    nodes {
      ...ViewSearchFragment
    }
    edges {
      ...ViewSearchesEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "first": 123,
  "last": 123,
  "offset": 987,
  "before": Cursor,
  "after": Cursor,
  "sort": [ViewSearchSort],
  "orderBy": [NATURAL],
  "condition": ViewSearchCondition,
  "filter": ViewSearchFilter
}

Response

{
  "data": {
    "viewSearchesConnection": {
      "nodes": [ViewSearch],
      "edges": [ViewSearchesEdge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Mutations

`authAccessToken`

Generates Access Token String from Refresh Token.

Returns an AuthAccessTokenPayload

Name	Description
`input` - `AuthAccessTokenInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation authAccessToken($input: AuthAccessTokenInput!) {
  authAccessToken(input: $input) {
    clientMutationId
    jwtToken
  }
}

Variables

{"input": AuthAccessTokenInput}

Response

{
  "data": {
    "authAccessToken": {
      "clientMutationId": "abc123",
      "jwtToken": JwtToken
    }
  }
}

Mutations

`authRefreshToken`

Returns a Refresh Token String if authorization is successful. Refresh Token can be used to get Access Token.

Returns an AuthRefreshTokenPayload

Name	Description
`input` - `AuthRefreshTokenInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation authRefreshToken($input: AuthRefreshTokenInput!) {
  authRefreshToken(input: $input) {
    clientMutationId
    refreshToken {
      ...RefreshTokenFragment
    }
  }
}

Variables

{"input": AuthRefreshTokenInput}

Response

{
  "data": {
    "authRefreshToken": {
      "clientMutationId": "abc123",
      "refreshToken": RefreshToken
    }
  }
}

Mutations

`bumpSchemaVersion`

Returns a BumpSchemaVersionPayload

Name	Description
`input` - `BumpSchemaVersionInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation bumpSchemaVersion($input: BumpSchemaVersionInput!) {
  bumpSchemaVersion(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": BumpSchemaVersionInput}

Response

{
  "data": {
    "bumpSchemaVersion": {"clientMutationId": "abc123", "boolean": false}
  }
}

Mutations

`createControlExecution`

Creates a single ControlExecution

Returns a CreateControlExecutionPayload

Name	Description
`input` - `CreateControlExecutionInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createControlExecution($input: CreateControlExecutionInput!) {
  createControlExecution(input: $input) {
    clientMutationId
    controlExecution {
      ...ControlExecutionFragment
    }
    object {
      ...ObjectFragment
    }
    caller {
      ...UserFragment
    }
    controlExecutionEdge {
      ...ControlExecutionsEdgeFragment
    }
  }
}

Variables

{"input": CreateControlExecutionInput}

Response

{
  "data": {
    "createControlExecution": {
      "clientMutationId": "abc123",
      "controlExecution": ControlExecution,
      "object": Object,
      "caller": User,
      "controlExecutionEdge": ControlExecutionsEdge
    }
  }
}

Mutations

`createControlExecutionReport`

Returns a CreateControlExecutionReportPayload

Name	Description
`input` - `CreateControlExecutionReportInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createControlExecutionReport($input: CreateControlExecutionReportInput!) {
  createControlExecutionReport(input: $input) {
    clientMutationId
    integer
  }
}

Variables

{"input": CreateControlExecutionReportInput}

Response

{
  "data": {
    "createControlExecutionReport": {
      "clientMutationId": "abc123",
      "integer": 987
    }
  }
}

Mutations

`createControlExecutionStealth`

Initiate execution of Stealth RPC/Control.

Returns a CreateControlExecutionStealthPayload

Name	Description
`input` - `CreateControlExecutionStealthInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createControlExecutionStealth($input: CreateControlExecutionStealthInput!) {
  createControlExecutionStealth(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": CreateControlExecutionStealthInput}

Response

{
  "data": {
    "createControlExecutionStealth": {
      "clientMutationId": "xyz789",
      "boolean": false
    }
  }
}

Mutations

`createControlExecutionStealthByPropertyValue`

Returns a CreateControlExecutionStealthByPropertyValuePayload

Name	Description
`input` - `CreateControlExecutionStealthByPropertyValueInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createControlExecutionStealthByPropertyValue($input: CreateControlExecutionStealthByPropertyValueInput!) {
  createControlExecutionStealthByPropertyValue(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{
  "input": CreateControlExecutionStealthByPropertyValueInput
}

Response

{
  "data": {
    "createControlExecutionStealthByPropertyValue": {
      "clientMutationId": "abc123",
      "boolean": true
    }
  }
}

Mutations

`createControlExecutionSync`

Returns a CreateControlExecutionSyncPayload

Name	Description
`input` - `CreateControlExecutionSyncInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createControlExecutionSync($input: CreateControlExecutionSyncInput!) {
  createControlExecutionSync(input: $input) {
    clientMutationId
    rpcResult {
      ...RpcResultFragment
    }
  }
}

Variables

{"input": CreateControlExecutionSyncInput}

Response

{
  "data": {
    "createControlExecutionSync": {
      "clientMutationId": "xyz789",
      "rpcResult": RpcResult
    }
  }
}

Mutations

`createNotification`

Creates a single Notification

Returns a CreateNotificationPayload

Name	Description
`input` - `CreateNotificationInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createNotification($input: CreateNotificationInput!) {
  createNotification(input: $input) {
    clientMutationId
    notification {
      ...NotificationFragment
    }
    object {
      ...ObjectFragment
    }
    userByBy {
      ...UserFragment
    }
    notificationEdge {
      ...NotificationsEdgeFragment
    }
  }
}

Variables

{"input": CreateNotificationInput}

Response

{
  "data": {
    "createNotification": {
      "clientMutationId": "abc123",
      "notification": Notification,
      "object": Object,
      "userByBy": User,
      "notificationEdge": NotificationsEdge
    }
  }
}

Mutations

`createNotificationDelivery`

Creates a single NotificationDelivery

Returns a CreateNotificationDeliveryPayload

Name	Description
`input` - `CreateNotificationDeliveryInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createNotificationDelivery($input: CreateNotificationDeliveryInput!) {
  createNotificationDelivery(input: $input) {
    clientMutationId
    notificationDelivery {
      ...NotificationDeliveryFragment
    }
    userByUser {
      ...UserFragment
    }
    deliveryConfig {
      ...ObjectFragment
    }
    notification {
      ...NotificationFragment
    }
    notificationDeliveryEdge {
      ...NotificationDeliveriesEdgeFragment
    }
  }
}

Variables

{"input": CreateNotificationDeliveryInput}

Response

{
  "data": {
    "createNotificationDelivery": {
      "clientMutationId": "xyz789",
      "notificationDelivery": NotificationDelivery,
      "userByUser": User,
      "deliveryConfig": Object,
      "notification": Notification,
      "notificationDeliveryEdge": NotificationDeliveriesEdge
    }
  }
}

Mutations

`createObject`

Creates a single Object

Returns a CreateObjectPayload

Name	Description
`input` - `CreateObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createObject($input: CreateObjectInput!) {
  createObject(input: $input) {
    clientMutationId
    object {
      ...ObjectFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    objectEdge {
      ...ObjectsEdgeFragment
    }
  }
}

Variables

{"input": CreateObjectInput}

Response

{
  "data": {
    "createObject": {
      "clientMutationId": "xyz789",
      "object": Object,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "objectEdge": ObjectsEdge
    }
  }
}

Mutations

`createObjectCopy`

Creates copy of an object with all it's properties and fragments values. Optionally it copies also all linked objects and keep linked properties

Returns a CreateObjectCopyPayload

Name	Description
`input` - `CreateObjectCopyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createObjectCopy($input: CreateObjectCopyInput!) {
  createObjectCopy(input: $input) {
    clientMutationId
    uuid
  }
}

Variables

{"input": CreateObjectCopyInput}

Response

{
  "data": {
    "createObjectCopy": {
      "clientMutationId": "xyz789",
      "uuid": UUID
    }
  }
}

Mutations

`createObjectPropertiesHistory`

Creates a single ObjectPropertiesHistory

Returns a CreateObjectPropertiesHistoryPayload

Name	Description
`input` - `CreateObjectPropertiesHistoryInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createObjectPropertiesHistory($input: CreateObjectPropertiesHistoryInput!) {
  createObjectPropertiesHistory(input: $input) {
    clientMutationId
    objectPropertiesHistory {
      ...ObjectPropertiesHistoryFragment
    }
    userByBy {
      ...UserFragment
    }
    objectPropertiesHistoryEdge {
      ...ObjectPropertiesHistoriesEdgeFragment
    }
  }
}

Variables

{"input": CreateObjectPropertiesHistoryInput}

Response

{
  "data": {
    "createObjectPropertiesHistory": {
      "clientMutationId": "xyz789",
      "objectPropertiesHistory": ObjectPropertiesHistory,
      "userByBy": User,
      "objectPropertiesHistoryEdge": ObjectPropertiesHistoriesEdge
    }
  }
}

Mutations

`createObjectsToObject`

Creates a single ObjectsToObject

Returns a CreateObjectsToObjectPayload

Name	Description
`input` - `CreateObjectsToObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createObjectsToObject($input: CreateObjectsToObjectInput!) {
  createObjectsToObject(input: $input) {
    clientMutationId
    objectsToObject {
      ...ObjectsToObjectFragment
    }
    object1 {
      ...ObjectFragment
    }
    object2 {
      ...ObjectFragment
    }
    objectsToObjectEdge {
      ...ObjectsToObjectsEdgeFragment
    }
  }
}

Variables

{"input": CreateObjectsToObjectInput}

Response

{
  "data": {
    "createObjectsToObject": {
      "clientMutationId": "xyz789",
      "objectsToObject": ObjectsToObject,
      "object1": Object,
      "object2": Object,
      "objectsToObjectEdge": ObjectsToObjectsEdge
    }
  }
}

Mutations

`createObjectsToObjects`

Creates ObjectToObject relation for each pair of source and destination uuid arrays members. If relationship already exists, it's skipped. Returns number of rows actually inserted

Returns a CreateObjectsToObjectsPayload

Name	Description
`input` - `CreateObjectsToObjectsInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createObjectsToObjects($input: CreateObjectsToObjectsInput!) {
  createObjectsToObjects(input: $input) {
    clientMutationId
    integer
  }
}

Variables

{"input": CreateObjectsToObjectsInput}

Response

{
  "data": {
    "createObjectsToObjects": {"clientMutationId": "abc123", "integer": 987}
  }
}

Mutations

`createObjectWithProperties`

Returns a CreateObjectWithPropertiesPayload

Name	Description
`input` - `CreateObjectWithPropertiesInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createObjectWithProperties($input: CreateObjectWithPropertiesInput!) {
  createObjectWithProperties(input: $input) {
    clientMutationId
    uuid
  }
}

Variables

{"input": CreateObjectWithPropertiesInput}

Response

{
  "data": {
    "createObjectWithProperties": {
      "clientMutationId": "xyz789",
      "uuid": UUID
    }
  }
}

Mutations

`createPropertyType`

Creates a single PropertyType

Returns a CreatePropertyTypePayload

Name	Description
`input` - `CreatePropertyTypeInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createPropertyType($input: CreatePropertyTypeInput!) {
  createPropertyType(input: $input) {
    clientMutationId
    propertyType {
      ...PropertyTypeFragment
    }
    propertyTypeEdge {
      ...PropertyTypesEdgeFragment
    }
  }
}

Variables

{"input": CreatePropertyTypeInput}

Response

{
  "data": {
    "createPropertyType": {
      "clientMutationId": "xyz789",
      "propertyType": PropertyType,
      "propertyTypeEdge": PropertyTypesEdge
    }
  }
}

Mutations

`createSchema`

Creates a single Schema

Returns a CreateSchemaPayload

Name	Description
`input` - `CreateSchemaInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createSchema($input: CreateSchemaInput!) {
  createSchema(input: $input) {
    clientMutationId
    schema {
      ...SchemaFragment
    }
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaEdge {
      ...SchemataEdgeFragment
    }
  }
}

Variables

{"input": CreateSchemaInput}

Response

{
  "data": {
    "createSchema": {
      "clientMutationId": "xyz789",
      "schema": Schema,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaEdge": SchemataEdge
    }
  }
}

Mutations

`createSchemaControl`

Creates a single SchemaControl

Returns a CreateSchemaControlPayload

Name	Description
`input` - `CreateSchemaControlInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createSchemaControl($input: CreateSchemaControlInput!) {
  createSchemaControl(input: $input) {
    clientMutationId
    schemaControl {
      ...SchemaControlFragment
    }
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    schemaControlEdge {
      ...SchemaControlsEdgeFragment
    }
  }
}

Variables

{"input": CreateSchemaControlInput}

Response

{
  "data": {
    "createSchemaControl": {
      "clientMutationId": "xyz789",
      "schemaControl": SchemaControl,
      "schema": Schema,
      "userByBy": User,
      "schemaControlEdge": SchemaControlsEdge
    }
  }
}

Mutations

`createSchemaCopy`

Creates a Schema copy.

Returns a CreateSchemaCopyPayload

Name	Description
`input` - `CreateSchemaCopyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createSchemaCopy($input: CreateSchemaCopyInput!) {
  createSchemaCopy(input: $input) {
    clientMutationId
    uuid
  }
}

Variables

{"input": CreateSchemaCopyInput}

Response

{
  "data": {
    "createSchemaCopy": {
      "clientMutationId": "abc123",
      "uuid": UUID
    }
  }
}

Mutations

`createSchemaProperty`

Creates a single SchemaProperty

Returns a CreateSchemaPropertyPayload

Name	Description
`input` - `CreateSchemaPropertyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createSchemaProperty($input: CreateSchemaPropertyInput!) {
  createSchemaProperty(input: $input) {
    clientMutationId
    schemaProperty {
      ...SchemaPropertyFragment
    }
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    type {
      ...PropertyTypeFragment
    }
    schemaPropertyEdge {
      ...SchemaPropertiesEdgeFragment
    }
  }
}

Variables

{"input": CreateSchemaPropertyInput}

Response

{
  "data": {
    "createSchemaProperty": {
      "clientMutationId": "abc123",
      "schemaProperty": SchemaProperty,
      "schema": Schema,
      "userByBy": User,
      "type": PropertyType,
      "schemaPropertyEdge": SchemaPropertiesEdge
    }
  }
}

Mutations

`createTranslation`

Creates a single Translation

Returns a CreateTranslationPayload

Name	Description
`input` - `CreateTranslationInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createTranslation($input: CreateTranslationInput!) {
  createTranslation(input: $input) {
    clientMutationId
    translation {
      ...TranslationFragment
    }
    translationEdge {
      ...TranslationsEdgeFragment
    }
  }
}

Variables

{"input": CreateTranslationInput}

Response

{
  "data": {
    "createTranslation": {
      "clientMutationId": "abc123",
      "translation": Translation,
      "translationEdge": TranslationsEdge
    }
  }
}

Mutations

`createUser`

Creates a single User

Returns a CreateUserPayload

Name	Description
`input` - `CreateUserInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createUser($input: CreateUserInput!) {
  createUser(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": CreateUserInput}

Response

{
  "data": {
    "createUser": {
      "clientMutationId": "abc123",
      "user": User,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`createUserGroup`

Creates a single UserGroup

Returns a CreateUserGroupPayload

Name	Description
`input` - `CreateUserGroupInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createUserGroup($input: CreateUserGroupInput!) {
  createUserGroup(input: $input) {
    clientMutationId
    userGroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    userGroupEdge {
      ...UserGroupsEdgeFragment
    }
  }
}

Variables

{"input": CreateUserGroupInput}

Response

{
  "data": {
    "createUserGroup": {
      "clientMutationId": "abc123",
      "userGroup": UserGroup,
      "userByBy": User,
      "userGroupEdge": UserGroupsEdge
    }
  }
}

Mutations

`createUsersToGroup`

Creates a single UsersToGroup

Returns a CreateUsersToGroupPayload

Name	Description
`input` - `CreateUsersToGroupInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createUsersToGroup($input: CreateUsersToGroupInput!) {
  createUsersToGroup(input: $input) {
    clientMutationId
    usersToGroup {
      ...UsersToGroupFragment
    }
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
    usersToGroupEdge {
      ...UsersToGroupsEdgeFragment
    }
  }
}

Variables

{"input": CreateUsersToGroupInput}

Response

{
  "data": {
    "createUsersToGroup": {
      "clientMutationId": "xyz789",
      "usersToGroup": UsersToGroup,
      "user": User,
      "userGroup": UserGroup,
      "usersToGroupEdge": UsersToGroupsEdge
    }
  }
}

Mutations

`createUsersToObject`

Creates a single UsersToObject

Returns a CreateUsersToObjectPayload

Name	Description
`input` - `CreateUsersToObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation createUsersToObject($input: CreateUsersToObjectInput!) {
  createUsersToObject(input: $input) {
    clientMutationId
    usersToObject {
      ...UsersToObjectFragment
    }
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
    usersToObjectEdge {
      ...UsersToObjectsEdgeFragment
    }
  }
}

Variables

{"input": CreateUsersToObjectInput}

Response

{
  "data": {
    "createUsersToObject": {
      "clientMutationId": "xyz789",
      "usersToObject": UsersToObject,
      "user": User,
      "object": Object,
      "usersToObjectEdge": UsersToObjectsEdge
    }
  }
}

Mutations

`deleteObject`

Deletes a single Object using a unique key

Returns a DeleteObjectPayload

Name	Description
`input` - `DeleteObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteObject($input: DeleteObjectInput!) {
  deleteObject(input: $input) {
    clientMutationId
    object {
      ...ObjectFragment
    }
    deletedObjectNodeId
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    objectEdge {
      ...ObjectsEdgeFragment
    }
  }
}

Variables

{"input": DeleteObjectInput}

Response

{
  "data": {
    "deleteObject": {
      "clientMutationId": "abc123",
      "object": Object,
      "deletedObjectNodeId": ID,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "objectEdge": ObjectsEdge
    }
  }
}

Mutations

`deleteObjectByNodeId`

Deletes a single Object using its globally unique id

Returns a DeleteObjectPayload

Name	Description
`input` - `DeleteObjectByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteObjectByNodeId($input: DeleteObjectByNodeIdInput!) {
  deleteObjectByNodeId(input: $input) {
    clientMutationId
    object {
      ...ObjectFragment
    }
    deletedObjectNodeId
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    objectEdge {
      ...ObjectsEdgeFragment
    }
  }
}

Variables

{"input": DeleteObjectByNodeIdInput}

Response

{
  "data": {
    "deleteObjectByNodeId": {
      "clientMutationId": "xyz789",
      "object": Object,
      "deletedObjectNodeId": ID,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "objectEdge": ObjectsEdge
    }
  }
}

Mutations

`deleteObjectPropertiesHistory`

Deletes a single ObjectPropertiesHistory using a unique key

Returns a DeleteObjectPropertiesHistoryPayload

Name	Description
`input` - `DeleteObjectPropertiesHistoryInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteObjectPropertiesHistory($input: DeleteObjectPropertiesHistoryInput!) {
  deleteObjectPropertiesHistory(input: $input) {
    clientMutationId
    objectPropertiesHistory {
      ...ObjectPropertiesHistoryFragment
    }
    deletedObjectPropertiesHistoryNodeId
    userByBy {
      ...UserFragment
    }
    objectPropertiesHistoryEdge {
      ...ObjectPropertiesHistoriesEdgeFragment
    }
  }
}

Variables

{"input": DeleteObjectPropertiesHistoryInput}

Response

{
  "data": {
    "deleteObjectPropertiesHistory": {
      "clientMutationId": "xyz789",
      "objectPropertiesHistory": ObjectPropertiesHistory,
      "deletedObjectPropertiesHistoryNodeId": ID,
      "userByBy": User,
      "objectPropertiesHistoryEdge": ObjectPropertiesHistoriesEdge
    }
  }
}

Mutations

`deleteObjectPropertiesHistoryByNodeId`

Deletes a single ObjectPropertiesHistory using its globally unique id

Returns a DeleteObjectPropertiesHistoryPayload

Name	Description
`input` - `DeleteObjectPropertiesHistoryByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteObjectPropertiesHistoryByNodeId($input: DeleteObjectPropertiesHistoryByNodeIdInput!) {
  deleteObjectPropertiesHistoryByNodeId(input: $input) {
    clientMutationId
    objectPropertiesHistory {
      ...ObjectPropertiesHistoryFragment
    }
    deletedObjectPropertiesHistoryNodeId
    userByBy {
      ...UserFragment
    }
    objectPropertiesHistoryEdge {
      ...ObjectPropertiesHistoriesEdgeFragment
    }
  }
}

Variables

{"input": DeleteObjectPropertiesHistoryByNodeIdInput}

Response

{
  "data": {
    "deleteObjectPropertiesHistoryByNodeId": {
      "clientMutationId": "xyz789",
      "objectPropertiesHistory": ObjectPropertiesHistory,
      "deletedObjectPropertiesHistoryNodeId": ID,
      "userByBy": User,
      "objectPropertiesHistoryEdge": ObjectPropertiesHistoriesEdge
    }
  }
}

Mutations

`deleteObjectsToObject`

Deletes a single ObjectsToObject using a unique key

Returns a DeleteObjectsToObjectPayload

Name	Description
`input` - `DeleteObjectsToObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteObjectsToObject($input: DeleteObjectsToObjectInput!) {
  deleteObjectsToObject(input: $input) {
    clientMutationId
    objectsToObject {
      ...ObjectsToObjectFragment
    }
    deletedObjectsToObjectNodeId
    object1 {
      ...ObjectFragment
    }
    object2 {
      ...ObjectFragment
    }
    objectsToObjectEdge {
      ...ObjectsToObjectsEdgeFragment
    }
  }
}

Variables

{"input": DeleteObjectsToObjectInput}

Response

{
  "data": {
    "deleteObjectsToObject": {
      "clientMutationId": "xyz789",
      "objectsToObject": ObjectsToObject,
      "deletedObjectsToObjectNodeId": ID,
      "object1": Object,
      "object2": Object,
      "objectsToObjectEdge": ObjectsToObjectsEdge
    }
  }
}

Mutations

`deleteObjectsToObjectByNodeId`

Deletes a single ObjectsToObject using its globally unique id

Returns a DeleteObjectsToObjectPayload

Name	Description
`input` - `DeleteObjectsToObjectByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteObjectsToObjectByNodeId($input: DeleteObjectsToObjectByNodeIdInput!) {
  deleteObjectsToObjectByNodeId(input: $input) {
    clientMutationId
    objectsToObject {
      ...ObjectsToObjectFragment
    }
    deletedObjectsToObjectNodeId
    object1 {
      ...ObjectFragment
    }
    object2 {
      ...ObjectFragment
    }
    objectsToObjectEdge {
      ...ObjectsToObjectsEdgeFragment
    }
  }
}

Variables

{"input": DeleteObjectsToObjectByNodeIdInput}

Response

{
  "data": {
    "deleteObjectsToObjectByNodeId": {
      "clientMutationId": "xyz789",
      "objectsToObject": ObjectsToObject,
      "deletedObjectsToObjectNodeId": ID,
      "object1": Object,
      "object2": Object,
      "objectsToObjectEdge": ObjectsToObjectsEdge
    }
  }
}

Mutations

`deleteObjectsToObjectByObject1IdAndObject2Id`

Deletes a single ObjectsToObject using a unique key

Returns a DeleteObjectsToObjectPayload

Name	Description
`input` - `DeleteObjectsToObjectByObject1IdAndObject2IdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteObjectsToObjectByObject1IdAndObject2Id($input: DeleteObjectsToObjectByObject1IdAndObject2IdInput!) {
  deleteObjectsToObjectByObject1IdAndObject2Id(input: $input) {
    clientMutationId
    objectsToObject {
      ...ObjectsToObjectFragment
    }
    deletedObjectsToObjectNodeId
    object1 {
      ...ObjectFragment
    }
    object2 {
      ...ObjectFragment
    }
    objectsToObjectEdge {
      ...ObjectsToObjectsEdgeFragment
    }
  }
}

Variables

{
  "input": DeleteObjectsToObjectByObject1IdAndObject2IdInput
}

Response

{
  "data": {
    "deleteObjectsToObjectByObject1IdAndObject2Id": {
      "clientMutationId": "xyz789",
      "objectsToObject": ObjectsToObject,
      "deletedObjectsToObjectNodeId": ID,
      "object1": Object,
      "object2": Object,
      "objectsToObjectEdge": ObjectsToObjectsEdge
    }
  }
}

Mutations

`deletePropertyType`

Deletes a single PropertyType using a unique key

Returns a DeletePropertyTypePayload

Name	Description
`input` - `DeletePropertyTypeInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deletePropertyType($input: DeletePropertyTypeInput!) {
  deletePropertyType(input: $input) {
    clientMutationId
    propertyType {
      ...PropertyTypeFragment
    }
    deletedPropertyTypeNodeId
    propertyTypeEdge {
      ...PropertyTypesEdgeFragment
    }
  }
}

Variables

{"input": DeletePropertyTypeInput}

Response

{
  "data": {
    "deletePropertyType": {
      "clientMutationId": "abc123",
      "propertyType": PropertyType,
      "deletedPropertyTypeNodeId": ID,
      "propertyTypeEdge": PropertyTypesEdge
    }
  }
}

Mutations

`deletePropertyTypeByName`

Deletes a single PropertyType using a unique key

Returns a DeletePropertyTypePayload

Name	Description
`input` - `DeletePropertyTypeByNameInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deletePropertyTypeByName($input: DeletePropertyTypeByNameInput!) {
  deletePropertyTypeByName(input: $input) {
    clientMutationId
    propertyType {
      ...PropertyTypeFragment
    }
    deletedPropertyTypeNodeId
    propertyTypeEdge {
      ...PropertyTypesEdgeFragment
    }
  }
}

Variables

{"input": DeletePropertyTypeByNameInput}

Response

{
  "data": {
    "deletePropertyTypeByName": {
      "clientMutationId": "abc123",
      "propertyType": PropertyType,
      "deletedPropertyTypeNodeId": ID,
      "propertyTypeEdge": PropertyTypesEdge
    }
  }
}

Mutations

`deletePropertyTypeByNodeId`

Deletes a single PropertyType using its globally unique id

Returns a DeletePropertyTypePayload

Name	Description
`input` - `DeletePropertyTypeByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deletePropertyTypeByNodeId($input: DeletePropertyTypeByNodeIdInput!) {
  deletePropertyTypeByNodeId(input: $input) {
    clientMutationId
    propertyType {
      ...PropertyTypeFragment
    }
    deletedPropertyTypeNodeId
    propertyTypeEdge {
      ...PropertyTypesEdgeFragment
    }
  }
}

Variables

{"input": DeletePropertyTypeByNodeIdInput}

Response

{
  "data": {
    "deletePropertyTypeByNodeId": {
      "clientMutationId": "xyz789",
      "propertyType": PropertyType,
      "deletedPropertyTypeNodeId": ID,
      "propertyTypeEdge": PropertyTypesEdge
    }
  }
}

Mutations

`deleteSchema`

Deletes a single Schema using a unique key

Returns a DeleteSchemaPayload

Name	Description
`input` - `DeleteSchemaInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteSchema($input: DeleteSchemaInput!) {
  deleteSchema(input: $input) {
    clientMutationId
    schema {
      ...SchemaFragment
    }
    deletedSchemaNodeId
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaEdge {
      ...SchemataEdgeFragment
    }
  }
}

Variables

{"input": DeleteSchemaInput}

Response

{
  "data": {
    "deleteSchema": {
      "clientMutationId": "xyz789",
      "schema": Schema,
      "deletedSchemaNodeId": ID,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaEdge": SchemataEdge
    }
  }
}

Mutations

`deleteSchemaByNodeId`

Deletes a single Schema using its globally unique id

Returns a DeleteSchemaPayload

Name	Description
`input` - `DeleteSchemaByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteSchemaByNodeId($input: DeleteSchemaByNodeIdInput!) {
  deleteSchemaByNodeId(input: $input) {
    clientMutationId
    schema {
      ...SchemaFragment
    }
    deletedSchemaNodeId
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaEdge {
      ...SchemataEdgeFragment
    }
  }
}

Variables

{"input": DeleteSchemaByNodeIdInput}

Response

{
  "data": {
    "deleteSchemaByNodeId": {
      "clientMutationId": "abc123",
      "schema": Schema,
      "deletedSchemaNodeId": ID,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaEdge": SchemataEdge
    }
  }
}

Mutations

`deleteSchemaControl`

Deletes a single SchemaControl using a unique key

Returns a DeleteSchemaControlPayload

Name	Description
`input` - `DeleteSchemaControlInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteSchemaControl($input: DeleteSchemaControlInput!) {
  deleteSchemaControl(input: $input) {
    clientMutationId
    schemaControl {
      ...SchemaControlFragment
    }
    deletedSchemaControlNodeId
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    schemaControlEdge {
      ...SchemaControlsEdgeFragment
    }
  }
}

Variables

{"input": DeleteSchemaControlInput}

Response

{
  "data": {
    "deleteSchemaControl": {
      "clientMutationId": "abc123",
      "schemaControl": SchemaControl,
      "deletedSchemaControlNodeId": ID,
      "schema": Schema,
      "userByBy": User,
      "schemaControlEdge": SchemaControlsEdge
    }
  }
}

Mutations

`deleteSchemaControlByNodeId`

Deletes a single SchemaControl using its globally unique id

Returns a DeleteSchemaControlPayload

Name	Description
`input` - `DeleteSchemaControlByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteSchemaControlByNodeId($input: DeleteSchemaControlByNodeIdInput!) {
  deleteSchemaControlByNodeId(input: $input) {
    clientMutationId
    schemaControl {
      ...SchemaControlFragment
    }
    deletedSchemaControlNodeId
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    schemaControlEdge {
      ...SchemaControlsEdgeFragment
    }
  }
}

Variables

{"input": DeleteSchemaControlByNodeIdInput}

Response

{
  "data": {
    "deleteSchemaControlByNodeId": {
      "clientMutationId": "abc123",
      "schemaControl": SchemaControl,
      "deletedSchemaControlNodeId": ID,
      "schema": Schema,
      "userByBy": User,
      "schemaControlEdge": SchemaControlsEdge
    }
  }
}

Mutations

`deleteSchemaProperty`

Deletes a single SchemaProperty using a unique key

Returns a DeleteSchemaPropertyPayload

Name	Description
`input` - `DeleteSchemaPropertyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteSchemaProperty($input: DeleteSchemaPropertyInput!) {
  deleteSchemaProperty(input: $input) {
    clientMutationId
    schemaProperty {
      ...SchemaPropertyFragment
    }
    deletedSchemaPropertyNodeId
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    type {
      ...PropertyTypeFragment
    }
    schemaPropertyEdge {
      ...SchemaPropertiesEdgeFragment
    }
  }
}

Variables

{"input": DeleteSchemaPropertyInput}

Response

{
  "data": {
    "deleteSchemaProperty": {
      "clientMutationId": "xyz789",
      "schemaProperty": SchemaProperty,
      "deletedSchemaPropertyNodeId": ID,
      "schema": Schema,
      "userByBy": User,
      "type": PropertyType,
      "schemaPropertyEdge": SchemaPropertiesEdge
    }
  }
}

Mutations

`deleteSchemaPropertyByNodeId`

Deletes a single SchemaProperty using its globally unique id

Returns a DeleteSchemaPropertyPayload

Name	Description
`input` - `DeleteSchemaPropertyByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteSchemaPropertyByNodeId($input: DeleteSchemaPropertyByNodeIdInput!) {
  deleteSchemaPropertyByNodeId(input: $input) {
    clientMutationId
    schemaProperty {
      ...SchemaPropertyFragment
    }
    deletedSchemaPropertyNodeId
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    type {
      ...PropertyTypeFragment
    }
    schemaPropertyEdge {
      ...SchemaPropertiesEdgeFragment
    }
  }
}

Variables

{"input": DeleteSchemaPropertyByNodeIdInput}

Response

{
  "data": {
    "deleteSchemaPropertyByNodeId": {
      "clientMutationId": "xyz789",
      "schemaProperty": SchemaProperty,
      "deletedSchemaPropertyNodeId": ID,
      "schema": Schema,
      "userByBy": User,
      "type": PropertyType,
      "schemaPropertyEdge": SchemaPropertiesEdge
    }
  }
}

Mutations

`deleteUser`

Deletes a single User using a unique key

Returns a DeleteUserPayload

Name	Description
`input` - `DeleteUserInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUser($input: DeleteUserInput!) {
  deleteUser(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    deletedUserNodeId
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": DeleteUserInput}

Response

{
  "data": {
    "deleteUser": {
      "clientMutationId": "xyz789",
      "user": User,
      "deletedUserNodeId": ID,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`deleteUserByLogin`

Deletes a single User using a unique key

Returns a DeleteUserPayload

Name	Description
`input` - `DeleteUserByLoginInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUserByLogin($input: DeleteUserByLoginInput!) {
  deleteUserByLogin(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    deletedUserNodeId
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": DeleteUserByLoginInput}

Response

{
  "data": {
    "deleteUserByLogin": {
      "clientMutationId": "xyz789",
      "user": User,
      "deletedUserNodeId": ID,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`deleteUserByNodeId`

Deletes a single User using its globally unique id

Returns a DeleteUserPayload

Name	Description
`input` - `DeleteUserByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUserByNodeId($input: DeleteUserByNodeIdInput!) {
  deleteUserByNodeId(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    deletedUserNodeId
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": DeleteUserByNodeIdInput}

Response

{
  "data": {
    "deleteUserByNodeId": {
      "clientMutationId": "abc123",
      "user": User,
      "deletedUserNodeId": ID,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`deleteUserGroup`

Deletes a single UserGroup using a unique key

Returns a DeleteUserGroupPayload

Name	Description
`input` - `DeleteUserGroupInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUserGroup($input: DeleteUserGroupInput!) {
  deleteUserGroup(input: $input) {
    clientMutationId
    userGroup {
      ...UserGroupFragment
    }
    deletedUserGroupNodeId
    userByBy {
      ...UserFragment
    }
    userGroupEdge {
      ...UserGroupsEdgeFragment
    }
  }
}

Variables

{"input": DeleteUserGroupInput}

Response

{
  "data": {
    "deleteUserGroup": {
      "clientMutationId": "xyz789",
      "userGroup": UserGroup,
      "deletedUserGroupNodeId": ID,
      "userByBy": User,
      "userGroupEdge": UserGroupsEdge
    }
  }
}

Mutations

`deleteUserGroupByGroupName`

Deletes a single UserGroup using a unique key

Returns a DeleteUserGroupPayload

Name	Description
`input` - `DeleteUserGroupByGroupNameInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUserGroupByGroupName($input: DeleteUserGroupByGroupNameInput!) {
  deleteUserGroupByGroupName(input: $input) {
    clientMutationId
    userGroup {
      ...UserGroupFragment
    }
    deletedUserGroupNodeId
    userByBy {
      ...UserFragment
    }
    userGroupEdge {
      ...UserGroupsEdgeFragment
    }
  }
}

Variables

{"input": DeleteUserGroupByGroupNameInput}

Response

{
  "data": {
    "deleteUserGroupByGroupName": {
      "clientMutationId": "xyz789",
      "userGroup": UserGroup,
      "deletedUserGroupNodeId": ID,
      "userByBy": User,
      "userGroupEdge": UserGroupsEdge
    }
  }
}

Mutations

`deleteUserGroupByNodeId`

Deletes a single UserGroup using its globally unique id

Returns a DeleteUserGroupPayload

Name	Description
`input` - `DeleteUserGroupByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUserGroupByNodeId($input: DeleteUserGroupByNodeIdInput!) {
  deleteUserGroupByNodeId(input: $input) {
    clientMutationId
    userGroup {
      ...UserGroupFragment
    }
    deletedUserGroupNodeId
    userByBy {
      ...UserFragment
    }
    userGroupEdge {
      ...UserGroupsEdgeFragment
    }
  }
}

Variables

{"input": DeleteUserGroupByNodeIdInput}

Response

{
  "data": {
    "deleteUserGroupByNodeId": {
      "clientMutationId": "abc123",
      "userGroup": UserGroup,
      "deletedUserGroupNodeId": ID,
      "userByBy": User,
      "userGroupEdge": UserGroupsEdge
    }
  }
}

Mutations

`deleteUsersToGroup`

Deletes a single UsersToGroup using a unique key

Returns a DeleteUsersToGroupPayload

Name	Description
`input` - `DeleteUsersToGroupInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUsersToGroup($input: DeleteUsersToGroupInput!) {
  deleteUsersToGroup(input: $input) {
    clientMutationId
    usersToGroup {
      ...UsersToGroupFragment
    }
    deletedUsersToGroupNodeId
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
    usersToGroupEdge {
      ...UsersToGroupsEdgeFragment
    }
  }
}

Variables

{"input": DeleteUsersToGroupInput}

Response

{
  "data": {
    "deleteUsersToGroup": {
      "clientMutationId": "xyz789",
      "usersToGroup": UsersToGroup,
      "deletedUsersToGroupNodeId": ID,
      "user": User,
      "userGroup": UserGroup,
      "usersToGroupEdge": UsersToGroupsEdge
    }
  }
}

Mutations

`deleteUsersToGroupByNodeId`

Deletes a single UsersToGroup using its globally unique id

Returns a DeleteUsersToGroupPayload

Name	Description
`input` - `DeleteUsersToGroupByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUsersToGroupByNodeId($input: DeleteUsersToGroupByNodeIdInput!) {
  deleteUsersToGroupByNodeId(input: $input) {
    clientMutationId
    usersToGroup {
      ...UsersToGroupFragment
    }
    deletedUsersToGroupNodeId
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
    usersToGroupEdge {
      ...UsersToGroupsEdgeFragment
    }
  }
}

Variables

{"input": DeleteUsersToGroupByNodeIdInput}

Response

{
  "data": {
    "deleteUsersToGroupByNodeId": {
      "clientMutationId": "xyz789",
      "usersToGroup": UsersToGroup,
      "deletedUsersToGroupNodeId": ID,
      "user": User,
      "userGroup": UserGroup,
      "usersToGroupEdge": UsersToGroupsEdge
    }
  }
}

Mutations

`deleteUsersToGroupByUserIdAndUserGroupId`

Deletes a single UsersToGroup using a unique key

Returns a DeleteUsersToGroupPayload

Name	Description
`input` - `DeleteUsersToGroupByUserIdAndUserGroupIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUsersToGroupByUserIdAndUserGroupId($input: DeleteUsersToGroupByUserIdAndUserGroupIdInput!) {
  deleteUsersToGroupByUserIdAndUserGroupId(input: $input) {
    clientMutationId
    usersToGroup {
      ...UsersToGroupFragment
    }
    deletedUsersToGroupNodeId
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
    usersToGroupEdge {
      ...UsersToGroupsEdgeFragment
    }
  }
}

Variables

{"input": DeleteUsersToGroupByUserIdAndUserGroupIdInput}

Response

{
  "data": {
    "deleteUsersToGroupByUserIdAndUserGroupId": {
      "clientMutationId": "xyz789",
      "usersToGroup": UsersToGroup,
      "deletedUsersToGroupNodeId": ID,
      "user": User,
      "userGroup": UserGroup,
      "usersToGroupEdge": UsersToGroupsEdge
    }
  }
}

Mutations

`deleteUsersToObject`

Deletes a single UsersToObject using a unique key

Returns a DeleteUsersToObjectPayload

Name	Description
`input` - `DeleteUsersToObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUsersToObject($input: DeleteUsersToObjectInput!) {
  deleteUsersToObject(input: $input) {
    clientMutationId
    usersToObject {
      ...UsersToObjectFragment
    }
    deletedUsersToObjectNodeId
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
    usersToObjectEdge {
      ...UsersToObjectsEdgeFragment
    }
  }
}

Variables

{"input": DeleteUsersToObjectInput}

Response

{
  "data": {
    "deleteUsersToObject": {
      "clientMutationId": "xyz789",
      "usersToObject": UsersToObject,
      "deletedUsersToObjectNodeId": ID,
      "user": User,
      "object": Object,
      "usersToObjectEdge": UsersToObjectsEdge
    }
  }
}

Mutations

`deleteUsersToObjectByNodeId`

Deletes a single UsersToObject using its globally unique id

Returns a DeleteUsersToObjectPayload

Name	Description
`input` - `DeleteUsersToObjectByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUsersToObjectByNodeId($input: DeleteUsersToObjectByNodeIdInput!) {
  deleteUsersToObjectByNodeId(input: $input) {
    clientMutationId
    usersToObject {
      ...UsersToObjectFragment
    }
    deletedUsersToObjectNodeId
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
    usersToObjectEdge {
      ...UsersToObjectsEdgeFragment
    }
  }
}

Variables

{"input": DeleteUsersToObjectByNodeIdInput}

Response

{
  "data": {
    "deleteUsersToObjectByNodeId": {
      "clientMutationId": "xyz789",
      "usersToObject": UsersToObject,
      "deletedUsersToObjectNodeId": ID,
      "user": User,
      "object": Object,
      "usersToObjectEdge": UsersToObjectsEdge
    }
  }
}

Mutations

`deleteUsersToObjectByUserIdAndObjectId`

Deletes a single UsersToObject using a unique key

Returns a DeleteUsersToObjectPayload

Name	Description
`input` - `DeleteUsersToObjectByUserIdAndObjectIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation deleteUsersToObjectByUserIdAndObjectId($input: DeleteUsersToObjectByUserIdAndObjectIdInput!) {
  deleteUsersToObjectByUserIdAndObjectId(input: $input) {
    clientMutationId
    usersToObject {
      ...UsersToObjectFragment
    }
    deletedUsersToObjectNodeId
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
    usersToObjectEdge {
      ...UsersToObjectsEdgeFragment
    }
  }
}

Variables

{"input": DeleteUsersToObjectByUserIdAndObjectIdInput}

Response

{
  "data": {
    "deleteUsersToObjectByUserIdAndObjectId": {
      "clientMutationId": "abc123",
      "usersToObject": UsersToObject,
      "deletedUsersToObjectNodeId": ID,
      "user": User,
      "object": Object,
      "usersToObjectEdge": UsersToObjectsEdge
    }
  }
}

Mutations

`exportConfiguration`

Returns an ExportConfigurationPayload

Name	Description
`input` - `ExportConfigurationInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation exportConfiguration($input: ExportConfigurationInput!) {
  exportConfiguration(input: $input) {
    clientMutationId
    string
  }
}

Variables

{"input": ExportConfigurationInput}

Response

{
  "data": {
    "exportConfiguration": {"clientMutationId": "abc123", "string": "xyz789"}
  }
}

Mutations

`iDoInsertControlExecution`

Returns an IDoInsertControlExecutionPayload

Name	Description
`input` - `IDoInsertControlExecutionInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation iDoInsertControlExecution($input: IDoInsertControlExecutionInput!) {
  iDoInsertControlExecution(input: $input) {
    clientMutationId
    integer
  }
}

Variables

{"input": IDoInsertControlExecutionInput}

Response

{
  "data": {
    "iDoInsertControlExecution": {"clientMutationId": "xyz789", "integer": 123}
  }
}

Mutations

`importSchema`

Import schema into the platform in JSON format (which should be passed as an escaped String parameter). Use ExportSchema to get the file which can be edited if needed and then imported. If ID of Schema is omitted, then Platform would try to use Identification Tags to check for schema existence in the Platform. All schemas with matching Identification Tags would be updated. Otherwise, new schema would be created. UpdateOnly mode can be used to update only existing schemas in the Platform, no new schemas would be added. It is false by default and can be omitted.

Returns an ImportSchemaPayload

Name	Description
`input` - `ImportSchemaInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation importSchema($input: ImportSchemaInput!) {
  importSchema(input: $input) {
    clientMutationId
    uuid
  }
}

Variables

{"input": ImportSchemaInput}

Response

{
  "data": {
    "importSchema": {
      "clientMutationId": "abc123",
      "uuid": UUID
    }
  }
}

Mutations

`logout`

Raises warning and removes all user's tokens from DB

Returns a LogoutPayload

Name	Description
`input` - `LogoutInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation logout($input: LogoutInput!) {
  logout(input: $input) {
    clientMutationId
    string
  }
}

Variables

{"input": LogoutInput}

Response

{"data": {"logout": {"clientMutationId": "abc123", "string": "abc123"}}}

Mutations

`mnCreateObject`

Creates one or many Object

Returns a mnCreateObjectPayload

Name	Description
`input` - `mnCreateObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation mnCreateObject($input: mnCreateObjectInput!) {
  mnCreateObject(input: $input) {
    clientMutationId
    object {
      ...ObjectFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    objectEdge {
      ...ObjectsEdgeFragment
    }
  }
}

Variables

{"input": mnCreateObjectInput}

Response

{
  "data": {
    "mnCreateObject": {
      "clientMutationId": "xyz789",
      "object": Object,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "objectEdge": ObjectsEdge
    }
  }
}

Mutations

`mnCreateSchema`

Creates one or many Schema

Returns a mnCreateSchemaPayload

Name	Description
`input` - `mnCreateSchemaInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation mnCreateSchema($input: mnCreateSchemaInput!) {
  mnCreateSchema(input: $input) {
    clientMutationId
    schema {
      ...SchemaFragment
    }
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaEdge {
      ...SchemataEdgeFragment
    }
  }
}

Variables

{"input": mnCreateSchemaInput}

Response

{
  "data": {
    "mnCreateSchema": {
      "clientMutationId": "abc123",
      "schema": Schema,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaEdge": SchemataEdge
    }
  }
}

Mutations

`mnCreateUser`

Creates one or many User

Returns a mnCreateUserPayload

Name	Description
`input` - `mnCreateUserInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation mnCreateUser($input: mnCreateUserInput!) {
  mnCreateUser(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": mnCreateUserInput}

Response

{
  "data": {
    "mnCreateUser": {
      "clientMutationId": "abc123",
      "user": User,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`mnDeleteObject`

Deletes one or many Object a unique key via a patch

Returns a mnDeleteObjectPayload

Name	Description
`input` - `mnDeleteObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation mnDeleteObject($input: mnDeleteObjectInput!) {
  mnDeleteObject(input: $input) {
    clientMutationId
    object {
      ...ObjectFragment
    }
    deletedObjectNodeId
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    objectEdge {
      ...ObjectsEdgeFragment
    }
  }
}

Variables

{"input": mnDeleteObjectInput}

Response

{
  "data": {
    "mnDeleteObject": {
      "clientMutationId": "abc123",
      "object": Object,
      "deletedObjectNodeId": ID,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "objectEdge": ObjectsEdge
    }
  }
}

Mutations

`mnDeleteSchema`

Deletes one or many Schema a unique key via a patch

Returns a mnDeleteSchemaPayload

Name	Description
`input` - `mnDeleteSchemaInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation mnDeleteSchema($input: mnDeleteSchemaInput!) {
  mnDeleteSchema(input: $input) {
    clientMutationId
    schema {
      ...SchemaFragment
    }
    deletedSchemaNodeId
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaEdge {
      ...SchemataEdgeFragment
    }
  }
}

Variables

{"input": mnDeleteSchemaInput}

Response

{
  "data": {
    "mnDeleteSchema": {
      "clientMutationId": "abc123",
      "schema": Schema,
      "deletedSchemaNodeId": ID,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaEdge": SchemataEdge
    }
  }
}

Mutations

`mnDeleteUser`

Deletes one or many User a unique key via a patch

Returns a mnDeleteUserPayload

Name	Description
`input` - `mnDeleteUserInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation mnDeleteUser($input: mnDeleteUserInput!) {
  mnDeleteUser(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    deletedUserNodeId
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": mnDeleteUserInput}

Response

{
  "data": {
    "mnDeleteUser": {
      "clientMutationId": "abc123",
      "user": User,
      "deletedUserNodeId": ID,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`mnUpdateObject`

Updates one or many Object using a unique key and a patch

Returns a mnUpdateObjectPayload

Name	Description
`input` - `mnUpdateObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation mnUpdateObject($input: mnUpdateObjectInput!) {
  mnUpdateObject(input: $input) {
    clientMutationId
    object {
      ...ObjectFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    objectEdge {
      ...ObjectsEdgeFragment
    }
  }
}

Variables

{"input": mnUpdateObjectInput}

Response

{
  "data": {
    "mnUpdateObject": {
      "clientMutationId": "abc123",
      "object": Object,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "objectEdge": ObjectsEdge
    }
  }
}

Mutations

`mnUpdateSchema`

Updates one or many Schema using a unique key and a patch

Returns a mnUpdateSchemaPayload

Name	Description
`input` - `mnUpdateSchemaInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation mnUpdateSchema($input: mnUpdateSchemaInput!) {
  mnUpdateSchema(input: $input) {
    clientMutationId
    schema {
      ...SchemaFragment
    }
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaEdge {
      ...SchemataEdgeFragment
    }
  }
}

Variables

{"input": mnUpdateSchemaInput}

Response

{
  "data": {
    "mnUpdateSchema": {
      "clientMutationId": "xyz789",
      "schema": Schema,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaEdge": SchemataEdge
    }
  }
}

Mutations

`mnUpdateUser`

Updates one or many User using a unique key and a patch

Returns a mnUpdateUserPayload

Name	Description
`input` - `mnUpdateUserInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation mnUpdateUser($input: mnUpdateUserInput!) {
  mnUpdateUser(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": mnUpdateUserInput}

Response

{
  "data": {
    "mnUpdateUser": {
      "clientMutationId": "xyz789",
      "user": User,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`resetProperty`

Reset object property by uuid to default value from schema

Returns a ResetPropertyPayload

Name	Description
`input` - `ResetPropertyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation resetProperty($input: ResetPropertyInput!) {
  resetProperty(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": ResetPropertyInput}

Response

{"data": {"resetProperty": {"clientMutationId": "xyz789", "boolean": false}}}

Mutations

`resolveObjectPermissions`

Returns set of permissions (edit, use, read) provided to user to access entire object. If user_id is omitted, uses i_current_user_id() instead

Returns a ResolveObjectPermissionsPayload

Name	Description
`input` - `ResolveObjectPermissionsInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation resolveObjectPermissions($input: ResolveObjectPermissionsInput!) {
  resolveObjectPermissions(input: $input) {
    clientMutationId
    accessRight {
      ...AccessRightFragment
    }
  }
}

Variables

{"input": ResolveObjectPermissionsInput}

Response

{
  "data": {
    "resolveObjectPermissions": {
      "clientMutationId": "abc123",
      "accessRight": AccessRight
    }
  }
}

Mutations

`setObjectFavourite`

Set/unset objects as a favourite.

Returns a SetObjectFavouritePayload

Name	Description
`input` - `SetObjectFavouriteInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation setObjectFavourite($input: SetObjectFavouriteInput!) {
  setObjectFavourite(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": SetObjectFavouriteInput}

Response

{
  "data": {
    "setObjectFavourite": {"clientMutationId": "xyz789", "boolean": false}
  }
}

Mutations

`setObjectMuted`

Set/unset object as a muted.

Returns a SetObjectMutedPayload

Name	Description
`input` - `SetObjectMutedInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation setObjectMuted($input: SetObjectMutedInput!) {
  setObjectMuted(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": SetObjectMutedInput}

Response

{"data": {"setObjectMuted": {"clientMutationId": "xyz789", "boolean": false}}}

Mutations

`setUserEnabled`

Enable/disable users

Returns a SetUserEnabledPayload

Name	Description
`input` - `SetUserEnabledInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation setUserEnabled($input: SetUserEnabledInput!) {
  setUserEnabled(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": SetUserEnabledInput}

Response

{"data": {"setUserEnabled": {"clientMutationId": "abc123", "boolean": true}}}

Mutations

`updateControlExecutionAck`

Acknowledge RPC/Control receive

Returns an UpdateControlExecutionAckPayload

Name	Description
`input` - `UpdateControlExecutionAckInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateControlExecutionAck($input: UpdateControlExecutionAckInput!) {
  updateControlExecutionAck(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateControlExecutionAckInput}

Response

{
  "data": {
    "updateControlExecutionAck": {"clientMutationId": "xyz789", "boolean": true}
  }
}

Mutations

`updateJsonPropertyArray`

Update Property of Json Array type with provided array element.

Returns an UpdateJsonPropertyArrayPayload

Name	Description
`input` - `UpdateJsonPropertyArrayInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateJsonPropertyArray($input: UpdateJsonPropertyArrayInput!) {
  updateJsonPropertyArray(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateJsonPropertyArrayInput}

Response

{
  "data": {
    "updateJsonPropertyArray": {"clientMutationId": "xyz789", "boolean": false}
  }
}

Mutations

`updateObject`

Updates a single Object using a unique key and a patch

Returns an UpdateObjectPayload

Name	Description
`input` - `UpdateObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObject($input: UpdateObjectInput!) {
  updateObject(input: $input) {
    clientMutationId
    object {
      ...ObjectFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    objectEdge {
      ...ObjectsEdgeFragment
    }
  }
}

Variables

{"input": UpdateObjectInput}

Response

{
  "data": {
    "updateObject": {
      "clientMutationId": "abc123",
      "object": Object,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "objectEdge": ObjectsEdge
    }
  }
}

Mutations

`updateObjectByNodeId`

Updates a single Object using its globally unique id and a patch

Returns an UpdateObjectPayload

Name	Description
`input` - `UpdateObjectByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectByNodeId($input: UpdateObjectByNodeIdInput!) {
  updateObjectByNodeId(input: $input) {
    clientMutationId
    object {
      ...ObjectFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    schema {
      ...SchemaFragment
    }
    objectEdge {
      ...ObjectsEdgeFragment
    }
  }
}

Variables

{"input": UpdateObjectByNodeIdInput}

Response

{
  "data": {
    "updateObjectByNodeId": {
      "clientMutationId": "abc123",
      "object": Object,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "schema": Schema,
      "objectEdge": ObjectsEdge
    }
  }
}

Mutations

`updateObjectPropertiesById`

Update object properties by their respective ids.

Returns an UpdateObjectPropertiesByIdPayload

Name	Description
`input` - `UpdateObjectPropertiesByIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectPropertiesById($input: UpdateObjectPropertiesByIdInput!) {
  updateObjectPropertiesById(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateObjectPropertiesByIdInput}

Response

{
  "data": {
    "updateObjectPropertiesById": {
      "clientMutationId": "xyz789",
      "boolean": false
    }
  }
}

Mutations

`updateObjectPropertiesByKey`

Returns an UpdateObjectPropertiesByKeyPayload

Name	Description
`input` - `UpdateObjectPropertiesByKeyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectPropertiesByKey($input: UpdateObjectPropertiesByKeyInput!) {
  updateObjectPropertiesByKey(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateObjectPropertiesByKeyInput}

Response

{
  "data": {
    "updateObjectPropertiesByKey": {
      "clientMutationId": "abc123",
      "boolean": true
    }
  }
}

Mutations

`updateObjectPropertiesByName`

Returns an UpdateObjectPropertiesByNamePayload

Name	Description
`input` - `UpdateObjectPropertiesByNameInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectPropertiesByName($input: UpdateObjectPropertiesByNameInput!) {
  updateObjectPropertiesByName(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateObjectPropertiesByNameInput}

Response

{
  "data": {
    "updateObjectPropertiesByName": {
      "clientMutationId": "abc123",
      "boolean": true
    }
  }
}

Mutations

`updateObjectPropertiesHistory`

Updates a single ObjectPropertiesHistory using a unique key and a patch

Returns an UpdateObjectPropertiesHistoryPayload

Name	Description
`input` - `UpdateObjectPropertiesHistoryInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectPropertiesHistory($input: UpdateObjectPropertiesHistoryInput!) {
  updateObjectPropertiesHistory(input: $input) {
    clientMutationId
    objectPropertiesHistory {
      ...ObjectPropertiesHistoryFragment
    }
    userByBy {
      ...UserFragment
    }
    objectPropertiesHistoryEdge {
      ...ObjectPropertiesHistoriesEdgeFragment
    }
  }
}

Variables

{"input": UpdateObjectPropertiesHistoryInput}

Response

{
  "data": {
    "updateObjectPropertiesHistory": {
      "clientMutationId": "xyz789",
      "objectPropertiesHistory": ObjectPropertiesHistory,
      "userByBy": User,
      "objectPropertiesHistoryEdge": ObjectPropertiesHistoriesEdge
    }
  }
}

Mutations

`updateObjectPropertiesHistoryByNodeId`

Updates a single ObjectPropertiesHistory using its globally unique id and a patch

Returns an UpdateObjectPropertiesHistoryPayload

Name	Description
`input` - `UpdateObjectPropertiesHistoryByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectPropertiesHistoryByNodeId($input: UpdateObjectPropertiesHistoryByNodeIdInput!) {
  updateObjectPropertiesHistoryByNodeId(input: $input) {
    clientMutationId
    objectPropertiesHistory {
      ...ObjectPropertiesHistoryFragment
    }
    userByBy {
      ...UserFragment
    }
    objectPropertiesHistoryEdge {
      ...ObjectPropertiesHistoriesEdgeFragment
    }
  }
}

Variables

{"input": UpdateObjectPropertiesHistoryByNodeIdInput}

Response

{
  "data": {
    "updateObjectPropertiesHistoryByNodeId": {
      "clientMutationId": "abc123",
      "objectPropertiesHistory": ObjectPropertiesHistory,
      "userByBy": User,
      "objectPropertiesHistoryEdge": ObjectPropertiesHistoriesEdge
    }
  }
}

Mutations

`updateObjectProperty`

Updates a single ObjectProperty using a unique key and a patch

Returns an UpdateObjectPropertyPayload

Name	Description
`input` - `UpdateObjectPropertyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectProperty($input: UpdateObjectPropertyInput!) {
  updateObjectProperty(input: $input) {
    clientMutationId
    objectProperty {
      ...ObjectPropertyFragment
    }
    object {
      ...ObjectFragment
    }
    linkedProperty {
      ...ObjectPropertyFragment
    }
    userByBy {
      ...UserFragment
    }
    objectPropertyEdge {
      ...ObjectPropertiesEdgeFragment
    }
  }
}

Variables

{"input": UpdateObjectPropertyInput}

Response

{
  "data": {
    "updateObjectProperty": {
      "clientMutationId": "xyz789",
      "objectProperty": ObjectProperty,
      "object": Object,
      "linkedProperty": ObjectProperty,
      "userByBy": User,
      "objectPropertyEdge": ObjectPropertiesEdge
    }
  }
}

Mutations

`updateObjectPropertyByNodeId`

Updates a single ObjectProperty using its globally unique id and a patch

Returns an UpdateObjectPropertyPayload

Name	Description
`input` - `UpdateObjectPropertyByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectPropertyByNodeId($input: UpdateObjectPropertyByNodeIdInput!) {
  updateObjectPropertyByNodeId(input: $input) {
    clientMutationId
    objectProperty {
      ...ObjectPropertyFragment
    }
    object {
      ...ObjectFragment
    }
    linkedProperty {
      ...ObjectPropertyFragment
    }
    userByBy {
      ...UserFragment
    }
    objectPropertyEdge {
      ...ObjectPropertiesEdgeFragment
    }
  }
}

Variables

{"input": UpdateObjectPropertyByNodeIdInput}

Response

{
  "data": {
    "updateObjectPropertyByNodeId": {
      "clientMutationId": "xyz789",
      "objectProperty": ObjectProperty,
      "object": Object,
      "linkedProperty": ObjectProperty,
      "userByBy": User,
      "objectPropertyEdge": ObjectPropertiesEdge
    }
  }
}

Mutations

`updateObjectPropertyByObjectGroupProperty`

true

Update PropertyValue by ObjectID & GroupName & PropertyName

Returns an UpdateObjectPropertyByObjectGroupPropertyPayload

Name	Description
`input` - `UpdateObjectPropertyByObjectGroupPropertyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectPropertyByObjectGroupProperty($input: UpdateObjectPropertyByObjectGroupPropertyInput!) {
  updateObjectPropertyByObjectGroupProperty(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateObjectPropertyByObjectGroupPropertyInput}

Response

{
  "data": {
    "updateObjectPropertyByObjectGroupProperty": {
      "clientMutationId": "abc123",
      "boolean": false
    }
  }
}

Mutations

`updateObjectsPropertiesByKey`

Returns an UpdateObjectsPropertiesByKeyPayload

Name	Description
`input` - `UpdateObjectsPropertiesByKeyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectsPropertiesByKey($input: UpdateObjectsPropertiesByKeyInput!) {
  updateObjectsPropertiesByKey(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateObjectsPropertiesByKeyInput}

Response

{
  "data": {
    "updateObjectsPropertiesByKey": {
      "clientMutationId": "abc123",
      "boolean": false
    }
  }
}

Mutations

`updateObjectWithProperties`

Allows to update an Object, update its Properties, update links to Parent Objects and update links to Child Objects

Returns an UpdateObjectWithPropertiesPayload

Name	Description
`input` - `UpdateObjectWithPropertiesInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateObjectWithProperties($input: UpdateObjectWithPropertiesInput!) {
  updateObjectWithProperties(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateObjectWithPropertiesInput}

Response

{
  "data": {
    "updateObjectWithProperties": {
      "clientMutationId": "xyz789",
      "boolean": false
    }
  }
}

Mutations

`updatePropertyType`

Updates a single PropertyType using a unique key and a patch

Returns an UpdatePropertyTypePayload

Name	Description
`input` - `UpdatePropertyTypeInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updatePropertyType($input: UpdatePropertyTypeInput!) {
  updatePropertyType(input: $input) {
    clientMutationId
    propertyType {
      ...PropertyTypeFragment
    }
    propertyTypeEdge {
      ...PropertyTypesEdgeFragment
    }
  }
}

Variables

{"input": UpdatePropertyTypeInput}

Response

{
  "data": {
    "updatePropertyType": {
      "clientMutationId": "xyz789",
      "propertyType": PropertyType,
      "propertyTypeEdge": PropertyTypesEdge
    }
  }
}

Mutations

`updatePropertyTypeByName`

Updates a single PropertyType using a unique key and a patch

Returns an UpdatePropertyTypePayload

Name	Description
`input` - `UpdatePropertyTypeByNameInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updatePropertyTypeByName($input: UpdatePropertyTypeByNameInput!) {
  updatePropertyTypeByName(input: $input) {
    clientMutationId
    propertyType {
      ...PropertyTypeFragment
    }
    propertyTypeEdge {
      ...PropertyTypesEdgeFragment
    }
  }
}

Variables

{"input": UpdatePropertyTypeByNameInput}

Response

{
  "data": {
    "updatePropertyTypeByName": {
      "clientMutationId": "abc123",
      "propertyType": PropertyType,
      "propertyTypeEdge": PropertyTypesEdge
    }
  }
}

Mutations

`updatePropertyTypeByNodeId`

Updates a single PropertyType using its globally unique id and a patch

Returns an UpdatePropertyTypePayload

Name	Description
`input` - `UpdatePropertyTypeByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updatePropertyTypeByNodeId($input: UpdatePropertyTypeByNodeIdInput!) {
  updatePropertyTypeByNodeId(input: $input) {
    clientMutationId
    propertyType {
      ...PropertyTypeFragment
    }
    propertyTypeEdge {
      ...PropertyTypesEdgeFragment
    }
  }
}

Variables

{"input": UpdatePropertyTypeByNodeIdInput}

Response

{
  "data": {
    "updatePropertyTypeByNodeId": {
      "clientMutationId": "abc123",
      "propertyType": PropertyType,
      "propertyTypeEdge": PropertyTypesEdge
    }
  }
}

Mutations

`updateSchema`

Updates a single Schema using a unique key and a patch

Returns an UpdateSchemaPayload

Name	Description
`input` - `UpdateSchemaInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateSchema($input: UpdateSchemaInput!) {
  updateSchema(input: $input) {
    clientMutationId
    schema {
      ...SchemaFragment
    }
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaEdge {
      ...SchemataEdgeFragment
    }
  }
}

Variables

{"input": UpdateSchemaInput}

Response

{
  "data": {
    "updateSchema": {
      "clientMutationId": "xyz789",
      "schema": Schema,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaEdge": SchemataEdge
    }
  }
}

Mutations

`updateSchemaByNodeId`

Updates a single Schema using its globally unique id and a patch

Returns an UpdateSchemaPayload

Name	Description
`input` - `UpdateSchemaByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateSchemaByNodeId($input: UpdateSchemaByNodeIdInput!) {
  updateSchemaByNodeId(input: $input) {
    clientMutationId
    schema {
      ...SchemaFragment
    }
    userByApplicationOwner {
      ...UserFragment
    }
    userGroupByEditorgroup {
      ...UserGroupFragment
    }
    userGroupByUsergroup {
      ...UserGroupFragment
    }
    userGroupByReadergroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    parentSchema {
      ...SchemaFragment
    }
    schemaEdge {
      ...SchemataEdgeFragment
    }
  }
}

Variables

{"input": UpdateSchemaByNodeIdInput}

Response

{
  "data": {
    "updateSchemaByNodeId": {
      "clientMutationId": "xyz789",
      "schema": Schema,
      "userByApplicationOwner": User,
      "userGroupByEditorgroup": UserGroup,
      "userGroupByUsergroup": UserGroup,
      "userGroupByReadergroup": UserGroup,
      "userByBy": User,
      "parentSchema": Schema,
      "schemaEdge": SchemataEdge
    }
  }
}

Mutations

`updateSchemaControl`

Updates a single SchemaControl using a unique key and a patch

Returns an UpdateSchemaControlPayload

Name	Description
`input` - `UpdateSchemaControlInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateSchemaControl($input: UpdateSchemaControlInput!) {
  updateSchemaControl(input: $input) {
    clientMutationId
    schemaControl {
      ...SchemaControlFragment
    }
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    schemaControlEdge {
      ...SchemaControlsEdgeFragment
    }
  }
}

Variables

{"input": UpdateSchemaControlInput}

Response

{
  "data": {
    "updateSchemaControl": {
      "clientMutationId": "xyz789",
      "schemaControl": SchemaControl,
      "schema": Schema,
      "userByBy": User,
      "schemaControlEdge": SchemaControlsEdge
    }
  }
}

Mutations

`updateSchemaControlByNodeId`

Updates a single SchemaControl using its globally unique id and a patch

Returns an UpdateSchemaControlPayload

Name	Description
`input` - `UpdateSchemaControlByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateSchemaControlByNodeId($input: UpdateSchemaControlByNodeIdInput!) {
  updateSchemaControlByNodeId(input: $input) {
    clientMutationId
    schemaControl {
      ...SchemaControlFragment
    }
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    schemaControlEdge {
      ...SchemaControlsEdgeFragment
    }
  }
}

Variables

{"input": UpdateSchemaControlByNodeIdInput}

Response

{
  "data": {
    "updateSchemaControlByNodeId": {
      "clientMutationId": "xyz789",
      "schemaControl": SchemaControl,
      "schema": Schema,
      "userByBy": User,
      "schemaControlEdge": SchemaControlsEdge
    }
  }
}

Mutations

`updateSchemaPropertiesById`

true

Update schema properties defaults by their respective ids.

Returns an UpdateSchemaPropertiesByIdPayload

Name	Description
`input` - `UpdateSchemaPropertiesByIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateSchemaPropertiesById($input: UpdateSchemaPropertiesByIdInput!) {
  updateSchemaPropertiesById(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateSchemaPropertiesByIdInput}

Response

{
  "data": {
    "updateSchemaPropertiesById": {
      "clientMutationId": "xyz789",
      "boolean": true
    }
  }
}

Mutations

`updateSchemaPropertiesDefaults`

Update schema properties default values and if value_init set to true, initialise all object properties, derived from this schema, with default values.

Returns an UpdateSchemaPropertiesDefaultsPayload

Name	Description
`input` - `UpdateSchemaPropertiesDefaultsInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateSchemaPropertiesDefaults($input: UpdateSchemaPropertiesDefaultsInput!) {
  updateSchemaPropertiesDefaults(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateSchemaPropertiesDefaultsInput}

Response

{
  "data": {
    "updateSchemaPropertiesDefaults": {
      "clientMutationId": "abc123",
      "boolean": false
    }
  }
}

Mutations

`updateSchemaProperty`

Updates a single SchemaProperty using a unique key and a patch

Returns an UpdateSchemaPropertyPayload

Name	Description
`input` - `UpdateSchemaPropertyInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateSchemaProperty($input: UpdateSchemaPropertyInput!) {
  updateSchemaProperty(input: $input) {
    clientMutationId
    schemaProperty {
      ...SchemaPropertyFragment
    }
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    type {
      ...PropertyTypeFragment
    }
    schemaPropertyEdge {
      ...SchemaPropertiesEdgeFragment
    }
  }
}

Variables

{"input": UpdateSchemaPropertyInput}

Response

{
  "data": {
    "updateSchemaProperty": {
      "clientMutationId": "xyz789",
      "schemaProperty": SchemaProperty,
      "schema": Schema,
      "userByBy": User,
      "type": PropertyType,
      "schemaPropertyEdge": SchemaPropertiesEdge
    }
  }
}

Mutations

`updateSchemaPropertyByNodeId`

Updates a single SchemaProperty using its globally unique id and a patch

Returns an UpdateSchemaPropertyPayload

Name	Description
`input` - `UpdateSchemaPropertyByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateSchemaPropertyByNodeId($input: UpdateSchemaPropertyByNodeIdInput!) {
  updateSchemaPropertyByNodeId(input: $input) {
    clientMutationId
    schemaProperty {
      ...SchemaPropertyFragment
    }
    schema {
      ...SchemaFragment
    }
    userByBy {
      ...UserFragment
    }
    type {
      ...PropertyTypeFragment
    }
    schemaPropertyEdge {
      ...SchemaPropertiesEdgeFragment
    }
  }
}

Variables

{"input": UpdateSchemaPropertyByNodeIdInput}

Response

{
  "data": {
    "updateSchemaPropertyByNodeId": {
      "clientMutationId": "xyz789",
      "schemaProperty": SchemaProperty,
      "schema": Schema,
      "userByBy": User,
      "type": PropertyType,
      "schemaPropertyEdge": SchemaPropertiesEdge
    }
  }
}

Mutations

`updateSchemasBasics`

Update schemas groups and enabled values

Returns an UpdateSchemasBasicsPayload

Name	Description
`input` - `UpdateSchemasBasicsInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateSchemasBasics($input: UpdateSchemasBasicsInput!) {
  updateSchemasBasics(input: $input) {
    clientMutationId
    boolean
  }
}

Variables

{"input": UpdateSchemasBasicsInput}

Response

{
  "data": {
    "updateSchemasBasics": {"clientMutationId": "xyz789", "boolean": true}
  }
}

Mutations

`updateUser`

Updates a single User using a unique key and a patch

Returns an UpdateUserPayload

Name	Description
`input` - `UpdateUserInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUser($input: UpdateUserInput!) {
  updateUser(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": UpdateUserInput}

Response

{
  "data": {
    "updateUser": {
      "clientMutationId": "abc123",
      "user": User,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`updateUserByLogin`

Updates a single User using a unique key and a patch

Returns an UpdateUserPayload

Name	Description
`input` - `UpdateUserByLoginInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUserByLogin($input: UpdateUserByLoginInput!) {
  updateUserByLogin(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": UpdateUserByLoginInput}

Response

{
  "data": {
    "updateUserByLogin": {
      "clientMutationId": "xyz789",
      "user": User,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`updateUserByNodeId`

Updates a single User using its globally unique id and a patch

Returns an UpdateUserPayload

Name	Description
`input` - `UpdateUserByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUserByNodeId($input: UpdateUserByNodeIdInput!) {
  updateUserByNodeId(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
    userGroupByDefaultEditorgroup {
      ...UserGroupFragment
    }
    userGroupByDefaultUsergroup {
      ...UserGroupFragment
    }
    userGroupByDefaultReadergroup {
      ...UserGroupFragment
    }
    userEdge {
      ...UsersEdgeFragment
    }
  }
}

Variables

{"input": UpdateUserByNodeIdInput}

Response

{
  "data": {
    "updateUserByNodeId": {
      "clientMutationId": "xyz789",
      "user": User,
      "userGroupByDefaultEditorgroup": UserGroup,
      "userGroupByDefaultUsergroup": UserGroup,
      "userGroupByDefaultReadergroup": UserGroup,
      "userEdge": UsersEdge
    }
  }
}

Mutations

`updateUserGroup`

Updates a single UserGroup using a unique key and a patch

Returns an UpdateUserGroupPayload

Name	Description
`input` - `UpdateUserGroupInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUserGroup($input: UpdateUserGroupInput!) {
  updateUserGroup(input: $input) {
    clientMutationId
    userGroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    userGroupEdge {
      ...UserGroupsEdgeFragment
    }
  }
}

Variables

{"input": UpdateUserGroupInput}

Response

{
  "data": {
    "updateUserGroup": {
      "clientMutationId": "xyz789",
      "userGroup": UserGroup,
      "userByBy": User,
      "userGroupEdge": UserGroupsEdge
    }
  }
}

Mutations

`updateUserGroupByGroupName`

Updates a single UserGroup using a unique key and a patch

Returns an UpdateUserGroupPayload

Name	Description
`input` - `UpdateUserGroupByGroupNameInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUserGroupByGroupName($input: UpdateUserGroupByGroupNameInput!) {
  updateUserGroupByGroupName(input: $input) {
    clientMutationId
    userGroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    userGroupEdge {
      ...UserGroupsEdgeFragment
    }
  }
}

Variables

{"input": UpdateUserGroupByGroupNameInput}

Response

{
  "data": {
    "updateUserGroupByGroupName": {
      "clientMutationId": "abc123",
      "userGroup": UserGroup,
      "userByBy": User,
      "userGroupEdge": UserGroupsEdge
    }
  }
}

Mutations

`updateUserGroupByNodeId`

Updates a single UserGroup using its globally unique id and a patch

Returns an UpdateUserGroupPayload

Name	Description
`input` - `UpdateUserGroupByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUserGroupByNodeId($input: UpdateUserGroupByNodeIdInput!) {
  updateUserGroupByNodeId(input: $input) {
    clientMutationId
    userGroup {
      ...UserGroupFragment
    }
    userByBy {
      ...UserFragment
    }
    userGroupEdge {
      ...UserGroupsEdgeFragment
    }
  }
}

Variables

{"input": UpdateUserGroupByNodeIdInput}

Response

{
  "data": {
    "updateUserGroupByNodeId": {
      "clientMutationId": "xyz789",
      "userGroup": UserGroup,
      "userByBy": User,
      "userGroupEdge": UserGroupsEdge
    }
  }
}

Mutations

`updateUsersToGroup`

Updates a single UsersToGroup using a unique key and a patch

Returns an UpdateUsersToGroupPayload

Name	Description
`input` - `UpdateUsersToGroupInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUsersToGroup($input: UpdateUsersToGroupInput!) {
  updateUsersToGroup(input: $input) {
    clientMutationId
    usersToGroup {
      ...UsersToGroupFragment
    }
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
    usersToGroupEdge {
      ...UsersToGroupsEdgeFragment
    }
  }
}

Variables

{"input": UpdateUsersToGroupInput}

Response

{
  "data": {
    "updateUsersToGroup": {
      "clientMutationId": "xyz789",
      "usersToGroup": UsersToGroup,
      "user": User,
      "userGroup": UserGroup,
      "usersToGroupEdge": UsersToGroupsEdge
    }
  }
}

Mutations

`updateUsersToGroupByNodeId`

Updates a single UsersToGroup using its globally unique id and a patch

Returns an UpdateUsersToGroupPayload

Name	Description
`input` - `UpdateUsersToGroupByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUsersToGroupByNodeId($input: UpdateUsersToGroupByNodeIdInput!) {
  updateUsersToGroupByNodeId(input: $input) {
    clientMutationId
    usersToGroup {
      ...UsersToGroupFragment
    }
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
    usersToGroupEdge {
      ...UsersToGroupsEdgeFragment
    }
  }
}

Variables

{"input": UpdateUsersToGroupByNodeIdInput}

Response

{
  "data": {
    "updateUsersToGroupByNodeId": {
      "clientMutationId": "abc123",
      "usersToGroup": UsersToGroup,
      "user": User,
      "userGroup": UserGroup,
      "usersToGroupEdge": UsersToGroupsEdge
    }
  }
}

Mutations

`updateUsersToGroupByUserIdAndUserGroupId`

Updates a single UsersToGroup using a unique key and a patch

Returns an UpdateUsersToGroupPayload

Name	Description
`input` - `UpdateUsersToGroupByUserIdAndUserGroupIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUsersToGroupByUserIdAndUserGroupId($input: UpdateUsersToGroupByUserIdAndUserGroupIdInput!) {
  updateUsersToGroupByUserIdAndUserGroupId(input: $input) {
    clientMutationId
    usersToGroup {
      ...UsersToGroupFragment
    }
    user {
      ...UserFragment
    }
    userGroup {
      ...UserGroupFragment
    }
    usersToGroupEdge {
      ...UsersToGroupsEdgeFragment
    }
  }
}

Variables

{"input": UpdateUsersToGroupByUserIdAndUserGroupIdInput}

Response

{
  "data": {
    "updateUsersToGroupByUserIdAndUserGroupId": {
      "clientMutationId": "abc123",
      "usersToGroup": UsersToGroup,
      "user": User,
      "userGroup": UserGroup,
      "usersToGroupEdge": UsersToGroupsEdge
    }
  }
}

Mutations

`updateUsersToObject`

Updates a single UsersToObject using a unique key and a patch

Returns an UpdateUsersToObjectPayload

Name	Description
`input` - `UpdateUsersToObjectInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUsersToObject($input: UpdateUsersToObjectInput!) {
  updateUsersToObject(input: $input) {
    clientMutationId
    usersToObject {
      ...UsersToObjectFragment
    }
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
    usersToObjectEdge {
      ...UsersToObjectsEdgeFragment
    }
  }
}

Variables

{"input": UpdateUsersToObjectInput}

Response

{
  "data": {
    "updateUsersToObject": {
      "clientMutationId": "abc123",
      "usersToObject": UsersToObject,
      "user": User,
      "object": Object,
      "usersToObjectEdge": UsersToObjectsEdge
    }
  }
}

Mutations

`updateUsersToObjectByNodeId`

Updates a single UsersToObject using its globally unique id and a patch

Returns an UpdateUsersToObjectPayload

Name	Description
`input` - `UpdateUsersToObjectByNodeIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUsersToObjectByNodeId($input: UpdateUsersToObjectByNodeIdInput!) {
  updateUsersToObjectByNodeId(input: $input) {
    clientMutationId
    usersToObject {
      ...UsersToObjectFragment
    }
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
    usersToObjectEdge {
      ...UsersToObjectsEdgeFragment
    }
  }
}

Variables

{"input": UpdateUsersToObjectByNodeIdInput}

Response

{
  "data": {
    "updateUsersToObjectByNodeId": {
      "clientMutationId": "xyz789",
      "usersToObject": UsersToObject,
      "user": User,
      "object": Object,
      "usersToObjectEdge": UsersToObjectsEdge
    }
  }
}

Mutations

`updateUsersToObjectByUserIdAndObjectId`

Updates a single UsersToObject using a unique key and a patch

Returns an UpdateUsersToObjectPayload

Name	Description
`input` - `UpdateUsersToObjectByUserIdAndObjectIdInput!`	The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields

Example

Query

mutation updateUsersToObjectByUserIdAndObjectId($input: UpdateUsersToObjectByUserIdAndObjectIdInput!) {
  updateUsersToObjectByUserIdAndObjectId(input: $input) {
    clientMutationId
    usersToObject {
      ...UsersToObjectFragment
    }
    user {
      ...UserFragment
    }
    object {
      ...ObjectFragment
    }
    usersToObjectEdge {
      ...UsersToObjectsEdgeFragment
    }
  }
}

Variables

{"input": UpdateUsersToObjectByUserIdAndObjectIdInput}

Response

{
  "data": {
    "updateUsersToObjectByUserIdAndObjectId": {
      "clientMutationId": "abc123",
      "usersToObject": UsersToObject,
      "user": User,
      "object": Object,
      "usersToObjectEdge": UsersToObjectsEdge
    }
  }
}

Types

`AccessRight`

Field Name	Description
`edit` - `Boolean`
`use` - `Boolean`
`read` - `Boolean`

Example

{"edit": true, "use": false, "read": true}

Types

`AuthAccessTokenInput`

All input for the authAccessToken mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`userRefreshToken` - `String`
`profileTags` - `[String]`
`accessTokenExpiration` - `Int`
`otp` - `String`

Example

{
  "clientMutationId": "abc123",
  "userRefreshToken": "abc123",
  "profileTags": ["xyz789"],
  "accessTokenExpiration": 123,
  "otp": "xyz789"
}

Types

`AuthAccessTokenPayload`

The output of our authAccessToken mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`jwtToken` - `JwtToken`

Example

{"clientMutationId": "abc123", "jwtToken": JwtToken}

Types

`AuthRefreshTokenInput`

All input for the authRefreshToken mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`userLogin` - `String`
`userPassword` - `String`

Example

{"clientMutationId": "abc123", "userLogin": "xyz789", "userPassword": "xyz789"}

Types

`AuthRefreshTokenPayload`

The output of our authRefreshToken mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`refreshToken` - `RefreshToken`

Example

{
  "clientMutationId": "abc123",
  "refreshToken": RefreshToken
}

Types

`BigInt`

A signed eight-byte integer. The upper big integer values are greater than the max value for a JavaScript number. Therefore all big integers will be output as strings and not numbers.

Example

object

Types

`BigIntFilter`

A filter to be used against BigInt fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `BigInt`	Equal to the specified value.
`notEqualTo` - `BigInt`	Not equal to the specified value.
`distinctFrom` - `BigInt`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `BigInt`	Equal to the specified value, treating null like an ordinary value.
`in` - `[BigInt!]`	Included in the specified list.
`notIn` - `[BigInt!]`	Not included in the specified list.
`lessThan` - `BigInt`	Less than the specified value.
`lessThanOrEqualTo` - `BigInt`	Less than or equal to the specified value.
`greaterThan` - `BigInt`	Greater than the specified value.
`greaterThanOrEqualTo` - `BigInt`	Greater than or equal to the specified value.

Example

{
  "isNull": true,
  "equalTo": BigInt,
  "notEqualTo": BigInt,
  "distinctFrom": BigInt,
  "notDistinctFrom": BigInt,
  "in": [BigInt],
  "notIn": [BigInt],
  "lessThan": BigInt,
  "lessThanOrEqualTo": BigInt,
  "greaterThan": BigInt,
  "greaterThanOrEqualTo": BigInt
}

Types

`Boolean`

The Boolean scalar type represents true or false.

Example

false

Types

`BooleanFilter`

A filter to be used against Boolean fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `Boolean`	Equal to the specified value.
`notEqualTo` - `Boolean`	Not equal to the specified value.
`distinctFrom` - `Boolean`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `Boolean`	Equal to the specified value, treating null like an ordinary value.
`in` - `[Boolean!]`	Included in the specified list.
`notIn` - `[Boolean!]`	Not included in the specified list.
`lessThan` - `Boolean`	Less than the specified value.
`lessThanOrEqualTo` - `Boolean`	Less than or equal to the specified value.
`greaterThan` - `Boolean`	Greater than the specified value.
`greaterThanOrEqualTo` - `Boolean`	Greater than or equal to the specified value.

Example

{
  "isNull": true,
  "equalTo": true,
  "notEqualTo": true,
  "distinctFrom": false,
  "notDistinctFrom": false,
  "in": [true],
  "notIn": [true],
  "lessThan": false,
  "lessThanOrEqualTo": true,
  "greaterThan": true,
  "greaterThanOrEqualTo": false
}

Types

`BumpSchemaVersionInput`

All input for the bumpSchemaVersion mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`schemas` - `[UUID]`

Example

{"clientMutationId": "xyz789", "schemas": [UUID]}

Types

`BumpSchemaVersionPayload`

The output of our bumpSchemaVersion mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "abc123", "boolean": false}

Types

`ControlExecution`

Control Execution is a data type that is used to represent an individual RPC/Control call event or RPC/Report feedback. It is used to provide communication interface between RPC/Control caller and RPC/Control execution module.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `Int!`	Control Execution unique ID.
`objectId` - `UUID!`	Object ID related to this Control Execution.
`controller` - `UUID`	Controller ID (User of type APP) responsible for the execution of this Control.
`createdAt` - `Datetime!`	Timestamp of Control Execution start.
`type` - `ControlTypes`	Type of Control Execution record (RPC/REPORT/STEALTH).
`name` - `String!`	Name of the RPC/Control being called or name of the Report provided by Controller.
`params` - `JSON!`	Parameters for RPC/Control being called or Report details provided by Controller.
`ack` - `Boolean`	Indicated if RPC/Control was Acknowledged by Controller or not.
`done` - `Boolean`	If Type is RPC then indicates if the execution of RPC/Control is finished or not. If Type is REPORT then indicates if this Report is final for related RPC/Control (linked_control_id).
`error` - `String`	If Type is RPC indicates if execution has finished with error. If Type is REPORT indicates if this Report is regarding an error.
`linkedControlId` - `BigInt`	If Type is REPORT contains related RPC/Control Execution uuid for it.
`callerId` - `UUID`	Caller ID of the RPC/Control Execution or Controller ID for REPORT.
`helperParams` - `JSON`
`object` - `Object`	Reads a single `Object` that is related to this `ControlExecution`.
`caller` - `User`	Reads a single `User` that is related to this `ControlExecution`.

Example

{
  "nodeId": ID,
  "id": 987,
  "objectId": UUID,
  "controller": UUID,
  "createdAt": Datetime,
  "type": ControlTypes,
  "name": "xyz789",
  "params": {},
  "ack": false,
  "done": false,
  "error": "xyz789",
  "linkedControlId": BigInt,
  "callerId": UUID,
  "helperParams": {},
  "object": Object,
  "caller": User
}

Types

`ControlExecutionCondition`

A condition to be used against ControlExecution object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`id` - `Int`	Checks for equality with the object’s `id` field.
`objectId` - `UUID`	Checks for equality with the object’s `objectId` field.
`controller` - `UUID`	Checks for equality with the object’s `controller` field.
`createdAt` - `Datetime`	Checks for equality with the object’s `createdAt` field.
`type` - `ControlTypes`	Checks for equality with the object’s `type` field.
`name` - `String`	Checks for equality with the object’s `name` field.
`params` - `JSON`	Checks for equality with the object’s `params` field.
`ack` - `Boolean`	Checks for equality with the object’s `ack` field.
`done` - `Boolean`	Checks for equality with the object’s `done` field.
`error` - `String`	Checks for equality with the object’s `error` field.
`linkedControlId` - `BigInt`	Checks for equality with the object’s `linkedControlId` field.
`callerId` - `UUID`	Checks for equality with the object’s `callerId` field.
`helperParams` - `JSON`	Checks for equality with the object’s `helperParams` field.

Example

{
  "id": 123,
  "objectId": UUID,
  "controller": UUID,
  "createdAt": Datetime,
  "type": ControlTypes,
  "name": "abc123",
  "params": {},
  "ack": false,
  "done": false,
  "error": "xyz789",
  "linkedControlId": BigInt,
  "callerId": UUID,
  "helperParams": {}
}

Types

`ControlExecutionFilter`

A filter to be used against ControlExecution object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `IntFilter`	Filter by the object’s `id` field.
`objectId` - `UUIDFilter`	Filter by the object’s `objectId` field.
`controller` - `UUIDFilter`	Filter by the object’s `controller` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`type` - `ControlTypesFilter`	Filter by the object’s `type` field.
`name` - `StringFilter`	Filter by the object’s `name` field.
`ack` - `BooleanFilter`	Filter by the object’s `ack` field.
`done` - `BooleanFilter`	Filter by the object’s `done` field.
`error` - `StringFilter`	Filter by the object’s `error` field.
`linkedControlId` - `BigIntFilter`	Filter by the object’s `linkedControlId` field.
`callerId` - `UUIDFilter`	Filter by the object’s `callerId` field.
`helperParams` - `JSONFilter`	Filter by the object’s `helperParams` field.
`object` - `ObjectFilter`	Filter by the object’s `object` relation.
`objectExists` - `Boolean`	A related `object` exists.
`caller` - `UserFilter`	Filter by the object’s `caller` relation.
`callerExists` - `Boolean`	A related `caller` exists.
`and` - `[ControlExecutionFilter!]`	Checks for all expressions in this list.
`or` - `[ControlExecutionFilter!]`	Checks for any expressions in this list.
`not` - `ControlExecutionFilter`	Negates the expression.

Example

{
  "id": IntFilter,
  "objectId": UUIDFilter,
  "controller": UUIDFilter,
  "createdAt": DatetimeFilter,
  "type": ControlTypesFilter,
  "name": StringFilter,
  "ack": BooleanFilter,
  "done": BooleanFilter,
  "error": StringFilter,
  "linkedControlId": BigIntFilter,
  "callerId": UUIDFilter,
  "helperParams": JSONFilter,
  "object": ObjectFilter,
  "objectExists": false,
  "caller": UserFilter,
  "callerExists": true,
  "and": [ControlExecutionFilter],
  "or": [ControlExecutionFilter],
  "not": ControlExecutionFilter
}

Types

`ControlExecutionInput`

An input for mutations affecting ControlExecution

Input Field	Description
`objectId` - `UUID!`	Object ID related to this Control Execution.
`controller` - `UUID`	Controller ID (User of type APP) responsible for the execution of this Control.
`name` - `String!`	Name of the RPC/Control being called or name of the Report provided by Controller.
`params` - `JSON!`	Parameters for RPC/Control being called or Report details provided by Controller.
`linkedControlId` - `BigInt`	If Type is REPORT contains related RPC/Control Execution uuid for it.
`helperParams` - `JSON`

Example

{
  "objectId": UUID,
  "controller": UUID,
  "name": "abc123",
  "params": {},
  "linkedControlId": BigInt,
  "helperParams": {}
}

Types

`ControlExecutionsConnection`

A connection to a list of ControlExecution values.

Field Name	Description
`nodes` - `[ControlExecution]!`	A list of `ControlExecution` objects.
`edges` - `[ControlExecutionsEdge!]!`	A list of edges which contains the `ControlExecution` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `ControlExecution` you could get from the connection.

Example

{
  "nodes": [ControlExecution],
  "edges": [ControlExecutionsEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`ControlExecutionsEdge`

A ControlExecution edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `ControlExecution`	The `ControlExecution` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": ControlExecution
}

Types

`ControlExecutionsOrderBy`

Methods to use when ordering ControlExecution.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`OBJECT_ID_ASC`
`OBJECT_ID_DESC`
`CONTROLLER_ASC`
`CONTROLLER_DESC`
`CREATED_AT_ASC`
`CREATED_AT_DESC`
`TYPE_ASC`
`TYPE_DESC`
`NAME_ASC`
`NAME_DESC`
`PARAMS_ASC`
`PARAMS_DESC`
`ACK_ASC`
`ACK_DESC`
`DONE_ASC`
`DONE_DESC`
`ERROR_ASC`
`ERROR_DESC`
`LINKED_CONTROL_ID_ASC`
`LINKED_CONTROL_ID_DESC`
`CALLER_ID_ASC`
`CALLER_ID_DESC`
`HELPER_PARAMS_ASC`
`HELPER_PARAMS_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`ControlExecutionsSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `ControlExecutionsSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": ControlExecutionsSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`ControlExecutionsSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `ControlExecutionsSortableField`

Example

{"field": ControlExecutionsSortableField}

Types

`ControlExecutionsSortableField`

Sortable concrete fields for the ControlExecution type.

Enum Value	Description
`ID`
`OBJECT_ID`
`CONTROLLER`
`CREATED_AT`
`TYPE`
`NAME`
`PARAMS`
`ACK`
`DONE`
`ERROR`
`LINKED_CONTROL_ID`
`CALLER_ID`
`HELPER_PARAMS`

Types

`ControlTypes`

Enum Value	Description
`REPORT`
`RPC`
`RPC_STEALTH`

Types

`ControlTypesFilter`

A filter to be used against ControlTypes fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `ControlTypes`	Equal to the specified value.
`notEqualTo` - `ControlTypes`	Not equal to the specified value.
`distinctFrom` - `ControlTypes`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `ControlTypes`	Equal to the specified value, treating null like an ordinary value.
`in` - `[ControlTypes!]`	Included in the specified list.
`notIn` - `[ControlTypes!]`	Not included in the specified list.
`lessThan` - `ControlTypes`	Less than the specified value.
`lessThanOrEqualTo` - `ControlTypes`	Less than or equal to the specified value.
`greaterThan` - `ControlTypes`	Greater than the specified value.
`greaterThanOrEqualTo` - `ControlTypes`	Greater than or equal to the specified value.

Example

{
  "isNull": false,
  "equalTo": ControlTypes,
  "notEqualTo": ControlTypes,
  "distinctFrom": ControlTypes,
  "notDistinctFrom": ControlTypes,
  "in": [ControlTypes],
  "notIn": [ControlTypes],
  "lessThan": ControlTypes,
  "lessThanOrEqualTo": ControlTypes,
  "greaterThan": ControlTypes,
  "greaterThanOrEqualTo": ControlTypes
}

Types

`CreateControlExecutionInput`

All input for the create ControlExecution mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`controlExecution` - `ControlExecutionInput!`	The `ControlExecution` to be created by this mutation.

Example

{
  "clientMutationId": "abc123",
  "controlExecution": ControlExecutionInput
}

Types

`CreateControlExecutionPayload`

The output of our create ControlExecution mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`controlExecution` - `ControlExecution`	The `ControlExecution` that was created by this mutation.
`object` - `Object`	Reads a single `Object` that is related to this `ControlExecution`.
`caller` - `User`	Reads a single `User` that is related to this `ControlExecution`.
`controlExecutionEdge` - `ControlExecutionsEdge`	An edge for our `ControlExecution`. May be used by Relay 1.
Arguments `orderBy` - `[ControlExecutionsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ControlExecution`.

Example

{
  "clientMutationId": "abc123",
  "controlExecution": ControlExecution,
  "object": Object,
  "caller": User,
  "controlExecutionEdge": ControlExecutionsEdge
}

Types

`CreateControlExecutionReportInput`

All input for the createControlExecutionReport mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`linkedControlId` - `Int!`
`report` - `String!`
`reportDetails` - `JSON!`
`done` - `Boolean!`
`error` - `Boolean!`

Example

{
  "clientMutationId": "xyz789",
  "linkedControlId": 123,
  "report": "xyz789",
  "reportDetails": {},
  "done": true,
  "error": true
}

Types

`CreateControlExecutionReportPayload`

The output of our createControlExecutionReport mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`integer` - `Int`

Example

{"clientMutationId": "xyz789", "integer": 987}

Types

`CreateControlExecutionStealthByPropertyValueInput`

Input Field	Description
`groupName` - `String!`
`property` - `String!`
`value` - `JSON!`
`name` - `String!`
`params` - `JSON!`
`enrichWith` - `[Property2Input!]!`

Example

{
  "groupName": "abc123",
  "property": "abc123",
  "value": {},
  "name": "abc123",
  "params": {},
  "enrichWith": [Property2Input]
}

Types

`CreateControlExecutionStealthByPropertyValuePayload`

Field Name	Description
`clientMutationId` - `String`
`boolean` - `Boolean`

Example

{"clientMutationId": "abc123", "boolean": false}

Types

`CreateControlExecutionStealthInput`

All input for the createControlExecutionStealth mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectId` - `UUID!`
`name` - `String!`
`params` - `JSON!`

Example

{
  "clientMutationId": "abc123",
  "objectId": UUID,
  "name": "abc123",
  "params": {}
}

Types

`CreateControlExecutionStealthPayload`

The output of our createControlExecutionStealth mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "xyz789", "boolean": true}

Types

`CreateControlExecutionSyncInput`

All input for the createControlExecutionSync mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectId` - `UUID!`
`name` - `String!`
`params` - `JSON!`
`timeout` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "objectId": UUID,
  "name": "abc123",
  "params": {},
  "timeout": 987
}

Types

`CreateControlExecutionSyncPayload`

The output of our createControlExecutionSync mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`rpcResult` - `RpcResult`

Example

{"clientMutationId": "xyz789", "rpcResult": RpcResult}

Types

`CreateNotificationDeliveryInput`

All input for the create NotificationDelivery mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`notificationDelivery` - `NotificationDeliveryInput!`	The `NotificationDelivery` to be created by this mutation.

Example

{
  "clientMutationId": "abc123",
  "notificationDelivery": NotificationDeliveryInput
}

Types

`CreateNotificationDeliveryPayload`

The output of our create NotificationDelivery mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`notificationDelivery` - `NotificationDelivery`	The `NotificationDelivery` that was created by this mutation.
`userByUser` - `User`	Reads a single `User` that is related to this `NotificationDelivery`.
`deliveryConfig` - `Object`	Reads a single `Object` that is related to this `NotificationDelivery`.
`notification` - `Notification`	Reads a single `Notification` that is related to this `NotificationDelivery`.
`notificationDeliveryEdge` - `NotificationDeliveriesEdge`	An edge for our `NotificationDelivery`. May be used by Relay 1.
Arguments `orderBy` - `[NotificationDeliveriesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `NotificationDelivery`.

Example

{
  "clientMutationId": "abc123",
  "notificationDelivery": NotificationDelivery,
  "userByUser": User,
  "deliveryConfig": Object,
  "notification": Notification,
  "notificationDeliveryEdge": NotificationDeliveriesEdge
}

Types

`CreateNotificationInput`

All input for the create Notification mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`notification` - `NotificationInput!`	The `Notification` to be created by this mutation.

Example

{
  "clientMutationId": "xyz789",
  "notification": NotificationInput
}

Types

`CreateNotificationPayload`

The output of our create Notification mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`notification` - `Notification`	The `Notification` that was created by this mutation.
`object` - `Object`	Reads a single `Object` that is related to this `Notification`.
`userByBy` - `User`	Reads a single `User` that is related to this `Notification`.
`notificationEdge` - `NotificationsEdge`	An edge for our `Notification`. May be used by Relay 1.
Arguments `orderBy` - `[NotificationsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Notification`.

Example

{
  "clientMutationId": "xyz789",
  "notification": Notification,
  "object": Object,
  "userByBy": User,
  "notificationEdge": NotificationsEdge
}

Types

`CreateObjectCopyInput`

All input for the createObjectCopy mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectId` - `UUID`
`newObjectName` - `String`
`copyObjectLinks` - `Boolean`
`copyPropertyLinks` - `Boolean`
`newObjectDescription` - `String`
`newObjectTags` - `[String]`
`overrideProperties` - `[PropertyByNameInput]`

Example

{
  "clientMutationId": "abc123",
  "objectId": UUID,
  "newObjectName": "xyz789",
  "copyObjectLinks": false,
  "copyPropertyLinks": true,
  "newObjectDescription": "xyz789",
  "newObjectTags": ["abc123"],
  "overrideProperties": [PropertyByNameInput]
}

Types

`CreateObjectCopyPayload`

The output of our createObjectCopy mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`uuid` - `UUID`

Example

{"clientMutationId": "abc123", "uuid": UUID}

Types

`CreateObjectInput`

All input for the create Object mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`object` - `ObjectInput!`	The `Object` to be created by this mutation.

Example

{"clientMutationId": "xyz789", "object": ObjectInput}

Types

`CreateObjectPayload`

The output of our create Object mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`object` - `Object`	The `Object` that was created by this mutation.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userByBy` - `User`	Reads a single `User` that is related to this `Object`.
`schema` - `Schema`	Reads a single `Schema` that is related to this `Object`.
`objectEdge` - `ObjectsEdge`	An edge for our `Object`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`.

Example

{
  "clientMutationId": "xyz789",
  "object": Object,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "schema": Schema,
  "objectEdge": ObjectsEdge
}

Types

`CreateObjectPropertiesHistoryInput`

All input for the create ObjectPropertiesHistory mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectPropertiesHistory` - `ObjectPropertiesHistoryInput!`	The `ObjectPropertiesHistory` to be created by this mutation.

Example

{
  "clientMutationId": "xyz789",
  "objectPropertiesHistory": ObjectPropertiesHistoryInput
}

Types

`CreateObjectPropertiesHistoryPayload`

The output of our create ObjectPropertiesHistory mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`objectPropertiesHistory` - `ObjectPropertiesHistory`	The `ObjectPropertiesHistory` that was created by this mutation.
`userByBy` - `User`	Reads a single `User` that is related to this `ObjectPropertiesHistory`.
`objectPropertiesHistoryEdge` - `ObjectPropertiesHistoriesEdge`	An edge for our `ObjectPropertiesHistory`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectPropertiesHistoriesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectPropertiesHistory`.

Example

{
  "clientMutationId": "xyz789",
  "objectPropertiesHistory": ObjectPropertiesHistory,
  "userByBy": User,
  "objectPropertiesHistoryEdge": ObjectPropertiesHistoriesEdge
}

Types

`CreateObjectWithPropertiesInput`

All input for the createObjectWithProperties mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`name` - `String`
`enabled` - `Boolean`
`description` - `String`
`editorGroup` - `UUID`
`userGroup` - `UUID`
`readerGroup` - `UUID`
`schemaId` - `UUID`
`schemaTags` - `[String]`
`properties` - `[PropertyByNameInput]`
`keyedProperties` - `[PropertyByKeyInput]`
`parents` - `[UUID]`
`childs` - `[UUID]`
`userProfile` - `UUID`
`propertiesLinks` - `[PropertyLinkInput]`

Example

{
  "clientMutationId": "abc123",
  "name": "abc123",
  "enabled": false,
  "description": "xyz789",
  "editorGroup": UUID,
  "userGroup": UUID,
  "readerGroup": UUID,
  "schemaId": UUID,
  "schemaTags": ["abc123"],
  "properties": [PropertyByNameInput],
  "keyedProperties": [PropertyByKeyInput],
  "parents": [UUID],
  "childs": [UUID],
  "userProfile": UUID,
  "propertiesLinks": [PropertyLinkInput]
}

Types

`CreateObjectWithPropertiesPayload`

The output of our createObjectWithProperties mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`uuid` - `UUID`

Example

{"clientMutationId": "xyz789", "uuid": UUID}

Types

`CreateObjectsToObjectInput`

All input for the create ObjectsToObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectsToObject` - `ObjectsToObjectInput!`	The `ObjectsToObject` to be created by this mutation.

Example

{
  "clientMutationId": "abc123",
  "objectsToObject": ObjectsToObjectInput
}

Types

`CreateObjectsToObjectPayload`

The output of our create ObjectsToObject mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`objectsToObject` - `ObjectsToObject`	The `ObjectsToObject` that was created by this mutation.
`object1` - `Object`	Reads a single `Object` that is related to this `ObjectsToObject`.
`object2` - `Object`	Reads a single `Object` that is related to this `ObjectsToObject`.
`objectsToObjectEdge` - `ObjectsToObjectsEdge`	An edge for our `ObjectsToObject`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectsToObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectsToObject`.

Example

{
  "clientMutationId": "xyz789",
  "objectsToObject": ObjectsToObject,
  "object1": Object,
  "object2": Object,
  "objectsToObjectEdge": ObjectsToObjectsEdge
}

Types

`CreateObjectsToObjectsInput`

All input for the createObjectsToObjects mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`sourceIds` - `[UUID]`
`destinationIds` - `[UUID]`

Example

{
  "clientMutationId": "abc123",
  "sourceIds": [UUID],
  "destinationIds": [UUID]
}

Types

`CreateObjectsToObjectsPayload`

The output of our createObjectsToObjects mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`integer` - `Int`

Example

{"clientMutationId": "abc123", "integer": 123}

Types

`CreatePropertyTypeInput`

All input for the create PropertyType mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`propertyType` - `PropertyTypeInput!`	The `PropertyType` to be created by this mutation.

Example

{
  "clientMutationId": "xyz789",
  "propertyType": PropertyTypeInput
}

Types

`CreatePropertyTypePayload`

The output of our create PropertyType mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`propertyType` - `PropertyType`	The `PropertyType` that was created by this mutation.
`propertyTypeEdge` - `PropertyTypesEdge`	An edge for our `PropertyType`. May be used by Relay 1.
Arguments `orderBy` - `[PropertyTypesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `PropertyType`.

Example

{
  "clientMutationId": "abc123",
  "propertyType": PropertyType,
  "propertyTypeEdge": PropertyTypesEdge
}

Types

`CreateSchemaControlInput`

All input for the create SchemaControl mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`schemaControl` - `SchemaControlInput!`	The `SchemaControl` to be created by this mutation.

Example

{
  "clientMutationId": "abc123",
  "schemaControl": SchemaControlInput
}

Types

`CreateSchemaControlPayload`

The output of our create SchemaControl mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schemaControl` - `SchemaControl`	The `SchemaControl` that was created by this mutation.
`schema` - `Schema`	Reads a single `Schema` that is related to this `SchemaControl`.
`userByBy` - `User`	Reads a single `User` that is related to this `SchemaControl`.
`schemaControlEdge` - `SchemaControlsEdge`	An edge for our `SchemaControl`. May be used by Relay 1.
Arguments `orderBy` - `[SchemaControlsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaControl`.

Example

{
  "clientMutationId": "abc123",
  "schemaControl": SchemaControl,
  "schema": Schema,
  "userByBy": User,
  "schemaControlEdge": SchemaControlsEdge
}

Types

`CreateSchemaCopyInput`

All input for the createSchemaCopy mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`schemaId` - `UUID`
`newSchemaName` - `String`
`newSchemaDescription` - `String`
`newSchemaTags` - `[String]`
`linkToSchemaId` - `UUID`

Example

{
  "clientMutationId": "xyz789",
  "schemaId": UUID,
  "newSchemaName": "xyz789",
  "newSchemaDescription": "xyz789",
  "newSchemaTags": ["xyz789"],
  "linkToSchemaId": UUID
}

Types

`CreateSchemaCopyPayload`

The output of our createSchemaCopy mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`uuid` - `UUID`

Example

{"clientMutationId": "abc123", "uuid": UUID}

Types

`CreateSchemaInput`

All input for the create Schema mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`schema` - `SchemaInput!`	The `Schema` to be created by this mutation.

Example

{"clientMutationId": "abc123", "schema": SchemaInput}

Types

`CreateSchemaPayload`

The output of our create Schema mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schema` - `Schema`	The `Schema` that was created by this mutation.
`userByApplicationOwner` - `User`	Reads a single `User` that is related to this `Schema`.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userByBy` - `User`	Reads a single `User` that is related to this `Schema`.
`parentSchema` - `Schema`	Reads a single `Schema` that is related to this `Schema`.
`schemaEdge` - `SchemataEdge`	An edge for our `Schema`. May be used by Relay 1.
Arguments `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`.

Example

{
  "clientMutationId": "xyz789",
  "schema": Schema,
  "userByApplicationOwner": User,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "parentSchema": Schema,
  "schemaEdge": SchemataEdge
}

Types

`CreateSchemaPropertyInput`

All input for the create SchemaProperty mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`schemaProperty` - `SchemaPropertyInput!`	The `SchemaProperty` to be created by this mutation.

Example

{
  "clientMutationId": "xyz789",
  "schemaProperty": SchemaPropertyInput
}

Types

`CreateSchemaPropertyPayload`

The output of our create SchemaProperty mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schemaProperty` - `SchemaProperty`	The `SchemaProperty` that was created by this mutation.
`schema` - `Schema`	Reads a single `Schema` that is related to this `SchemaProperty`.
`userByBy` - `User`	Reads a single `User` that is related to this `SchemaProperty`.
`type` - `PropertyType`	Reads a single `PropertyType` that is related to this `SchemaProperty`.
`schemaPropertyEdge` - `SchemaPropertiesEdge`	An edge for our `SchemaProperty`. May be used by Relay 1.
Arguments `orderBy` - `[SchemaPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaProperty`.

Example

{
  "clientMutationId": "xyz789",
  "schemaProperty": SchemaProperty,
  "schema": Schema,
  "userByBy": User,
  "type": PropertyType,
  "schemaPropertyEdge": SchemaPropertiesEdge
}

Types

`CreateTranslationInput`

All input for the create Translation mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`translation` - `TranslationInput!`	The `Translation` to be created by this mutation.

Example

{
  "clientMutationId": "xyz789",
  "translation": TranslationInput
}

Types

`CreateTranslationPayload`

The output of our create Translation mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`translation` - `Translation`	The `Translation` that was created by this mutation.
`translationEdge` - `TranslationsEdge`	An edge for our `Translation`. May be used by Relay 1.
Arguments `orderBy` - `[TranslationsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Translation`.

Example

{
  "clientMutationId": "abc123",
  "translation": Translation,
  "translationEdge": TranslationsEdge
}

Types

`CreateUserGroupInput`

All input for the create UserGroup mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`userGroup` - `UserGroupInput!`	The `UserGroup` to be created by this mutation.

Example

{
  "clientMutationId": "xyz789",
  "userGroup": UserGroupInput
}

Types

`CreateUserGroupPayload`

The output of our create UserGroup mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`userGroup` - `UserGroup`	The `UserGroup` that was created by this mutation.
`userByBy` - `User`	Reads a single `User` that is related to this `UserGroup`.
`userGroupEdge` - `UserGroupsEdge`	An edge for our `UserGroup`. May be used by Relay 1.
Arguments `orderBy` - `[UserGroupsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UserGroup`.

Example

{
  "clientMutationId": "abc123",
  "userGroup": UserGroup,
  "userByBy": User,
  "userGroupEdge": UserGroupsEdge
}

Types

`CreateUserInput`

All input for the create User mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`user` - `UserInput!`	The `User` to be created by this mutation.

Example

{"clientMutationId": "abc123", "user": UserInput}

Types

`CreateUserPayload`

The output of our create User mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`user` - `User`	The `User` that was created by this mutation.
`userGroupByDefaultEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userEdge` - `UsersEdge`	An edge for our `User`. May be used by Relay 1.
Arguments `orderBy` - `[UsersOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `User`.

Example

{
  "clientMutationId": "abc123",
  "user": User,
  "userGroupByDefaultEditorgroup": UserGroup,
  "userGroupByDefaultUsergroup": UserGroup,
  "userGroupByDefaultReadergroup": UserGroup,
  "userEdge": UsersEdge
}

Types

`CreateUsersToGroupInput`

All input for the create UsersToGroup mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`usersToGroup` - `UsersToGroupInput!`	The `UsersToGroup` to be created by this mutation.

Example

{
  "clientMutationId": "abc123",
  "usersToGroup": UsersToGroupInput
}

Types

`CreateUsersToGroupPayload`

The output of our create UsersToGroup mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`usersToGroup` - `UsersToGroup`	The `UsersToGroup` that was created by this mutation.
`user` - `User`	Reads a single `User` that is related to this `UsersToGroup`.
`userGroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `UsersToGroup`.
`usersToGroupEdge` - `UsersToGroupsEdge`	An edge for our `UsersToGroup`. May be used by Relay 1.
Arguments `orderBy` - `[UsersToGroupsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToGroup`.

Example

{
  "clientMutationId": "abc123",
  "usersToGroup": UsersToGroup,
  "user": User,
  "userGroup": UserGroup,
  "usersToGroupEdge": UsersToGroupsEdge
}

Types

`CreateUsersToObjectInput`

All input for the create UsersToObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`usersToObject` - `UsersToObjectInput!`	The `UsersToObject` to be created by this mutation.

Example

{
  "clientMutationId": "xyz789",
  "usersToObject": UsersToObjectInput
}

Types

`CreateUsersToObjectPayload`

The output of our create UsersToObject mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`usersToObject` - `UsersToObject`	The `UsersToObject` that was created by this mutation.
`user` - `User`	Reads a single `User` that is related to this `UsersToObject`.
`object` - `Object`	Reads a single `Object` that is related to this `UsersToObject`.
`usersToObjectEdge` - `UsersToObjectsEdge`	An edge for our `UsersToObject`. May be used by Relay 1.
Arguments `orderBy` - `[UsersToObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToObject`.

Example

{
  "clientMutationId": "abc123",
  "usersToObject": UsersToObject,
  "user": User,
  "object": Object,
  "usersToObjectEdge": UsersToObjectsEdge
}

Types

`Cursor`

A location in a connection that can be used for resuming pagination.

Example

object

Types

`Datetime`

A point in time as described by the ISO 8601 standard. May or may not include a timezone.

Example

object

Types

`DatetimeFilter`

A filter to be used against Datetime fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `Datetime`	Equal to the specified value.
`notEqualTo` - `Datetime`	Not equal to the specified value.
`distinctFrom` - `Datetime`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `Datetime`	Equal to the specified value, treating null like an ordinary value.
`in` - `[Datetime!]`	Included in the specified list.
`notIn` - `[Datetime!]`	Not included in the specified list.
`lessThan` - `Datetime`	Less than the specified value.
`lessThanOrEqualTo` - `Datetime`	Less than or equal to the specified value.
`greaterThan` - `Datetime`	Greater than the specified value.
`greaterThanOrEqualTo` - `Datetime`	Greater than or equal to the specified value.

Example

{
  "isNull": true,
  "equalTo": Datetime,
  "notEqualTo": Datetime,
  "distinctFrom": Datetime,
  "notDistinctFrom": Datetime,
  "in": [Datetime],
  "notIn": [Datetime],
  "lessThan": Datetime,
  "lessThanOrEqualTo": Datetime,
  "greaterThan": Datetime,
  "greaterThanOrEqualTo": Datetime
}

Types

`DbInfo`

Field Name	Description
`version` - `String`
`tsVersion` - `String`
`retention` - `String`
`dbSize` - `BigInt`
`mediaSize` - `BigInt`
`pps` - `Int`
`props10Min` - `Int`
`devices` - `Int`
`devicesOffline` - `Int`
`users` - `Int`
`usersDisabled` - `Int`
`appUsers` - `Int`
`userGroups` - `Int`
`objects` - `Int`
`historySize` - `BigInt`
`notifications` - `Int`
`notificationsSize` - `BigInt`
`deliveries` - `Int`
`deliveriesSize` - `BigInt`
`controls` - `Int`
`controlsSize` - `BigInt`

Example

{
  "version": "xyz789",
  "tsVersion": "xyz789",
  "retention": "xyz789",
  "dbSize": BigInt,
  "mediaSize": BigInt,
  "pps": 987,
  "props10Min": 987,
  "devices": 123,
  "devicesOffline": 987,
  "users": 987,
  "usersDisabled": 987,
  "appUsers": 123,
  "userGroups": 987,
  "objects": 987,
  "historySize": BigInt,
  "notifications": 123,
  "notificationsSize": BigInt,
  "deliveries": 987,
  "deliveriesSize": BigInt,
  "controls": 123,
  "controlsSize": BigInt
}

Types

`DeleteObjectByNodeIdInput`

All input for the deleteObjectByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `Object` to be deleted.

Example

{"clientMutationId": "abc123", "nodeId": ID}

Types

`DeleteObjectInput`

All input for the deleteObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`	Unique Object ID.

Example

{"clientMutationId": "xyz789", "id": UUID}

Types

`DeleteObjectPayload`

The output of our delete Object mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`object` - `Object`	The `Object` that was deleted by this mutation.
`deletedObjectNodeId` - `ID`
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userByBy` - `User`	Reads a single `User` that is related to this `Object`.
`schema` - `Schema`	Reads a single `Schema` that is related to this `Object`.
`objectEdge` - `ObjectsEdge`	An edge for our `Object`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`.

Example

{
  "clientMutationId": "xyz789",
  "object": Object,
  "deletedObjectNodeId": ID,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "schema": Schema,
  "objectEdge": ObjectsEdge
}

Types

`DeleteObjectPropertiesHistoryByNodeIdInput`

All input for the deleteObjectPropertiesHistoryByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `ObjectPropertiesHistory` to be deleted.

Example

{"clientMutationId": "xyz789", "nodeId": ID}

Types

`DeleteObjectPropertiesHistoryInput`

All input for the deleteObjectPropertiesHistory mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`recordedAt` - `Datetime!`
`id` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "recordedAt": Datetime,
  "id": 987
}

Types

`DeleteObjectPropertiesHistoryPayload`

The output of our delete ObjectPropertiesHistory mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`objectPropertiesHistory` - `ObjectPropertiesHistory`	The `ObjectPropertiesHistory` that was deleted by this mutation.
`deletedObjectPropertiesHistoryNodeId` - `ID`
`userByBy` - `User`	Reads a single `User` that is related to this `ObjectPropertiesHistory`.
`objectPropertiesHistoryEdge` - `ObjectPropertiesHistoriesEdge`	An edge for our `ObjectPropertiesHistory`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectPropertiesHistoriesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectPropertiesHistory`.

Example

{
  "clientMutationId": "xyz789",
  "objectPropertiesHistory": ObjectPropertiesHistory,
  "deletedObjectPropertiesHistoryNodeId": ID,
  "userByBy": User,
  "objectPropertiesHistoryEdge": ObjectPropertiesHistoriesEdge
}

Types

`DeleteObjectsToObjectByNodeIdInput`

All input for the deleteObjectsToObjectByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `ObjectsToObject` to be deleted.

Example

{"clientMutationId": "abc123", "nodeId": ID}

Types

`DeleteObjectsToObjectByObject1IdAndObject2IdInput`

All input for the deleteObjectsToObjectByObject1IdAndObject2Id mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`object1Id` - `UUID!`	Object ID connected to.
`object2Id` - `UUID!`	Object ID connecting to.

Example

{
  "clientMutationId": "abc123",
  "object1Id": UUID,
  "object2Id": UUID
}

Types

`DeleteObjectsToObjectInput`

All input for the deleteObjectsToObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`	Relation unique ID.

Example

{"clientMutationId": "xyz789", "id": UUID}

Types

`DeleteObjectsToObjectPayload`

The output of our delete ObjectsToObject mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`objectsToObject` - `ObjectsToObject`	The `ObjectsToObject` that was deleted by this mutation.
`deletedObjectsToObjectNodeId` - `ID`
`object1` - `Object`	Reads a single `Object` that is related to this `ObjectsToObject`.
`object2` - `Object`	Reads a single `Object` that is related to this `ObjectsToObject`.
`objectsToObjectEdge` - `ObjectsToObjectsEdge`	An edge for our `ObjectsToObject`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectsToObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectsToObject`.

Example

{
  "clientMutationId": "xyz789",
  "objectsToObject": ObjectsToObject,
  "deletedObjectsToObjectNodeId": ID,
  "object1": Object,
  "object2": Object,
  "objectsToObjectEdge": ObjectsToObjectsEdge
}

Types

`DeletePropertyTypeByNameInput`

All input for the deletePropertyTypeByName mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`name` - `String!`	Type name (must be unique)

Example

{"clientMutationId": "xyz789", "name": "abc123"}

Types

`DeletePropertyTypeByNodeIdInput`

All input for the deletePropertyTypeByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `PropertyType` to be deleted.

Example

{"clientMutationId": "xyz789", "nodeId": ID}

Types

`DeletePropertyTypeInput`

All input for the deletePropertyType mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`	Type id.

Example

{"clientMutationId": "abc123", "id": UUID}

Types

`DeletePropertyTypePayload`

The output of our delete PropertyType mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`propertyType` - `PropertyType`	The `PropertyType` that was deleted by this mutation.
`deletedPropertyTypeNodeId` - `ID`
`propertyTypeEdge` - `PropertyTypesEdge`	An edge for our `PropertyType`. May be used by Relay 1.
Arguments `orderBy` - `[PropertyTypesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `PropertyType`.

Example

{
  "clientMutationId": "abc123",
  "propertyType": PropertyType,
  "deletedPropertyTypeNodeId": ID,
  "propertyTypeEdge": PropertyTypesEdge
}

Types

`DeleteSchemaByNodeIdInput`

All input for the deleteSchemaByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `Schema` to be deleted.

Example

{"clientMutationId": "abc123", "nodeId": ID}

Types

`DeleteSchemaControlByNodeIdInput`

All input for the deleteSchemaControlByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `SchemaControl` to be deleted.

Example

{"clientMutationId": "abc123", "nodeId": ID}

Types

`DeleteSchemaControlInput`

All input for the deleteSchemaControl mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`	Schema Controls unique ID.

Example

{"clientMutationId": "abc123", "id": UUID}

Types

`DeleteSchemaControlPayload`

The output of our delete SchemaControl mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schemaControl` - `SchemaControl`	The `SchemaControl` that was deleted by this mutation.
`deletedSchemaControlNodeId` - `ID`
`schema` - `Schema`	Reads a single `Schema` that is related to this `SchemaControl`.
`userByBy` - `User`	Reads a single `User` that is related to this `SchemaControl`.
`schemaControlEdge` - `SchemaControlsEdge`	An edge for our `SchemaControl`. May be used by Relay 1.
Arguments `orderBy` - `[SchemaControlsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaControl`.

Example

{
  "clientMutationId": "abc123",
  "schemaControl": SchemaControl,
  "deletedSchemaControlNodeId": ID,
  "schema": Schema,
  "userByBy": User,
  "schemaControlEdge": SchemaControlsEdge
}

Types

`DeleteSchemaInput`

All input for the deleteSchema mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`	Schema unique ID.

Example

{"clientMutationId": "xyz789", "id": UUID}

Types

`DeleteSchemaPayload`

The output of our delete Schema mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schema` - `Schema`	The `Schema` that was deleted by this mutation.
`deletedSchemaNodeId` - `ID`
`userByApplicationOwner` - `User`	Reads a single `User` that is related to this `Schema`.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userByBy` - `User`	Reads a single `User` that is related to this `Schema`.
`parentSchema` - `Schema`	Reads a single `Schema` that is related to this `Schema`.
`schemaEdge` - `SchemataEdge`	An edge for our `Schema`. May be used by Relay 1.
Arguments `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`.

Example

{
  "clientMutationId": "abc123",
  "schema": Schema,
  "deletedSchemaNodeId": ID,
  "userByApplicationOwner": User,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "parentSchema": Schema,
  "schemaEdge": SchemataEdge
}

Types

`DeleteSchemaPropertyByNodeIdInput`

All input for the deleteSchemaPropertyByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `SchemaProperty` to be deleted.

Example

{"clientMutationId": "xyz789", "nodeId": ID}

Types

`DeleteSchemaPropertyInput`

All input for the deleteSchemaProperty mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`	Schema Property unique ID.

Example

{"clientMutationId": "abc123", "id": UUID}

Types

`DeleteSchemaPropertyPayload`

The output of our delete SchemaProperty mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schemaProperty` - `SchemaProperty`	The `SchemaProperty` that was deleted by this mutation.
`deletedSchemaPropertyNodeId` - `ID`
`schema` - `Schema`	Reads a single `Schema` that is related to this `SchemaProperty`.
`userByBy` - `User`	Reads a single `User` that is related to this `SchemaProperty`.
`type` - `PropertyType`	Reads a single `PropertyType` that is related to this `SchemaProperty`.
`schemaPropertyEdge` - `SchemaPropertiesEdge`	An edge for our `SchemaProperty`. May be used by Relay 1.
Arguments `orderBy` - `[SchemaPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaProperty`.

Example

{
  "clientMutationId": "abc123",
  "schemaProperty": SchemaProperty,
  "deletedSchemaPropertyNodeId": ID,
  "schema": Schema,
  "userByBy": User,
  "type": PropertyType,
  "schemaPropertyEdge": SchemaPropertiesEdge
}

Types

`DeleteUserByLoginInput`

All input for the deleteUserByLogin mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`login` - `String!`	User's login name (User name).

Example

{"clientMutationId": "xyz789", "login": "xyz789"}

Types

`DeleteUserByNodeIdInput`

All input for the deleteUserByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `User` to be deleted.

Example

{"clientMutationId": "abc123", "nodeId": ID}

Types

`DeleteUserGroupByGroupNameInput`

All input for the deleteUserGroupByGroupName mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`groupName` - `String!`	User Group name.

Example

{"clientMutationId": "xyz789", "groupName": "xyz789"}

Types

`DeleteUserGroupByNodeIdInput`

All input for the deleteUserGroupByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `UserGroup` to be deleted.

Example

{"clientMutationId": "xyz789", "nodeId": ID}

Types

`DeleteUserGroupInput`

All input for the deleteUserGroup mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`	User Group unique ID.

Example

{"clientMutationId": "xyz789", "id": UUID}

Types

`DeleteUserGroupPayload`

The output of our delete UserGroup mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`userGroup` - `UserGroup`	The `UserGroup` that was deleted by this mutation.
`deletedUserGroupNodeId` - `ID`
`userByBy` - `User`	Reads a single `User` that is related to this `UserGroup`.
`userGroupEdge` - `UserGroupsEdge`	An edge for our `UserGroup`. May be used by Relay 1.
Arguments `orderBy` - `[UserGroupsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UserGroup`.

Example

{
  "clientMutationId": "xyz789",
  "userGroup": UserGroup,
  "deletedUserGroupNodeId": ID,
  "userByBy": User,
  "userGroupEdge": UserGroupsEdge
}

Types

`DeleteUserInput`

All input for the deleteUser mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`	User unique ID.

Example

{"clientMutationId": "xyz789", "id": UUID}

Types

`DeleteUserPayload`

The output of our delete User mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`user` - `User`	The `User` that was deleted by this mutation.
`deletedUserNodeId` - `ID`
`userGroupByDefaultEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userEdge` - `UsersEdge`	An edge for our `User`. May be used by Relay 1.
Arguments `orderBy` - `[UsersOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `User`.

Example

{
  "clientMutationId": "abc123",
  "user": User,
  "deletedUserNodeId": ID,
  "userGroupByDefaultEditorgroup": UserGroup,
  "userGroupByDefaultUsergroup": UserGroup,
  "userGroupByDefaultReadergroup": UserGroup,
  "userEdge": UsersEdge
}

Types

`DeleteUsersToGroupByNodeIdInput`

All input for the deleteUsersToGroupByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `UsersToGroup` to be deleted.

Example

{"clientMutationId": "xyz789", "nodeId": ID}

Types

`DeleteUsersToGroupByUserIdAndUserGroupIdInput`

All input for the deleteUsersToGroupByUserIdAndUserGroupId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`userId` - `UUID!`	User unique ID.
`userGroupId` - `UUID!`	User Group unique ID.

Example

{
  "clientMutationId": "xyz789",
  "userId": UUID,
  "userGroupId": UUID
}

Types

`DeleteUsersToGroupInput`

All input for the deleteUsersToGroup mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`

Example

{"clientMutationId": "abc123", "id": UUID}

Types

`DeleteUsersToGroupPayload`

The output of our delete UsersToGroup mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`usersToGroup` - `UsersToGroup`	The `UsersToGroup` that was deleted by this mutation.
`deletedUsersToGroupNodeId` - `ID`
`user` - `User`	Reads a single `User` that is related to this `UsersToGroup`.
`userGroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `UsersToGroup`.
`usersToGroupEdge` - `UsersToGroupsEdge`	An edge for our `UsersToGroup`. May be used by Relay 1.
Arguments `orderBy` - `[UsersToGroupsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToGroup`.

Example

{
  "clientMutationId": "xyz789",
  "usersToGroup": UsersToGroup,
  "deletedUsersToGroupNodeId": ID,
  "user": User,
  "userGroup": UserGroup,
  "usersToGroupEdge": UsersToGroupsEdge
}

Types

`DeleteUsersToObjectByNodeIdInput`

All input for the deleteUsersToObjectByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `UsersToObject` to be deleted.

Example

{"clientMutationId": "xyz789", "nodeId": ID}

Types

`DeleteUsersToObjectByUserIdAndObjectIdInput`

All input for the deleteUsersToObjectByUserIdAndObjectId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`userId` - `UUID!`	User unique ID.
`objectId` - `UUID!`	Object unique ID.

Example

{
  "clientMutationId": "xyz789",
  "userId": UUID,
  "objectId": UUID
}

Types

`DeleteUsersToObjectInput`

All input for the deleteUsersToObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`id` - `UUID!`

Example

{"clientMutationId": "xyz789", "id": UUID}

Types

`DeleteUsersToObjectPayload`

The output of our delete UsersToObject mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`usersToObject` - `UsersToObject`	The `UsersToObject` that was deleted by this mutation.
`deletedUsersToObjectNodeId` - `ID`
`user` - `User`	Reads a single `User` that is related to this `UsersToObject`.
`object` - `Object`	Reads a single `Object` that is related to this `UsersToObject`.
`usersToObjectEdge` - `UsersToObjectsEdge`	An edge for our `UsersToObject`. May be used by Relay 1.
Arguments `orderBy` - `[UsersToObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToObject`.

Example

{
  "clientMutationId": "abc123",
  "usersToObject": UsersToObject,
  "deletedUsersToObjectNodeId": ID,
  "user": User,
  "object": Object,
  "usersToObjectEdge": UsersToObjectsEdge
}

Types

`DetailedNotificationHistoryItem`

Field Name	Description
`objectId` - `UUID`
`objectName` - `String`
`enabled` - `Boolean`
`message` - `String`
`spec` - `JSON`
`tags` - `[String]`
`createdAt` - `Datetime`
`by` - `String`
`schemaName` - `String`
`schemaType` - `String`
`schemaTags` - `[String]`

Example

{
  "objectId": UUID,
  "objectName": "abc123",
  "enabled": true,
  "message": "xyz789",
  "spec": {},
  "tags": ["abc123"],
  "createdAt": Datetime,
  "by": "abc123",
  "schemaName": "abc123",
  "schemaType": "abc123",
  "schemaTags": ["abc123"]
}

Types

`DetailedNotificationHistoryItemFilter`

A filter to be used against DetailedNotificationHistoryItem object types. All fields are combined with a logical ‘and.’

Input Field	Description
`objectId` - `UUIDFilter`	Filter by the object’s `objectId` field.
`objectName` - `StringFilter`	Filter by the object’s `objectName` field.
`enabled` - `BooleanFilter`	Filter by the object’s `enabled` field.
`message` - `StringFilter`	Filter by the object’s `message` field.
`tags` - `StringListFilter`	Filter by the object’s `tags` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`by` - `StringFilter`	Filter by the object’s `by` field.
`schemaName` - `StringFilter`	Filter by the object’s `schemaName` field.
`schemaType` - `StringFilter`	Filter by the object’s `schemaType` field.
`schemaTags` - `StringListFilter`	Filter by the object’s `schemaTags` field.
`and` - `[DetailedNotificationHistoryItemFilter!]`	Checks for all expressions in this list.
`or` - `[DetailedNotificationHistoryItemFilter!]`	Checks for any expressions in this list.
`not` - `DetailedNotificationHistoryItemFilter`	Negates the expression.

Example

{
  "objectId": UUIDFilter,
  "objectName": StringFilter,
  "enabled": BooleanFilter,
  "message": StringFilter,
  "tags": StringListFilter,
  "createdAt": DatetimeFilter,
  "by": StringFilter,
  "schemaName": StringFilter,
  "schemaType": StringFilter,
  "schemaTags": StringListFilter,
  "and": [DetailedNotificationHistoryItemFilter],
  "or": [DetailedNotificationHistoryItemFilter],
  "not": DetailedNotificationHistoryItemFilter
}

Types

`DetailedNotificationHistoryItemsConnection`

A connection to a list of DetailedNotificationHistoryItem values.

Field Name	Description
`nodes` - `[DetailedNotificationHistoryItem]!`	A list of `DetailedNotificationHistoryItem` objects.
`edges` - `[DetailedNotificationHistoryItemsEdge!]!`	A list of edges which contains the `DetailedNotificationHistoryItem` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `DetailedNotificationHistoryItem` you could get from the connection.

Example

{
  "nodes": [DetailedNotificationHistoryItem],
  "edges": [DetailedNotificationHistoryItemsEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`DetailedNotificationHistoryItemsEdge`

A DetailedNotificationHistoryItem edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `DetailedNotificationHistoryItem`	The `DetailedNotificationHistoryItem` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": DetailedNotificationHistoryItem
}

Types

`DetailedObjectInput`

An input for mutations affecting DetailedObject

Field Name	Description
`objectId` - `UUID`
`name` - `String`
`enabled` - `Boolean`
`description` - `String`
`editorgroup` - `UUID`
`usergroup` - `UUID`
`readergroup` - `UUID`
`properties` - `[PropertyByIdInput]`
`namedProperties` - `[PropertyByNameInput]`
`keyedProperties` - `[PropertyByKeyInput]`
`parents` - `[UUID]`
`childs` - `[UUID]`

Example

{
  "objectId": UUID,
  "name": "abc123",
  "enabled": true,
  "description": "xyz789",
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "properties": [PropertyByIdInput],
  "namedProperties": [PropertyByNameInput],
  "keyedProperties": [PropertyByKeyInput],
  "parents": [UUID],
  "childs": [UUID]
}

Types

`DetailedPropertyHistoryItem`

Field Name	Description
`objectId` - `UUID`
`groupName` - `String`
`property` - `String`
`value` - `JSON`
`recordedAt` - `Datetime`
`by` - `String`
`objectName` - `String`
`enabled` - `Boolean`
`schemaName` - `String`
`schemaType` - `String`
`schemaTags` - `[String]`
`units` - `String`
`stealth` - `Boolean`
`valueType` - `String`
`notNull` - `Boolean`
`parentObjectName` - `String`
`parentSchemaName` - `String`
`parentSchemaType` - `String`

Example

{
  "objectId": UUID,
  "groupName": "xyz789",
  "property": "abc123",
  "value": {},
  "recordedAt": Datetime,
  "by": "abc123",
  "objectName": "xyz789",
  "enabled": true,
  "schemaName": "abc123",
  "schemaType": "xyz789",
  "schemaTags": ["xyz789"],
  "units": "xyz789",
  "stealth": true,
  "valueType": "abc123",
  "notNull": false,
  "parentObjectName": "abc123",
  "parentSchemaName": "abc123",
  "parentSchemaType": "abc123"
}

Types

`DetailedPropertyHistoryItemFilter`

A filter to be used against DetailedPropertyHistoryItem object types. All fields are combined with a logical ‘and.’

Input Field	Description
`objectId` - `UUIDFilter`	Filter by the object’s `objectId` field.
`groupName` - `StringFilter`	Filter by the object’s `groupName` field.
`property` - `StringFilter`	Filter by the object’s `property` field.
`recordedAt` - `DatetimeFilter`	Filter by the object’s `recordedAt` field.
`by` - `StringFilter`	Filter by the object’s `by` field.
`objectName` - `StringFilter`	Filter by the object’s `objectName` field.
`enabled` - `BooleanFilter`	Filter by the object’s `enabled` field.
`schemaName` - `StringFilter`	Filter by the object’s `schemaName` field.
`schemaType` - `StringFilter`	Filter by the object’s `schemaType` field.
`schemaTags` - `StringListFilter`	Filter by the object’s `schemaTags` field.
`units` - `StringFilter`	Filter by the object’s `units` field.
`stealth` - `BooleanFilter`	Filter by the object’s `stealth` field.
`valueType` - `StringFilter`	Filter by the object’s `valueType` field.
`notNull` - `BooleanFilter`	Filter by the object’s `notNull` field.
`parentObjectName` - `StringFilter`	Filter by the object’s `parentObjectName` field.
`parentSchemaName` - `StringFilter`	Filter by the object’s `parentSchemaName` field.
`parentSchemaType` - `StringFilter`	Filter by the object’s `parentSchemaType` field.
`and` - `[DetailedPropertyHistoryItemFilter!]`	Checks for all expressions in this list.
`or` - `[DetailedPropertyHistoryItemFilter!]`	Checks for any expressions in this list.
`not` - `DetailedPropertyHistoryItemFilter`	Negates the expression.

Example

{
  "objectId": UUIDFilter,
  "groupName": StringFilter,
  "property": StringFilter,
  "recordedAt": DatetimeFilter,
  "by": StringFilter,
  "objectName": StringFilter,
  "enabled": BooleanFilter,
  "schemaName": StringFilter,
  "schemaType": StringFilter,
  "schemaTags": StringListFilter,
  "units": StringFilter,
  "stealth": BooleanFilter,
  "valueType": StringFilter,
  "notNull": BooleanFilter,
  "parentObjectName": StringFilter,
  "parentSchemaName": StringFilter,
  "parentSchemaType": StringFilter,
  "and": [DetailedPropertyHistoryItemFilter],
  "or": [DetailedPropertyHistoryItemFilter],
  "not": DetailedPropertyHistoryItemFilter
}

Types

`DetailedPropertyHistoryItemsConnection`

A connection to a list of DetailedPropertyHistoryItem values.

Field Name	Description
`nodes` - `[DetailedPropertyHistoryItem]!`	A list of `DetailedPropertyHistoryItem` objects.
`edges` - `[DetailedPropertyHistoryItemsEdge!]!`	A list of edges which contains the `DetailedPropertyHistoryItem` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `DetailedPropertyHistoryItem` you could get from the connection.

Example

{
  "nodes": [DetailedPropertyHistoryItem],
  "edges": [DetailedPropertyHistoryItemsEdge],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

`DetailedPropertyHistoryItemsEdge`

A DetailedPropertyHistoryItem edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `DetailedPropertyHistoryItem`	The `DetailedPropertyHistoryItem` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": DetailedPropertyHistoryItem
}

Types

`Expiry`

Enum Value	Description
`NOT_EXPIRED`
`EXPIRING_SOON`
`EXPIRED`
`LONG_EXPIRED`

Types

`ExportConfigurationInput`

All input for the exportConfiguration mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.

Example

{"clientMutationId": "abc123"}

Types

`ExportConfigurationPayload`

The output of our exportConfiguration mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`string` - `String`

Example

{"clientMutationId": "abc123", "string": "abc123"}

Types

`Float`

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

987.65

Types

`ID`

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

object

Types

`IDoInsertControlExecutionInput`

All input for the iDoInsertControlExecution mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectId` - `UUID`
`name` - `String`
`params` - `JSON`

Example

{
  "clientMutationId": "xyz789",
  "objectId": UUID,
  "name": "xyz789",
  "params": {}
}

Types

`IDoInsertControlExecutionPayload`

The output of our iDoInsertControlExecution mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`integer` - `Int`

Example

{"clientMutationId": "xyz789", "integer": 987}

Types

`ImportSchemaInput`

All input for the importSchema mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`jsonSchema` - `String`
`updateOnly` - `Boolean`
`preserveDefaultValues` - `Boolean`

Example

{
  "clientMutationId": "xyz789",
  "jsonSchema": "abc123",
  "updateOnly": true,
  "preserveDefaultValues": false
}

Types

`ImportSchemaPayload`

The output of our importSchema mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`uuid` - `UUID`

Example

{"clientMutationId": "abc123", "uuid": UUID}

Types

`Int`

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

`IntFilter`

A filter to be used against Int fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `Int`	Equal to the specified value.
`notEqualTo` - `Int`	Not equal to the specified value.
`distinctFrom` - `Int`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `Int`	Equal to the specified value, treating null like an ordinary value.
`in` - `[Int!]`	Included in the specified list.
`notIn` - `[Int!]`	Not included in the specified list.
`lessThan` - `Int`	Less than the specified value.
`lessThanOrEqualTo` - `Int`	Less than or equal to the specified value.
`greaterThan` - `Int`	Greater than the specified value.
`greaterThanOrEqualTo` - `Int`	Greater than or equal to the specified value.

Example

{
  "isNull": false,
  "equalTo": 123,
  "notEqualTo": 987,
  "distinctFrom": 987,
  "notDistinctFrom": 123,
  "in": [123],
  "notIn": [123],
  "lessThan": 987,
  "lessThanOrEqualTo": 123,
  "greaterThan": 123,
  "greaterThanOrEqualTo": 987
}

Types

`Interval`

An interval of time that has passed where the smallest distinct unit is a second.

Field Name	Description
`seconds` - `Float`	A quantity of seconds. This is the only non-integer field, as all the other fields will dump their overflow into a smaller unit of time. Intervals don’t have a smaller unit than seconds.
`minutes` - `Int`	A quantity of minutes.
`hours` - `Int`	A quantity of hours.
`days` - `Int`	A quantity of days.
`months` - `Int`	A quantity of months.
`years` - `Int`	A quantity of years.

Example

{
  "seconds": 123.45,
  "minutes": 987,
  "hours": 987,
  "days": 987,
  "months": 123,
  "years": 987
}

Types

`IntervalFilter`

A filter to be used against Interval fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `IntervalInput`	Equal to the specified value.
`notEqualTo` - `IntervalInput`	Not equal to the specified value.
`distinctFrom` - `IntervalInput`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `IntervalInput`	Equal to the specified value, treating null like an ordinary value.
`in` - `[IntervalInput!]`	Included in the specified list.
`notIn` - `[IntervalInput!]`	Not included in the specified list.
`lessThan` - `IntervalInput`	Less than the specified value.
`lessThanOrEqualTo` - `IntervalInput`	Less than or equal to the specified value.
`greaterThan` - `IntervalInput`	Greater than the specified value.
`greaterThanOrEqualTo` - `IntervalInput`	Greater than or equal to the specified value.

Example

{
  "isNull": false,
  "equalTo": IntervalInput,
  "notEqualTo": IntervalInput,
  "distinctFrom": IntervalInput,
  "notDistinctFrom": IntervalInput,
  "in": [IntervalInput],
  "notIn": [IntervalInput],
  "lessThan": IntervalInput,
  "lessThanOrEqualTo": IntervalInput,
  "greaterThan": IntervalInput,
  "greaterThanOrEqualTo": IntervalInput
}

Types

`IntervalInput`

An interval of time that has passed where the smallest distinct unit is a second.

Input Field	Description
`seconds` - `Float`	A quantity of seconds. This is the only non-integer field, as all the other fields will dump their overflow into a smaller unit of time. Intervals don’t have a smaller unit than seconds.
`minutes` - `Int`	A quantity of minutes.
`hours` - `Int`	A quantity of hours.
`days` - `Int`	A quantity of days.
`months` - `Int`	A quantity of months.
`years` - `Int`	A quantity of years.

Example

{
  "seconds": 123.45,
  "minutes": 123,
  "hours": 987,
  "days": 987,
  "months": 987,
  "years": 987
}

Types

`JSON`

The JSON scalar type represents JSON values as specified by ECMA-404.

Example

{}

Types

`JSONFilter`

A filter to be used against JSON fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `JSON`	Equal to the specified value.
`notEqualTo` - `JSON`	Not equal to the specified value.
`distinctFrom` - `JSON`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `JSON`	Equal to the specified value, treating null like an ordinary value.
`in` - `[JSON!]`	Included in the specified list.
`notIn` - `[JSON!]`	Not included in the specified list.
`lessThan` - `JSON`	Less than the specified value.
`lessThanOrEqualTo` - `JSON`	Less than or equal to the specified value.
`greaterThan` - `JSON`	Greater than the specified value.
`greaterThanOrEqualTo` - `JSON`	Greater than or equal to the specified value.
`contains` - `JSON`	Contains the specified JSON.
`containsKey` - `String`	Contains the specified key.
`containsAllKeys` - `[String!]`	Contains all of the specified keys.
`containsAnyKeys` - `[String!]`	Contains any of the specified keys.
`containedBy` - `JSON`	Contained by the specified JSON.

Example

{
  "isNull": true,
  "equalTo": {},
  "notEqualTo": {},
  "distinctFrom": {},
  "notDistinctFrom": {},
  "in": [{}],
  "notIn": [{}],
  "lessThan": {},
  "lessThanOrEqualTo": {},
  "greaterThan": {},
  "greaterThanOrEqualTo": {},
  "contains": {},
  "containsKey": "xyz789",
  "containsAllKeys": ["xyz789"],
  "containsAnyKeys": ["xyz789"],
  "containedBy": {}
}

Types

`JwtToken`

A JSON Web Token defined by RFC 7519 which securely represents claims between two parties.

Example

object

Types

`License`

Field Name	Description
`expired` - `Expiry`
`valid` - `Boolean`
`info` - `JSON`

Example

{
  "expired": Expiry,
  "valid": false,
  "info": {}
}

Types

`ListenControlExecutionsPayload`

Field Name	Description
`event` - `String`
`relatedNodeId` - `ID`

Example

{"event": "xyz789", "relatedNodeId": ID}

Types

`ListenNotificationsPayload`

Field Name	Description
`event` - `String`
`relatedNodeId` - `ID`

Example

{"event": "xyz789", "relatedNodeId": ID}

Types

`ListenObjectsPayload`

Field Name	Description
`event` - `String`
`relatedNodeId` - `ID`
`info` - `JSON`

Example

{
  "event": "xyz789",
  "relatedNodeId": ID,
  "info": {}
}

Types

`ListenPayload`

Field Name	Description
`event` - `String`
`relatedNodeId` - `ID`

Example

{"event": "xyz789", "relatedNodeId": ID}

Types

`ListenSchemasPayload`

Field Name	Description
`event` - `String`
`relatedNodeId` - `ID`

Example

{"event": "xyz789", "relatedNodeId": ID}

Types

`ListenUsersPayload`

Field Name	Description
`event` - `String`
`relatedNodeId` - `ID`
`info` - `JSON`

Example

{
  "event": "abc123",
  "relatedNodeId": ID,
  "info": {}
}

Types

`LogoutInput`

All input for the logout mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`removeTokens` - `Boolean`

Example

{"clientMutationId": "abc123", "removeTokens": true}

Types

`LogoutPayload`

The output of our logout mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`string` - `String`

Example

{"clientMutationId": "xyz789", "string": "abc123"}

Types

`Notification`

Notification represents the Notification generated within the platform.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`
`objectId` - `UUID`
`objectName` - `String`
`tags` - `[String]`
`createdAt` - `Datetime!`
`by` - `UUID!`
`spec` - `JSON`
`message` - `String!`
`object` - `Object`	Reads a single `Object` that is related to this `Notification`.
`userByBy` - `User`	Reads a single `User` that is related to this `Notification`.
`notificationDeliveriesConnection` - `NotificationDeliveriesConnection!`	Reads and enables pagination through a set of `NotificationDelivery`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[NotificationDeliveriesSort!]` The specification of how the `NotificationDelivery` records should be sorted. `orderBy` - `[NotificationDeliveriesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `NotificationDelivery`. `condition` - `NotificationDeliveryCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationDeliveryFilter` A filter to be used in determining which values should be returned by the collection.
`notificationDeliveries` - `[NotificationDelivery!]!`	Reads and enables pagination through a set of `NotificationDelivery`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[NotificationDeliveriesSort!]` The specification of how the `NotificationDelivery` records should be sorted. `orderBy` - `[NotificationDeliveriesOrderBy!]` The method to use when ordering `NotificationDelivery`. `condition` - `NotificationDeliveryCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationDeliveryFilter` A filter to be used in determining which values should be returned by the collection.
`byName` - `String`	Synthetic field: returns a user name, creator of the notification.

Example

{
  "nodeId": ID,
  "id": UUID,
  "objectId": UUID,
  "objectName": "xyz789",
  "tags": ["xyz789"],
  "createdAt": Datetime,
  "by": UUID,
  "spec": {},
  "message": "xyz789",
  "object": Object,
  "userByBy": User,
  "notificationDeliveriesConnection": NotificationDeliveriesConnection,
  "notificationDeliveries": [NotificationDelivery],
  "byName": "xyz789"
}

Types

`NotificationCondition`

A condition to be used against Notification object types. All fields are tested for equality and combined with a logical ‘and.’

Field Name	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`objectId` - `UUID`	Checks for equality with the object’s `objectId` field.
`objectName` - `String`	Checks for equality with the object’s `objectName` field.
`tags` - `[String]`	Checks for equality with the object’s `tags` field.
`createdAt` - `Datetime`	Checks for equality with the object’s `createdAt` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.
`spec` - `JSON`	Checks for equality with the object’s `spec` field.
`message` - `String`	Checks for equality with the object’s `message` field.

Example

{
  "id": UUID,
  "objectId": UUID,
  "objectName": "abc123",
  "tags": ["xyz789"],
  "createdAt": Datetime,
  "by": UUID,
  "spec": {},
  "message": "abc123"
}

Types

`NotificationDeliveriesConnection`

A connection to a list of NotificationDelivery values.

Field Name	Description
`nodes` - `[NotificationDelivery]!`	A list of `NotificationDelivery` objects.
`edges` - `[NotificationDeliveriesEdge!]!`	A list of edges which contains the `NotificationDelivery` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `NotificationDelivery` you could get from the connection.

Example

{
  "nodes": [NotificationDelivery],
  "edges": [NotificationDeliveriesEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`NotificationDeliveriesEdge`

A NotificationDelivery edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `NotificationDelivery`	The `NotificationDelivery` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": NotificationDelivery
}

Types

`NotificationDeliveriesOrderBy`

Methods to use when ordering NotificationDelivery.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`USER_ASC`
`USER_DESC`
`USER_LOGIN_ASC`
`USER_LOGIN_DESC`
`NOTIFICATION_ID_ASC`
`NOTIFICATION_ID_DESC`
`DELIVERED_ASC`
`DELIVERED_DESC`
`DELIVERY_PATH_ASC`
`DELIVERY_PATH_DESC`
`MESSAGE_ASC`
`MESSAGE_DESC`
`ERROR_ASC`
`ERROR_DESC`
`DELIVERY_CONFIG_ID_ASC`
`DELIVERY_CONFIG_ID_DESC`
`CREATED_AT_ASC`
`CREATED_AT_DESC`
`BY_ASC`
`BY_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`NotificationDeliveriesSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `NotificationDeliveriesSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": NotificationDeliveriesSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`NotificationDeliveriesSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `NotificationDeliveriesSortableField`

Example

{"field": NotificationDeliveriesSortableField}

Types

`NotificationDeliveriesSortableField`

Sortable concrete fields for the NotificationDelivery type.

Enum Value	Description
`ID`
`USER`
`USER_LOGIN`
`NOTIFICATION_ID`
`DELIVERED`
`DELIVERY_PATH`
`MESSAGE`
`ERROR`
`DELIVERY_CONFIG_ID`
`CREATED_AT`
`BY`

Types

`NotificationDelivery`

Notification Delivery is used to represent an individual event of Notification delivery via supported delivery ways (i.e. email, SMS, whatsapp, other).

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`	Notification Delivery unique ID.
`user` - `UUID`
`userLogin` - `String!`
`notificationId` - `UUID!`
`delivered` - `Boolean!`
`deliveryPath` - `String!`
`message` - `String!`
`error` - `String`
`deliveryConfigId` - `UUID`
`createdAt` - `Datetime!`
`by` - `UUID!`
`userByUser` - `User`	Reads a single `User` that is related to this `NotificationDelivery`.
`deliveryConfig` - `Object`	Reads a single `Object` that is related to this `NotificationDelivery`.
`notification` - `Notification`	Reads a single `Notification` that is related to this `NotificationDelivery`.

Example

{
  "nodeId": ID,
  "id": UUID,
  "user": UUID,
  "userLogin": "abc123",
  "notificationId": UUID,
  "delivered": false,
  "deliveryPath": "xyz789",
  "message": "abc123",
  "error": "abc123",
  "deliveryConfigId": UUID,
  "createdAt": Datetime,
  "by": UUID,
  "userByUser": User,
  "deliveryConfig": Object,
  "notification": Notification
}

Types

`NotificationDeliveryCondition`

A condition to be used against NotificationDelivery object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`user` - `UUID`	Checks for equality with the object’s `user` field.
`userLogin` - `String`	Checks for equality with the object’s `userLogin` field.
`notificationId` - `UUID`	Checks for equality with the object’s `notificationId` field.
`delivered` - `Boolean`	Checks for equality with the object’s `delivered` field.
`deliveryPath` - `String`	Checks for equality with the object’s `deliveryPath` field.
`message` - `String`	Checks for equality with the object’s `message` field.
`error` - `String`	Checks for equality with the object’s `error` field.
`deliveryConfigId` - `UUID`	Checks for equality with the object’s `deliveryConfigId` field.
`createdAt` - `Datetime`	Checks for equality with the object’s `createdAt` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.

Example

{
  "id": UUID,
  "user": UUID,
  "userLogin": "abc123",
  "notificationId": UUID,
  "delivered": false,
  "deliveryPath": "abc123",
  "message": "abc123",
  "error": "abc123",
  "deliveryConfigId": UUID,
  "createdAt": Datetime,
  "by": UUID
}

Types

`NotificationDeliveryFilter`

A filter to be used against NotificationDelivery object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`user` - `UUIDFilter`	Filter by the object’s `user` field.
`userLogin` - `StringFilter`	Filter by the object’s `userLogin` field.
`notificationId` - `UUIDFilter`	Filter by the object’s `notificationId` field.
`delivered` - `BooleanFilter`	Filter by the object’s `delivered` field.
`deliveryPath` - `StringFilter`	Filter by the object’s `deliveryPath` field.
`message` - `StringFilter`	Filter by the object’s `message` field.
`error` - `StringFilter`	Filter by the object’s `error` field.
`deliveryConfigId` - `UUIDFilter`	Filter by the object’s `deliveryConfigId` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`userByUser` - `UserFilter`	Filter by the object’s `userByUser` relation.
`userByUserExists` - `Boolean`	A related `userByUser` exists.
`deliveryConfig` - `ObjectFilter`	Filter by the object’s `deliveryConfig` relation.
`deliveryConfigExists` - `Boolean`	A related `deliveryConfig` exists.
`notification` - `NotificationFilter`	Filter by the object’s `notification` relation.
`and` - `[NotificationDeliveryFilter!]`	Checks for all expressions in this list.
`or` - `[NotificationDeliveryFilter!]`	Checks for any expressions in this list.
`not` - `NotificationDeliveryFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "user": UUIDFilter,
  "userLogin": StringFilter,
  "notificationId": UUIDFilter,
  "delivered": BooleanFilter,
  "deliveryPath": StringFilter,
  "message": StringFilter,
  "error": StringFilter,
  "deliveryConfigId": UUIDFilter,
  "createdAt": DatetimeFilter,
  "by": UUIDFilter,
  "userByUser": UserFilter,
  "userByUserExists": false,
  "deliveryConfig": ObjectFilter,
  "deliveryConfigExists": false,
  "notification": NotificationFilter,
  "and": [NotificationDeliveryFilter],
  "or": [NotificationDeliveryFilter],
  "not": NotificationDeliveryFilter
}

Types

`NotificationDeliveryInput`

An input for mutations affecting NotificationDelivery

Input Field	Description
`id` - `UUID`	Notification Delivery unique ID.
`user` - `UUID`
`userLogin` - `String!`
`notificationId` - `UUID!`
`delivered` - `Boolean!`
`deliveryPath` - `String!`
`message` - `String!`
`error` - `String`
`deliveryConfigId` - `UUID`

Example

{
  "id": UUID,
  "user": UUID,
  "userLogin": "xyz789",
  "notificationId": UUID,
  "delivered": false,
  "deliveryPath": "abc123",
  "message": "xyz789",
  "error": "abc123",
  "deliveryConfigId": UUID
}

Types

`NotificationFilter`

A filter to be used against Notification object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`objectId` - `UUIDFilter`	Filter by the object’s `objectId` field.
`objectName` - `StringFilter`	Filter by the object’s `objectName` field.
`tags` - `StringListFilter`	Filter by the object’s `tags` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`message` - `StringFilter`	Filter by the object’s `message` field.
`byName` - `StringFilter`	Filter by the object’s `byName` field.
`notificationDeliveriesConnection` - `NotificationToManyNotificationDeliveryFilter`	Filter by the object’s `notificationDeliveriesConnection` relation.
`notificationDeliveriesConnectionExist` - `Boolean`	Some related `notificationDeliveriesConnection` exist.
`object` - `ObjectFilter`	Filter by the object’s `object` relation.
`objectExists` - `Boolean`	A related `object` exists.
`userByBy` - `UserFilter`	Filter by the object’s `userByBy` relation.
`and` - `[NotificationFilter!]`	Checks for all expressions in this list.
`or` - `[NotificationFilter!]`	Checks for any expressions in this list.
`not` - `NotificationFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "objectId": UUIDFilter,
  "objectName": StringFilter,
  "tags": StringListFilter,
  "createdAt": DatetimeFilter,
  "by": UUIDFilter,
  "message": StringFilter,
  "byName": StringFilter,
  "notificationDeliveriesConnection": NotificationToManyNotificationDeliveryFilter,
  "notificationDeliveriesConnectionExist": false,
  "object": ObjectFilter,
  "objectExists": true,
  "userByBy": UserFilter,
  "and": [NotificationFilter],
  "or": [NotificationFilter],
  "not": NotificationFilter
}

Types

`NotificationInput`

An input for mutations affecting Notification

Field Name	Description
`id` - `UUID`
`objectId` - `UUID`
`objectName` - `String`
`tags` - `[String]`
`spec` - `JSON`
`message` - `String!`

Example

{
  "id": UUID,
  "objectId": UUID,
  "objectName": "abc123",
  "tags": ["xyz789"],
  "spec": {},
  "message": "xyz789"
}

Types

`NotificationToManyNotificationDeliveryFilter`

A filter to be used against many NotificationDelivery object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `NotificationDeliveryFilter`	Every related `NotificationDelivery` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `NotificationDeliveryFilter`	Some related `NotificationDelivery` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `NotificationDeliveryFilter`	No related `NotificationDelivery` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": NotificationDeliveryFilter,
  "some": NotificationDeliveryFilter,
  "none": NotificationDeliveryFilter
}

Types

`NotificationsConnection`

A connection to a list of Notification values.

Field Name	Description
`nodes` - `[Notification]!`	A list of `Notification` objects.
`edges` - `[NotificationsEdge!]!`	A list of edges which contains the `Notification` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `Notification` you could get from the connection.

Example

{
  "nodes": [Notification],
  "edges": [NotificationsEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`NotificationsEdge`

A Notification edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `Notification`	The `Notification` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": Notification
}

Types

`NotificationsOrderBy`

Methods to use when ordering Notification.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`OBJECT_ID_ASC`
`OBJECT_ID_DESC`
`OBJECT_NAME_ASC`
`OBJECT_NAME_DESC`
`TAGS_ASC`
`TAGS_DESC`
`CREATED_AT_ASC`
`CREATED_AT_DESC`
`BY_ASC`
`BY_DESC`
`SPEC_ASC`
`SPEC_DESC`
`MESSAGE_ASC`
`MESSAGE_DESC`
`BY_NAME_ASC`
`BY_NAME_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`NotificationsSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `NotificationsSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": NotificationsSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`NotificationsSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `NotificationsSortableField`

Example

{"field": NotificationsSortableField}

Types

`NotificationsSortableField`

Sortable concrete fields for the Notification type.

Enum Value	Description
`ID`
`OBJECT_ID`
`OBJECT_NAME`
`TAGS`
`CREATED_AT`
`BY`
`SPEC`
`MESSAGE`

Types

`Object`

The object is the main data structure operated within the platform. It can be of various types, it has associated Properties and its structure is controlled by Schemas.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`	Unique Object ID.
`name` - `String!`	Object's name.
`enabled` - `Boolean!`	Administrative Object's status.
`description` - `String`	Object description
`editorgroup` - `UUID!`	User Group with EditorGroup access permission.
`usergroup` - `UUID!`	User Group with UserGroup access permission.
`readergroup` - `UUID!`	User Group with ReaderGroup access permission.
`createdAt` - `Datetime!`	Object creation timestamp.
`updatedAt` - `Datetime!`	Object last update timestamp.
`by` - `UUID`	User last updated the Object.
`schemaId` - `UUID!`	ID of the Schema used to create the Object
`tags` - `[String]`	Tags for Object clusterization
`previousEnabled` - `Boolean`	Previous enabled.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userByBy` - `User`	Reads a single `User` that is related to this `Object`.
`schema` - `Schema`	Reads a single `Schema` that is related to this `Object`.
`notificationsConnection` - `NotificationsConnection!`	Reads and enables pagination through a set of `Notification`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[NotificationsSort!]` The specification of how the `Notification` records should be sorted. `orderBy` - `[NotificationsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Notification`. `condition` - `NotificationCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationFilter` A filter to be used in determining which values should be returned by the collection.
`notifications` - `[Notification!]!`	Reads and enables pagination through a set of `Notification`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[NotificationsSort!]` The specification of how the `Notification` records should be sorted. `orderBy` - `[NotificationsOrderBy!]` The method to use when ordering `Notification`. `condition` - `NotificationCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationFilter` A filter to be used in determining which values should be returned by the collection.
`objectPropertiesConnection` - `ObjectPropertiesConnection!`	Reads and enables pagination through a set of `ObjectProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectPropertiesSort!]` The specification of how the `ObjectProperty` records should be sorted. `orderBy` - `[ObjectPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectProperty`. `condition` - `ObjectPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`objectProperties` - `[ObjectProperty!]!`	Reads and enables pagination through a set of `ObjectProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectPropertiesSort!]` The specification of how the `ObjectProperty` records should be sorted. `orderBy` - `[ObjectPropertiesOrderBy!]` The method to use when ordering `ObjectProperty`. `condition` - `ObjectPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`controlExecutionsConnection` - `ControlExecutionsConnection!`	Reads and enables pagination through a set of `ControlExecution`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ControlExecutionsSort!]` The specification of how the `ControlExecution` records should be sorted. `orderBy` - `[ControlExecutionsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ControlExecution`. `condition` - `ControlExecutionCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ControlExecutionFilter` A filter to be used in determining which values should be returned by the collection.
`controlExecutions` - `[ControlExecution!]!`	Reads and enables pagination through a set of `ControlExecution`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ControlExecutionsSort!]` The specification of how the `ControlExecution` records should be sorted. `orderBy` - `[ControlExecutionsOrderBy!]` The method to use when ordering `ControlExecution`. `condition` - `ControlExecutionCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ControlExecutionFilter` A filter to be used in determining which values should be returned by the collection.
`notificationDeliveriesByDeliveryConfigIdConnection` - `NotificationDeliveriesConnection!`	Reads and enables pagination through a set of `NotificationDelivery`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[NotificationDeliveriesSort!]` The specification of how the `NotificationDelivery` records should be sorted. `orderBy` - `[NotificationDeliveriesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `NotificationDelivery`. `condition` - `NotificationDeliveryCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationDeliveryFilter` A filter to be used in determining which values should be returned by the collection.
`notificationDeliveriesByDeliveryConfigId` - `[NotificationDelivery!]!`	Reads and enables pagination through a set of `NotificationDelivery`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[NotificationDeliveriesSort!]` The specification of how the `NotificationDelivery` records should be sorted. `orderBy` - `[NotificationDeliveriesOrderBy!]` The method to use when ordering `NotificationDelivery`. `condition` - `NotificationDeliveryCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationDeliveryFilter` A filter to be used in determining which values should be returned by the collection.
`objectsToObjectsByObject1IdConnection` - `ObjectsToObjectsConnection!`	Reads and enables pagination through a set of `ObjectsToObject`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectsToObjectsSort!]` The specification of how the `ObjectsToObject` records should be sorted. `orderBy` - `[ObjectsToObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectsToObject`. `condition` - `ObjectsToObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectsToObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objectsToObjectsByObject1Id` - `[ObjectsToObject!]!`	Reads and enables pagination through a set of `ObjectsToObject`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectsToObjectsSort!]` The specification of how the `ObjectsToObject` records should be sorted. `orderBy` - `[ObjectsToObjectsOrderBy!]` The method to use when ordering `ObjectsToObject`. `condition` - `ObjectsToObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectsToObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objectsToObjectsByObject2IdConnection` - `ObjectsToObjectsConnection!`	Reads and enables pagination through a set of `ObjectsToObject`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectsToObjectsSort!]` The specification of how the `ObjectsToObject` records should be sorted. `orderBy` - `[ObjectsToObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectsToObject`. `condition` - `ObjectsToObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectsToObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objectsToObjectsByObject2Id` - `[ObjectsToObject!]!`	Reads and enables pagination through a set of `ObjectsToObject`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectsToObjectsSort!]` The specification of how the `ObjectsToObject` records should be sorted. `orderBy` - `[ObjectsToObjectsOrderBy!]` The method to use when ordering `ObjectsToObject`. `condition` - `ObjectsToObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectsToObjectFilter` A filter to be used in determining which values should be returned by the collection.
`userProfilesConnection` - `UserProfilesConnection!`	Reads and enables pagination through a set of `UserProfile`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UserProfilesSort!]` The specification of how the `UserProfile` records should be sorted. `orderBy` - `[UserProfilesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UserProfile`. `condition` - `UserProfileCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserProfileFilter` A filter to be used in determining which values should be returned by the collection.
`userProfiles` - `[UserProfile!]!`	Reads and enables pagination through a set of `UserProfile`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UserProfilesSort!]` The specification of how the `UserProfile` records should be sorted. `orderBy` - `[UserProfilesOrderBy!]` The method to use when ordering `UserProfile`. `condition` - `UserProfileCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserProfileFilter` A filter to be used in determining which values should be returned by the collection.
`usersToObjectsConnection` - `UsersToObjectsConnection!`	Reads and enables pagination through a set of `UsersToObject`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UsersToObjectsSort!]` The specification of how the `UsersToObject` records should be sorted. `orderBy` - `[UsersToObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToObject`. `condition` - `UsersToObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UsersToObjectFilter` A filter to be used in determining which values should be returned by the collection.
`usersToObjects` - `[UsersToObject!]!`	Reads and enables pagination through a set of `UsersToObject`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UsersToObjectsSort!]` The specification of how the `UsersToObject` records should be sorted. `orderBy` - `[UsersToObjectsOrderBy!]` The method to use when ordering `UsersToObject`. `condition` - `UsersToObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UsersToObjectFilter` A filter to be used in determining which values should be returned by the collection.
`deviceBatteryLevel` - `JSON`	Returns "Device/BATTERY_LEVEL" property for an object.
`deviceBatteryType` - `JSON`	Returns "Device/DC_POWER" property for an object.
`deviceEmulation` - `JSON`	Returns "Device/Emulation" property for an object.
`deviceResponseStatus` - `JSON`	Returns "Device/RESPONSE_STATUS" property for an object.
`favourite` - `Boolean`	Synthetic field: returns "true" if object is favourite and "false" if not.
`groupName` - `String`	Synthetic field: returns user group name based on the provided group type ("editorgroup/usergroup/readergroup") for this object.
Arguments `groupName` - `String`
`hardLinked` - `Boolean`	Returns true if current Object is a hard-linked to some parent Object (i.e. can't be removed directly).
`mediaFilename` - `JSON`	Returns "Credentials/FILENAME" property for an object.
`mediaSize` - `JSON`	Returns "Credentials/SIZE" property for an object.
`mediaType` - `JSON`	Returns "Credentials/TYPE" property for an object.
`muted` - `Boolean`	Synthetic field: returns "true" if object is muted and "false" if not.
`propertiesUpdatedAt` - `Datetime`	Synthetic field: returns actual updated_at for an object properties and fragments.
`property` - `JSON`	Synthetic field: returns property value based on the provided property name in the format "group_name/property_name".
Arguments `propertyName` - `String`
`propertyBool` - `Boolean`	Synthetic field: returns property value (as bool) based on the provided property name in the format "group_name/property_name".
Arguments `propertyName` - `String`
`propertyDouble` - `Float`	Synthetic field: returns property value (as float) based on the provided property name in the format "group_name/property_name".
Arguments `propertyName` - `String`
`propertyInt` - `Int`	Synthetic field: returns property value (as int) based on the provided property name in the format "group_name/property_name".
Arguments `propertyName` - `String`
`propertyTs` - `Datetime`	Synthetic field: returns property updatedAt value (timestamp) based on the provided property name in the format "group_name/property_name".
Arguments `propertyName` - `String`
`schemaName` - `String`	Synthetic field: returns schema name for this object.
`schemaTags` - `[String]`	Synthetic field: returns the list of tags associated with object's schema. @filterable
`schemaTagsString` - `String`	Allows to return Schema tags (1) as a string with ":" delimiter and (2) with some tags provided as parameters filtered out.
Arguments `tags` - `[String]`
`schemaType` - `String`	Synthetic field: returns schema type for this object.
`stringId` - `String`	Synthetic field: returns object UUID as string for further filtering.
`dynamicAttribute` - `JSON`
Arguments `match` - `ObjectsDynamicAttribute`

Example

{
  "nodeId": ID,
  "id": UUID,
  "name": "xyz789",
  "enabled": true,
  "description": "abc123",
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "schemaId": UUID,
  "tags": ["xyz789"],
  "previousEnabled": true,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "schema": Schema,
  "notificationsConnection": NotificationsConnection,
  "notifications": [Notification],
  "objectPropertiesConnection": ObjectPropertiesConnection,
  "objectProperties": [ObjectProperty],
  "controlExecutionsConnection": ControlExecutionsConnection,
  "controlExecutions": [ControlExecution],
  "notificationDeliveriesByDeliveryConfigIdConnection": NotificationDeliveriesConnection,
  "notificationDeliveriesByDeliveryConfigId": [
    NotificationDelivery
  ],
  "objectsToObjectsByObject1IdConnection": ObjectsToObjectsConnection,
  "objectsToObjectsByObject1Id": [ObjectsToObject],
  "objectsToObjectsByObject2IdConnection": ObjectsToObjectsConnection,
  "objectsToObjectsByObject2Id": [ObjectsToObject],
  "userProfilesConnection": UserProfilesConnection,
  "userProfiles": [UserProfile],
  "usersToObjectsConnection": UsersToObjectsConnection,
  "usersToObjects": [UsersToObject],
  "deviceBatteryLevel": {},
  "deviceBatteryType": {},
  "deviceEmulation": {},
  "deviceResponseStatus": {},
  "favourite": true,
  "groupName": "xyz789",
  "hardLinked": true,
  "mediaFilename": {},
  "mediaSize": {},
  "mediaType": {},
  "muted": false,
  "propertiesUpdatedAt": Datetime,
  "property": {},
  "propertyBool": true,
  "propertyDouble": 987.65,
  "propertyInt": 123,
  "propertyTs": Datetime,
  "schemaName": "xyz789",
  "schemaTags": ["xyz789"],
  "schemaTagsString": "xyz789",
  "schemaType": "abc123",
  "stringId": "xyz789",
  "dynamicAttribute": {}
}

Types

`ObjectCondition`

A condition to be used against Object object types. All fields are tested for equality and combined with a logical ‘and.’

Field Name	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`name` - `String`	Checks for equality with the object’s `name` field.
`enabled` - `Boolean`	Checks for equality with the object’s `enabled` field.
`description` - `String`	Checks for equality with the object’s `description` field.
`editorgroup` - `UUID`	Checks for equality with the object’s `editorgroup` field.
`usergroup` - `UUID`	Checks for equality with the object’s `usergroup` field.
`readergroup` - `UUID`	Checks for equality with the object’s `readergroup` field.
`createdAt` - `Datetime`	Checks for equality with the object’s `createdAt` field.
`updatedAt` - `Datetime`	Checks for equality with the object’s `updatedAt` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.
`schemaId` - `UUID`	Checks for equality with the object’s `schemaId` field.
`tags` - `[String]`	Checks for equality with the object’s `tags` field.
`previousEnabled` - `Boolean`	Checks for equality with the object’s `previousEnabled` field.
`deviceBatteryLevel` - `JSON`	Checks for equality with the object’s `deviceBatteryLevel` field.
`deviceBatteryType` - `JSON`	Checks for equality with the object’s `deviceBatteryType` field.
`deviceEmulation` - `JSON`	Checks for equality with the object’s `deviceEmulation` field.
`deviceResponseStatus` - `JSON`	Checks for equality with the object’s `deviceResponseStatus` field.
`favourite` - `Boolean`	Checks for equality with the object’s `favourite` field.
`mediaFilename` - `JSON`	Checks for equality with the object’s `mediaFilename` field.
`mediaSize` - `JSON`	Checks for equality with the object’s `mediaSize` field.
`mediaType` - `JSON`	Checks for equality with the object’s `mediaType` field.
`muted` - `Boolean`	Checks for equality with the object’s `muted` field.
`propertiesUpdatedAt` - `Datetime`	Checks for equality with the object’s `propertiesUpdatedAt` field.
`schemaName` - `String`	Checks for equality with the object’s `schemaName` field.
`schemaType` - `String`	Checks for equality with the object’s `schemaType` field.
`stringId` - `String`	Checks for equality with the object’s `stringId` field.

Example

{
  "id": UUID,
  "name": "xyz789",
  "enabled": true,
  "description": "abc123",
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "schemaId": UUID,
  "tags": ["xyz789"],
  "previousEnabled": true,
  "deviceBatteryLevel": {},
  "deviceBatteryType": {},
  "deviceEmulation": {},
  "deviceResponseStatus": {},
  "favourite": false,
  "mediaFilename": {},
  "mediaSize": {},
  "mediaType": {},
  "muted": false,
  "propertiesUpdatedAt": Datetime,
  "schemaName": "xyz789",
  "schemaType": "abc123",
  "stringId": "xyz789"
}

Types

`ObjectFilter`

A filter to be used against Object object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`name` - `StringFilter`	Filter by the object’s `name` field.
`enabled` - `BooleanFilter`	Filter by the object’s `enabled` field.
`description` - `StringFilter`	Filter by the object’s `description` field.
`editorgroup` - `UUIDFilter`	Filter by the object’s `editorgroup` field.
`usergroup` - `UUIDFilter`	Filter by the object’s `usergroup` field.
`readergroup` - `UUIDFilter`	Filter by the object’s `readergroup` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`updatedAt` - `DatetimeFilter`	Filter by the object’s `updatedAt` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`schemaId` - `UUIDFilter`	Filter by the object’s `schemaId` field.
`tags` - `StringListFilter`	Filter by the object’s `tags` field.
`previousEnabled` - `BooleanFilter`	Filter by the object’s `previousEnabled` field.
`deviceBatteryLevel` - `JSONFilter`	Filter by the object’s `deviceBatteryLevel` field.
`deviceBatteryType` - `JSONFilter`	Filter by the object’s `deviceBatteryType` field.
`deviceEmulation` - `JSONFilter`	Filter by the object’s `deviceEmulation` field.
`deviceResponseStatus` - `JSONFilter`	Filter by the object’s `deviceResponseStatus` field.
`favourite` - `BooleanFilter`	Filter by the object’s `favourite` field.
`hardLinked` - `BooleanFilter`	Filter by the object’s `hardLinked` field.
`mediaFilename` - `JSONFilter`	Filter by the object’s `mediaFilename` field.
`mediaSize` - `JSONFilter`	Filter by the object’s `mediaSize` field.
`mediaType` - `JSONFilter`	Filter by the object’s `mediaType` field.
`muted` - `BooleanFilter`	Filter by the object’s `muted` field.
`propertiesUpdatedAt` - `DatetimeFilter`	Filter by the object’s `propertiesUpdatedAt` field.
`schemaName` - `StringFilter`	Filter by the object’s `schemaName` field.
`schemaTags` - `StringListFilter`	Filter by the object’s `schemaTags` field.
`schemaType` - `StringFilter`	Filter by the object’s `schemaType` field.
`stringId` - `StringFilter`	Filter by the object’s `stringId` field.
`notificationsConnection` - `ObjectToManyNotificationFilter`	Filter by the object’s `notificationsConnection` relation.
`notificationsConnectionExist` - `Boolean`	Some related `notificationsConnection` exist.
`objectPropertiesConnection` - `ObjectToManyObjectPropertyFilter`	Filter by the object’s `objectPropertiesConnection` relation.
`objectPropertiesConnectionExist` - `Boolean`	Some related `objectPropertiesConnection` exist.
`controlExecutionsConnection` - `ObjectToManyControlExecutionFilter`	Filter by the object’s `controlExecutionsConnection` relation.
`controlExecutionsConnectionExist` - `Boolean`	Some related `controlExecutionsConnection` exist.
`notificationDeliveriesByDeliveryConfigIdConnection` - `ObjectToManyNotificationDeliveryFilter`	Filter by the object’s `notificationDeliveriesByDeliveryConfigIdConnection` relation.
`notificationDeliveriesByDeliveryConfigIdConnectionExist` - `Boolean`	Some related `notificationDeliveriesByDeliveryConfigIdConnection` exist.
`objectsToObjectsByObject1IdConnection` - `ObjectToManyObjectsToObjectFilter`	Filter by the object’s `objectsToObjectsByObject1IdConnection` relation.
`objectsToObjectsByObject1IdConnectionExist` - `Boolean`	Some related `objectsToObjectsByObject1IdConnection` exist.
`objectsToObjectsByObject2IdConnection` - `ObjectToManyObjectsToObjectFilter`	Filter by the object’s `objectsToObjectsByObject2IdConnection` relation.
`objectsToObjectsByObject2IdConnectionExist` - `Boolean`	Some related `objectsToObjectsByObject2IdConnection` exist.
`userProfilesConnection` - `ObjectToManyUserProfileFilter`	Filter by the object’s `userProfilesConnection` relation.
`userProfilesConnectionExist` - `Boolean`	Some related `userProfilesConnection` exist.
`usersToObjectsConnection` - `ObjectToManyUsersToObjectFilter`	Filter by the object’s `usersToObjectsConnection` relation.
`usersToObjectsConnectionExist` - `Boolean`	Some related `usersToObjectsConnection` exist.
`userGroupByEditorgroup` - `UserGroupFilter`	Filter by the object’s `userGroupByEditorgroup` relation.
`userGroupByUsergroup` - `UserGroupFilter`	Filter by the object’s `userGroupByUsergroup` relation.
`userGroupByReadergroup` - `UserGroupFilter`	Filter by the object’s `userGroupByReadergroup` relation.
`userByBy` - `UserFilter`	Filter by the object’s `userByBy` relation.
`userByByExists` - `Boolean`	A related `userByBy` exists.
`schema` - `SchemaFilter`	Filter by the object’s `schema` relation.
`and` - `[ObjectFilter!]`	Checks for all expressions in this list.
`or` - `[ObjectFilter!]`	Checks for any expressions in this list.
`not` - `ObjectFilter`	Negates the expression.
`dynamicAttribute` - `ObjectsDynamicAttributeFilter`	Filter by a dynamic field.

Example

{
  "id": UUIDFilter,
  "name": StringFilter,
  "enabled": BooleanFilter,
  "description": StringFilter,
  "editorgroup": UUIDFilter,
  "usergroup": UUIDFilter,
  "readergroup": UUIDFilter,
  "createdAt": DatetimeFilter,
  "updatedAt": DatetimeFilter,
  "by": UUIDFilter,
  "schemaId": UUIDFilter,
  "tags": StringListFilter,
  "previousEnabled": BooleanFilter,
  "deviceBatteryLevel": JSONFilter,
  "deviceBatteryType": JSONFilter,
  "deviceEmulation": JSONFilter,
  "deviceResponseStatus": JSONFilter,
  "favourite": BooleanFilter,
  "hardLinked": BooleanFilter,
  "mediaFilename": JSONFilter,
  "mediaSize": JSONFilter,
  "mediaType": JSONFilter,
  "muted": BooleanFilter,
  "propertiesUpdatedAt": DatetimeFilter,
  "schemaName": StringFilter,
  "schemaTags": StringListFilter,
  "schemaType": StringFilter,
  "stringId": StringFilter,
  "notificationsConnection": ObjectToManyNotificationFilter,
  "notificationsConnectionExist": true,
  "objectPropertiesConnection": ObjectToManyObjectPropertyFilter,
  "objectPropertiesConnectionExist": false,
  "controlExecutionsConnection": ObjectToManyControlExecutionFilter,
  "controlExecutionsConnectionExist": true,
  "notificationDeliveriesByDeliveryConfigIdConnection": ObjectToManyNotificationDeliveryFilter,
  "notificationDeliveriesByDeliveryConfigIdConnectionExist": false,
  "objectsToObjectsByObject1IdConnection": ObjectToManyObjectsToObjectFilter,
  "objectsToObjectsByObject1IdConnectionExist": false,
  "objectsToObjectsByObject2IdConnection": ObjectToManyObjectsToObjectFilter,
  "objectsToObjectsByObject2IdConnectionExist": true,
  "userProfilesConnection": ObjectToManyUserProfileFilter,
  "userProfilesConnectionExist": true,
  "usersToObjectsConnection": ObjectToManyUsersToObjectFilter,
  "usersToObjectsConnectionExist": false,
  "userGroupByEditorgroup": UserGroupFilter,
  "userGroupByUsergroup": UserGroupFilter,
  "userGroupByReadergroup": UserGroupFilter,
  "userByBy": UserFilter,
  "userByByExists": false,
  "schema": SchemaFilter,
  "and": [ObjectFilter],
  "or": [ObjectFilter],
  "not": ObjectFilter,
  "dynamicAttribute": ObjectsDynamicAttributeFilter
}

Types

`ObjectInput`

An input for mutations affecting Object

Field Name	Description
`id` - `UUID`	Unique Object ID.
`name` - `String!`	Object's name.
`enabled` - `Boolean`	Administrative Object's status.
`description` - `String`	Object description
`editorgroup` - `UUID`	User Group with EditorGroup access permission.
`usergroup` - `UUID`	User Group with UserGroup access permission.
`readergroup` - `UUID`	User Group with ReaderGroup access permission.
`schemaId` - `UUID!`	ID of the Schema used to create the Object
`tags` - `[String]`	Tags for Object clusterization

Example

{
  "id": UUID,
  "name": "abc123",
  "enabled": false,
  "description": "xyz789",
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "schemaId": UUID,
  "tags": ["xyz789"]
}

Types

`ObjectPatch`

Represents an update to a Object. Fields that are set will be updated.

Field Name	Description
`id` - `UUID`	Unique Object ID.
`name` - `String`	Object's name.
`enabled` - `Boolean`	Administrative Object's status.
`description` - `String`	Object description
`editorgroup` - `UUID`	User Group with EditorGroup access permission.
`usergroup` - `UUID`	User Group with UserGroup access permission.
`readergroup` - `UUID`	User Group with ReaderGroup access permission.
`schemaId` - `UUID`	ID of the Schema used to create the Object
`tags` - `[String]`	Tags for Object clusterization

Example

{
  "id": UUID,
  "name": "abc123",
  "enabled": true,
  "description": "abc123",
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "schemaId": UUID,
  "tags": ["abc123"]
}

Types

`ObjectPropertiesConnection`

A connection to a list of ObjectProperty values.

Field Name	Description
`nodes` - `[ObjectProperty]!`	A list of `ObjectProperty` objects.
`edges` - `[ObjectPropertiesEdge!]!`	A list of edges which contains the `ObjectProperty` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `ObjectProperty` you could get from the connection.

Example

{
  "nodes": [ObjectProperty],
  "edges": [ObjectPropertiesEdge],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

`ObjectPropertiesEdge`

A ObjectProperty edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `ObjectProperty`	The `ObjectProperty` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": ObjectProperty
}

Types

`ObjectPropertiesHistoriesConnection`

A connection to a list of ObjectPropertiesHistory values.

Field Name	Description
`nodes` - `[ObjectPropertiesHistory]!`	A list of `ObjectPropertiesHistory` objects.
`edges` - `[ObjectPropertiesHistoriesEdge!]!`	A list of edges which contains the `ObjectPropertiesHistory` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `ObjectPropertiesHistory` you could get from the connection.

Example

{
  "nodes": [ObjectPropertiesHistory],
  "edges": [ObjectPropertiesHistoriesEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`ObjectPropertiesHistoriesEdge`

A ObjectPropertiesHistory edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `ObjectPropertiesHistory`	The `ObjectPropertiesHistory` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": ObjectPropertiesHistory
}

Types

`ObjectPropertiesHistoriesOrderBy`

Methods to use when ordering ObjectPropertiesHistory.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`OBJECT_ID_ASC`
`OBJECT_ID_DESC`
`GROUP_NAME_ASC`
`GROUP_NAME_DESC`
`PROPERTY_ASC`
`PROPERTY_DESC`
`VALUE_ASC`
`VALUE_DESC`
`RECORDED_AT_ASC`
`RECORDED_AT_DESC`
`PROPERTY_ID_ASC`
`PROPERTY_ID_DESC`
`BY_ASC`
`BY_DESC`
`TRANSACTION_ID_ASC`
`TRANSACTION_ID_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`ObjectPropertiesHistory`

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `Int!`
`objectId` - `UUID!`
`groupName` - `String!`
`property` - `String!`
`value` - `JSON`
`recordedAt` - `Datetime!`
`propertyId` - `UUID`
`by` - `UUID`
`transactionId` - `BigInt`
`userByBy` - `User`	Reads a single `User` that is related to this `ObjectPropertiesHistory`.
`jsonbValue` - `JSON`

Example

{
  "nodeId": ID,
  "id": 987,
  "objectId": UUID,
  "groupName": "abc123",
  "property": "abc123",
  "value": {},
  "recordedAt": Datetime,
  "propertyId": UUID,
  "by": UUID,
  "transactionId": BigInt,
  "userByBy": User,
  "jsonbValue": {}
}

Types

`ObjectPropertiesHistoryCondition`

A condition to be used against ObjectPropertiesHistory object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`id` - `Int`	Checks for equality with the object’s `id` field.
`objectId` - `UUID`	Checks for equality with the object’s `objectId` field.
`groupName` - `String`	Checks for equality with the object’s `groupName` field.
`property` - `String`	Checks for equality with the object’s `property` field.
`value` - `JSON`	Checks for equality with the object’s `value` field.
`recordedAt` - `Datetime`	Checks for equality with the object’s `recordedAt` field.
`propertyId` - `UUID`	Checks for equality with the object’s `propertyId` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.
`transactionId` - `BigInt`	Checks for equality with the object’s `transactionId` field.

Example

{
  "id": 987,
  "objectId": UUID,
  "groupName": "xyz789",
  "property": "xyz789",
  "value": {},
  "recordedAt": Datetime,
  "propertyId": UUID,
  "by": UUID,
  "transactionId": BigInt
}

Types

`ObjectPropertiesHistoryFilter`

A filter to be used against ObjectPropertiesHistory object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `IntFilter`	Filter by the object’s `id` field.
`objectId` - `UUIDFilter`	Filter by the object’s `objectId` field.
`groupName` - `StringFilter`	Filter by the object’s `groupName` field.
`property` - `StringFilter`	Filter by the object’s `property` field.
`recordedAt` - `DatetimeFilter`	Filter by the object’s `recordedAt` field.
`propertyId` - `UUIDFilter`	Filter by the object’s `propertyId` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`transactionId` - `BigIntFilter`	Filter by the object’s `transactionId` field.
`jsonbValue` - `JSONFilter`	Filter by the object’s `jsonbValue` field.
`userByBy` - `UserFilter`	Filter by the object’s `userByBy` relation.
`userByByExists` - `Boolean`	A related `userByBy` exists.
`and` - `[ObjectPropertiesHistoryFilter!]`	Checks for all expressions in this list.
`or` - `[ObjectPropertiesHistoryFilter!]`	Checks for any expressions in this list.
`not` - `ObjectPropertiesHistoryFilter`	Negates the expression.

Example

{
  "id": IntFilter,
  "objectId": UUIDFilter,
  "groupName": StringFilter,
  "property": StringFilter,
  "recordedAt": DatetimeFilter,
  "propertyId": UUIDFilter,
  "by": UUIDFilter,
  "transactionId": BigIntFilter,
  "jsonbValue": JSONFilter,
  "userByBy": UserFilter,
  "userByByExists": false,
  "and": [ObjectPropertiesHistoryFilter],
  "or": [ObjectPropertiesHistoryFilter],
  "not": ObjectPropertiesHistoryFilter
}

Types

`ObjectPropertiesHistoryInput`

An input for mutations affecting ObjectPropertiesHistory

Input Field	Description
`id` - `Int`
`objectId` - `UUID!`
`groupName` - `String!`
`property` - `String!`
`value` - `JSON`
`recordedAt` - `Datetime!`
`propertyId` - `UUID`
`by` - `UUID`
`transactionId` - `BigInt`

Example

{
  "id": 123,
  "objectId": UUID,
  "groupName": "abc123",
  "property": "xyz789",
  "value": {},
  "recordedAt": Datetime,
  "propertyId": UUID,
  "by": UUID,
  "transactionId": BigInt
}

Types

`ObjectPropertiesHistoryPatch`

Represents an update to a ObjectPropertiesHistory. Fields that are set will be updated.

Input Field	Description
`id` - `Int`
`objectId` - `UUID`
`groupName` - `String`
`property` - `String`
`value` - `JSON`
`recordedAt` - `Datetime`
`propertyId` - `UUID`
`by` - `UUID`
`transactionId` - `BigInt`

Example

{
  "id": 123,
  "objectId": UUID,
  "groupName": "abc123",
  "property": "abc123",
  "value": {},
  "recordedAt": Datetime,
  "propertyId": UUID,
  "by": UUID,
  "transactionId": BigInt
}

Types

`ObjectPropertiesHistorySort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `ObjectPropertiesHistorySortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": ObjectPropertiesHistorySortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`ObjectPropertiesHistorySortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `ObjectPropertiesHistorySortableField`

Example

{"field": ObjectPropertiesHistorySortableField}

Types

`ObjectPropertiesHistorySortableField`

Sortable concrete fields for the ObjectPropertiesHistory type.

Enum Value	Description
`ID`
`OBJECT_ID`
`GROUP_NAME`
`PROPERTY`
`VALUE`
`RECORDED_AT`
`PROPERTY_ID`
`BY`
`TRANSACTION_ID`

Types

`ObjectPropertiesOrderBy`

Methods to use when ordering ObjectProperty.

Enum Value	Description
`NATURAL`
`OBJECT_ID_ASC`
`OBJECT_ID_DESC`
`GROUP_NAME_ASC`
`GROUP_NAME_DESC`
`PROPERTY_ASC`
`PROPERTY_DESC`
`VALUE_ASC`
`VALUE_DESC`
`UPDATED_AT_ASC`
`UPDATED_AT_DESC`
`ID_ASC`
`ID_DESC`
`TRANSACTION_ID_ASC`
`TRANSACTION_ID_DESC`
`LINKED_PROPERTY_ID_ASC`
`LINKED_PROPERTY_ID_DESC`
`INDEX_ASC`
`INDEX_DESC`
`STEALTH_ASC`
`STEALTH_DESC`
`BY_ASC`
`BY_DESC`
`EDITORGROUP_ASC`
`EDITORGROUP_DESC`
`USERGROUP_ASC`
`USERGROUP_DESC`
`READERGROUP_ASC`
`READERGROUP_DESC`
`TYPE_ID_ASC`
`TYPE_ID_DESC`
`PREVIOUS_VALUE_ASC`
`PREVIOUS_VALUE_DESC`
`KEY_ASC`
`KEY_DESC`
`TYPE_ASC`
`TYPE_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`ObjectPropertiesSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `ObjectPropertiesSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": ObjectPropertiesSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`ObjectPropertiesSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `ObjectPropertiesSortableField`

Example

{"field": ObjectPropertiesSortableField}

Types

`ObjectPropertiesSortableField`

Sortable concrete fields for the ObjectProperty type.

Enum Value	Description
`OBJECT_ID`
`GROUP_NAME`
`PROPERTY`
`VALUE`
`UPDATED_AT`
`ID`
`TRANSACTION_ID`
`LINKED_PROPERTY_ID`
`INDEX`
`STEALTH`
`BY`
`EDITORGROUP`
`USERGROUP`
`READERGROUP`
`TYPE_ID`
`PREVIOUS_VALUE`

Types

`ObjectProperty`

Object Properties are used to store individual values of corresponding Object Properties. Object Properties structure is fully controlled by Schemas.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`objectId` - `UUID!`	This Property's Object ID.
`groupName` - `String!`	Group name for Property.
`property` - `String!`	Property name.
`value` - `JSON`	Property value.
`updatedAt` - `Datetime`	Value update timestamp.
`id` - `UUID!`	Property unique ID.
`transactionId` - `BigInt`	Transaction ID indicating a network-level message ID. Might be the same for several properties if a single network message carries multiple values.
`linkedPropertyId` - `UUID`	Property ID which is linked to this Property. If set, when this Property gets updated, the Linked Property value would be automatically updated as well.
`index` - `BigInt!`	Array index.
`stealth` - `Boolean`	If true, this Property would not be saved in Properties' History storage.
`by` - `UUID`
`editorgroup` - `UUID!`
`usergroup` - `UUID!`
`readergroup` - `UUID!`
`typeId` - `UUID!`
`previousValue` - `JSON`	Previous value.
`object` - `Object`	Reads a single `Object` that is related to this `ObjectProperty`.
`linkedProperty` - `ObjectProperty`	Reads a single `ObjectProperty` that is related to this `ObjectProperty`.
`userByBy` - `User`	Reads a single `User` that is related to this `ObjectProperty`.
`objectPropertiesByLinkedPropertyIdConnection` - `ObjectPropertiesConnection!`	Reads and enables pagination through a set of `ObjectProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectPropertiesSort!]` The specification of how the `ObjectProperty` records should be sorted. `orderBy` - `[ObjectPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectProperty`. `condition` - `ObjectPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`objectPropertiesByLinkedPropertyId` - `[ObjectProperty!]!`	Reads and enables pagination through a set of `ObjectProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectPropertiesSort!]` The specification of how the `ObjectProperty` records should be sorted. `orderBy` - `[ObjectPropertiesOrderBy!]` The method to use when ordering `ObjectProperty`. `condition` - `ObjectPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`key` - `String`	Synthetic field: returns single key as a groupName and Property in camelCase format.
`spec` - `SchemaProperty`
`type` - `String`	Synthetic field: returns a property type.

Example

{
  "nodeId": ID,
  "objectId": UUID,
  "groupName": "xyz789",
  "property": "xyz789",
  "value": {},
  "updatedAt": Datetime,
  "id": UUID,
  "transactionId": BigInt,
  "linkedPropertyId": UUID,
  "index": BigInt,
  "stealth": false,
  "by": UUID,
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "typeId": UUID,
  "previousValue": {},
  "object": Object,
  "linkedProperty": ObjectProperty,
  "userByBy": User,
  "objectPropertiesByLinkedPropertyIdConnection": ObjectPropertiesConnection,
  "objectPropertiesByLinkedPropertyId": [ObjectProperty],
  "key": "abc123",
  "spec": SchemaProperty,
  "type": "abc123"
}

Types

`ObjectPropertyChangedFilterType`

Input Field	Description
`groupName` - `String`
`property` - `String`

Example

{"groupName": "xyz789", "property": "abc123"}

Types

`ObjectPropertyCondition`

A condition to be used against ObjectProperty object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`objectId` - `UUID`	Checks for equality with the object’s `objectId` field.
`groupName` - `String`	Checks for equality with the object’s `groupName` field.
`property` - `String`	Checks for equality with the object’s `property` field.
`value` - `JSON`	Checks for equality with the object’s `value` field.
`updatedAt` - `Datetime`	Checks for equality with the object’s `updatedAt` field.
`id` - `UUID`	Checks for equality with the object’s `id` field.
`transactionId` - `BigInt`	Checks for equality with the object’s `transactionId` field.
`linkedPropertyId` - `UUID`	Checks for equality with the object’s `linkedPropertyId` field.
`index` - `BigInt`	Checks for equality with the object’s `index` field.
`stealth` - `Boolean`	Checks for equality with the object’s `stealth` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.
`editorgroup` - `UUID`	Checks for equality with the object’s `editorgroup` field.
`usergroup` - `UUID`	Checks for equality with the object’s `usergroup` field.
`readergroup` - `UUID`	Checks for equality with the object’s `readergroup` field.
`typeId` - `UUID`	Checks for equality with the object’s `typeId` field.
`previousValue` - `JSON`	Checks for equality with the object’s `previousValue` field.
`key` - `String`	Checks for equality with the object’s `key` field.
`type` - `String`	Checks for equality with the object’s `type` field.

Example

{
  "objectId": UUID,
  "groupName": "abc123",
  "property": "xyz789",
  "value": {},
  "updatedAt": Datetime,
  "id": UUID,
  "transactionId": BigInt,
  "linkedPropertyId": UUID,
  "index": BigInt,
  "stealth": false,
  "by": UUID,
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "typeId": UUID,
  "previousValue": {},
  "key": "abc123",
  "type": "abc123"
}

Types

`ObjectPropertyFilter`

A filter to be used against ObjectProperty object types. All fields are combined with a logical ‘and.’

Input Field	Description
`objectId` - `UUIDFilter`	Filter by the object’s `objectId` field.
`groupName` - `StringFilter`	Filter by the object’s `groupName` field.
`property` - `StringFilter`	Filter by the object’s `property` field.
`value` - `JSONFilter`	Filter by the object’s `value` field.
`updatedAt` - `DatetimeFilter`	Filter by the object’s `updatedAt` field.
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`transactionId` - `BigIntFilter`	Filter by the object’s `transactionId` field.
`linkedPropertyId` - `UUIDFilter`	Filter by the object’s `linkedPropertyId` field.
`index` - `BigIntFilter`	Filter by the object’s `index` field.
`stealth` - `BooleanFilter`	Filter by the object’s `stealth` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`editorgroup` - `UUIDFilter`	Filter by the object’s `editorgroup` field.
`usergroup` - `UUIDFilter`	Filter by the object’s `usergroup` field.
`readergroup` - `UUIDFilter`	Filter by the object’s `readergroup` field.
`typeId` - `UUIDFilter`	Filter by the object’s `typeId` field.
`previousValue` - `JSONFilter`	Filter by the object’s `previousValue` field.
`key` - `StringFilter`	Filter by the object’s `key` field.
`type` - `StringFilter`	Filter by the object’s `type` field.
`objectPropertiesByLinkedPropertyIdConnection` - `ObjectPropertyToManyObjectPropertyFilter`	Filter by the object’s `objectPropertiesByLinkedPropertyIdConnection` relation.
`objectPropertiesByLinkedPropertyIdConnectionExist` - `Boolean`	Some related `objectPropertiesByLinkedPropertyIdConnection` exist.
`object` - `ObjectFilter`	Filter by the object’s `object` relation.
`linkedProperty` - `ObjectPropertyFilter`	Filter by the object’s `linkedProperty` relation.
`linkedPropertyExists` - `Boolean`	A related `linkedProperty` exists.
`userByBy` - `UserFilter`	Filter by the object’s `userByBy` relation.
`userByByExists` - `Boolean`	A related `userByBy` exists.
`and` - `[ObjectPropertyFilter!]`	Checks for all expressions in this list.
`or` - `[ObjectPropertyFilter!]`	Checks for any expressions in this list.
`not` - `ObjectPropertyFilter`	Negates the expression.

Example

{
  "objectId": UUIDFilter,
  "groupName": StringFilter,
  "property": StringFilter,
  "value": JSONFilter,
  "updatedAt": DatetimeFilter,
  "id": UUIDFilter,
  "transactionId": BigIntFilter,
  "linkedPropertyId": UUIDFilter,
  "index": BigIntFilter,
  "stealth": BooleanFilter,
  "by": UUIDFilter,
  "editorgroup": UUIDFilter,
  "usergroup": UUIDFilter,
  "readergroup": UUIDFilter,
  "typeId": UUIDFilter,
  "previousValue": JSONFilter,
  "key": StringFilter,
  "type": StringFilter,
  "objectPropertiesByLinkedPropertyIdConnection": ObjectPropertyToManyObjectPropertyFilter,
  "objectPropertiesByLinkedPropertyIdConnectionExist": false,
  "object": ObjectFilter,
  "linkedProperty": ObjectPropertyFilter,
  "linkedPropertyExists": false,
  "userByBy": UserFilter,
  "userByByExists": true,
  "and": [ObjectPropertyFilter],
  "or": [ObjectPropertyFilter],
  "not": ObjectPropertyFilter
}

Types

`ObjectPropertyPatch`

Represents an update to a ObjectProperty. Fields that are set will be updated.

Input Field	Description
`objectId` - `UUID`	This Property's Object ID.
`groupName` - `String`	Group name for Property.
`property` - `String`	Property name.
`value` - `JSON`	Property value.
`id` - `UUID`	Property unique ID.
`linkedPropertyId` - `UUID`	Property ID which is linked to this Property. If set, when this Property gets updated, the Linked Property value would be automatically updated as well.
`stealth` - `Boolean`	If true, this Property would not be saved in Properties' History storage.
`by` - `UUID`
`editorgroup` - `UUID`
`usergroup` - `UUID`
`readergroup` - `UUID`

Example

{
  "objectId": UUID,
  "groupName": "xyz789",
  "property": "xyz789",
  "value": {},
  "id": UUID,
  "linkedPropertyId": UUID,
  "stealth": false,
  "by": UUID,
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID
}

Types

`ObjectPropertyToManyObjectPropertyFilter`

A filter to be used against many ObjectProperty object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ObjectPropertyFilter`	Every related `ObjectProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ObjectPropertyFilter`	Some related `ObjectProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ObjectPropertyFilter`	No related `ObjectProperty` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ObjectPropertyFilter,
  "some": ObjectPropertyFilter,
  "none": ObjectPropertyFilter
}

Types

`ObjectToManyControlExecutionFilter`

A filter to be used against many ControlExecution object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ControlExecutionFilter`	Every related `ControlExecution` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ControlExecutionFilter`	Some related `ControlExecution` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ControlExecutionFilter`	No related `ControlExecution` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ControlExecutionFilter,
  "some": ControlExecutionFilter,
  "none": ControlExecutionFilter
}

Types

`ObjectToManyNotificationDeliveryFilter`

A filter to be used against many NotificationDelivery object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `NotificationDeliveryFilter`	Every related `NotificationDelivery` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `NotificationDeliveryFilter`	Some related `NotificationDelivery` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `NotificationDeliveryFilter`	No related `NotificationDelivery` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": NotificationDeliveryFilter,
  "some": NotificationDeliveryFilter,
  "none": NotificationDeliveryFilter
}

Types

`ObjectToManyNotificationFilter`

A filter to be used against many Notification object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `NotificationFilter`	Every related `Notification` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `NotificationFilter`	Some related `Notification` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `NotificationFilter`	No related `Notification` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": NotificationFilter,
  "some": NotificationFilter,
  "none": NotificationFilter
}

Types

`ObjectToManyObjectPropertyFilter`

A filter to be used against many ObjectProperty object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ObjectPropertyFilter`	Every related `ObjectProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ObjectPropertyFilter`	Some related `ObjectProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ObjectPropertyFilter`	No related `ObjectProperty` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ObjectPropertyFilter,
  "some": ObjectPropertyFilter,
  "none": ObjectPropertyFilter
}

Types

`ObjectToManyObjectsToObjectFilter`

A filter to be used against many ObjectsToObject object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ObjectsToObjectFilter`	Every related `ObjectsToObject` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ObjectsToObjectFilter`	Some related `ObjectsToObject` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ObjectsToObjectFilter`	No related `ObjectsToObject` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ObjectsToObjectFilter,
  "some": ObjectsToObjectFilter,
  "none": ObjectsToObjectFilter
}

Types

`ObjectToManyUserProfileFilter`

A filter to be used against many UserProfile object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `UserProfileFilter`	Every related `UserProfile` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `UserProfileFilter`	Some related `UserProfile` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `UserProfileFilter`	No related `UserProfile` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": UserProfileFilter,
  "some": UserProfileFilter,
  "none": UserProfileFilter
}

Types

`ObjectToManyUsersToObjectFilter`

A filter to be used against many UsersToObject object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `UsersToObjectFilter`	Every related `UsersToObject` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `UsersToObjectFilter`	Some related `UsersToObject` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `UsersToObjectFilter`	No related `UsersToObject` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": UsersToObjectFilter,
  "some": UsersToObjectFilter,
  "none": UsersToObjectFilter
}

Types

`ObjectsConnection`

A connection to a list of Object values.

Field Name	Description
`nodes` - `[Object]!`	A list of `Object` objects.
`edges` - `[ObjectsEdge!]!`	A list of edges which contains the `Object` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `Object` you could get from the connection.

Example

{
  "nodes": [Object],
  "edges": [ObjectsEdge],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

`ObjectsDynamicAttribute`

Input Field	Description
`groupName` - `String`
`property` - `String`
`index` - `BigInt`

Example

{
  "groupName": "abc123",
  "property": "xyz789",
  "index": BigInt
}

Types

`ObjectsDynamicAttributeFilter`

Input Field	Description
`match` - `ObjectsDynamicAttribute!`
`filter` - `JSONFilter!`

Example

{
  "match": ObjectsDynamicAttribute,
  "filter": JSONFilter
}

Types

`ObjectsEdge`

A Object edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `Object`	The `Object` at the end of the edge.

Example

{"cursor": Cursor, "node": Object}

Types

`ObjectsOrderBy`

Methods to use when ordering Object.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`NAME_ASC`
`NAME_DESC`
`ENABLED_ASC`
`ENABLED_DESC`
`DESCRIPTION_ASC`
`DESCRIPTION_DESC`
`EDITORGROUP_ASC`
`EDITORGROUP_DESC`
`USERGROUP_ASC`
`USERGROUP_DESC`
`READERGROUP_ASC`
`READERGROUP_DESC`
`CREATED_AT_ASC`
`CREATED_AT_DESC`
`UPDATED_AT_ASC`
`UPDATED_AT_DESC`
`BY_ASC`
`BY_DESC`
`SCHEMA_ID_ASC`
`SCHEMA_ID_DESC`
`TAGS_ASC`
`TAGS_DESC`
`PREVIOUS_ENABLED_ASC`
`PREVIOUS_ENABLED_DESC`
`DEVICE_BATTERY_LEVEL_ASC`
`DEVICE_BATTERY_LEVEL_DESC`
`DEVICE_BATTERY_TYPE_ASC`
`DEVICE_BATTERY_TYPE_DESC`
`DEVICE_EMULATION_ASC`
`DEVICE_EMULATION_DESC`
`DEVICE_RESPONSE_STATUS_ASC`
`DEVICE_RESPONSE_STATUS_DESC`
`FAVOURITE_ASC`
`FAVOURITE_DESC`
`MEDIA_FILENAME_ASC`
`MEDIA_FILENAME_DESC`
`MEDIA_SIZE_ASC`
`MEDIA_SIZE_DESC`
`MEDIA_TYPE_ASC`
`MEDIA_TYPE_DESC`
`MUTED_ASC`
`MUTED_DESC`
`PROPERTIES_UPDATED_AT_ASC`
`PROPERTIES_UPDATED_AT_DESC`
`SCHEMA_NAME_ASC`
`SCHEMA_NAME_DESC`
`SCHEMA_TYPE_ASC`
`SCHEMA_TYPE_DESC`
`STRING_ID_ASC`
`STRING_ID_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`ObjectsSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `ObjectsSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": ObjectsSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`ObjectsSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `ObjectsSortableField`
`dynamicAttribute` - `ObjectsDynamicAttribute`

Example

{
  "field": ObjectsSortableField,
  "dynamicAttribute": ObjectsDynamicAttribute
}

Types

`ObjectsSortableField`

Sortable concrete fields for the Object type.

Enum Value	Description
`ID`
`NAME`
`ENABLED`
`DESCRIPTION`
`EDITORGROUP`
`USERGROUP`
`READERGROUP`
`CREATED_AT`
`UPDATED_AT`
`BY`
`SCHEMA_ID`
`TAGS`
`PREVIOUS_ENABLED`

Types

`ObjectsToObject`

ObjectsToObject stores Objects to Objects connection information.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`object1Id` - `UUID!`	Object ID connected to.
`object2Id` - `UUID!`	Object ID connecting to.
`id` - `UUID!`	Relation unique ID.
`forced` - `Int`
`object1` - `Object`	Reads a single `Object` that is related to this `ObjectsToObject`.
`object2` - `Object`	Reads a single `Object` that is related to this `ObjectsToObject`.

Example

{
  "nodeId": ID,
  "object1Id": UUID,
  "object2Id": UUID,
  "id": UUID,
  "forced": 123,
  "object1": Object,
  "object2": Object
}

Types

`ObjectsToObjectCondition`

A condition to be used against ObjectsToObject object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`object1Id` - `UUID`	Checks for equality with the object’s `object1Id` field.
`object2Id` - `UUID`	Checks for equality with the object’s `object2Id` field.
`id` - `UUID`	Checks for equality with the object’s `id` field.
`forced` - `Int`	Checks for equality with the object’s `forced` field.

Example

{
  "object1Id": UUID,
  "object2Id": UUID,
  "id": UUID,
  "forced": 123
}

Types

`ObjectsToObjectFilter`

A filter to be used against ObjectsToObject object types. All fields are combined with a logical ‘and.’

Input Field	Description
`object1Id` - `UUIDFilter`	Filter by the object’s `object1Id` field.
`object2Id` - `UUIDFilter`	Filter by the object’s `object2Id` field.
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`forced` - `IntFilter`	Filter by the object’s `forced` field.
`object1` - `ObjectFilter`	Filter by the object’s `object1` relation.
`object2` - `ObjectFilter`	Filter by the object’s `object2` relation.
`and` - `[ObjectsToObjectFilter!]`	Checks for all expressions in this list.
`or` - `[ObjectsToObjectFilter!]`	Checks for any expressions in this list.
`not` - `ObjectsToObjectFilter`	Negates the expression.

Example

{
  "object1Id": UUIDFilter,
  "object2Id": UUIDFilter,
  "id": UUIDFilter,
  "forced": IntFilter,
  "object1": ObjectFilter,
  "object2": ObjectFilter,
  "and": [ObjectsToObjectFilter],
  "or": [ObjectsToObjectFilter],
  "not": ObjectsToObjectFilter
}

Types

`ObjectsToObjectInput`

An input for mutations affecting ObjectsToObject

Input Field	Description
`object1Id` - `UUID!`	Object ID connected to.
`object2Id` - `UUID!`	Object ID connecting to.

Example

{
  "object1Id": UUID,
  "object2Id": UUID
}

Types

`ObjectsToObjectsConnection`

A connection to a list of ObjectsToObject values.

Field Name	Description
`nodes` - `[ObjectsToObject]!`	A list of `ObjectsToObject` objects.
`edges` - `[ObjectsToObjectsEdge!]!`	A list of edges which contains the `ObjectsToObject` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `ObjectsToObject` you could get from the connection.

Example

{
  "nodes": [ObjectsToObject],
  "edges": [ObjectsToObjectsEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`ObjectsToObjectsEdge`

A ObjectsToObject edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `ObjectsToObject`	The `ObjectsToObject` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": ObjectsToObject
}

Types

`ObjectsToObjectsOrderBy`

Methods to use when ordering ObjectsToObject.

Enum Value	Description
`NATURAL`
`OBJECT1_ID_ASC`
`OBJECT1_ID_DESC`
`OBJECT2_ID_ASC`
`OBJECT2_ID_DESC`
`ID_ASC`
`ID_DESC`
`FORCED_ASC`
`FORCED_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`ObjectsToObjectsSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `ObjectsToObjectsSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": ObjectsToObjectsSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`ObjectsToObjectsSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `ObjectsToObjectsSortableField`

Example

{"field": ObjectsToObjectsSortableField}

Types

`ObjectsToObjectsSortableField`

Sortable concrete fields for the ObjectsToObject type.

Enum Value	Description
`OBJECT1_ID`
`OBJECT2_ID`
`ID`
`FORCED`

Types

`PageInfo`

Information about pagination in a connection.

Field Name	Description
`hasNextPage` - `Boolean!`	When paginating forwards, are there more items?
`hasPreviousPage` - `Boolean!`	When paginating backwards, are there more items?
`startCursor` - `Cursor`	When paginating backwards, the cursor to continue.
`endCursor` - `Cursor`	When paginating forwards, the cursor to continue.

Example

{
  "hasNextPage": false,
  "hasPreviousPage": false,
  "startCursor": Cursor,
  "endCursor": Cursor
}

Types

`Property2Input`

Input Field	Description
`groupName` - `String!`
`property` - `String!`

Example

{"groupName": "xyz789", "property": "abc123"}

Types

`PropertyByIdInput`

An input for mutations affecting PropertyById

Input Field	Description
`propertyId` - `UUID`
`value` - `JSON`

Example

{"propertyId": UUID, "value": {}}

Types

`PropertyByKeyInput`

An input for mutations affecting PropertyByKey

Input Field	Description
`propertyKey` - `String`
`value` - `JSON`

Example

{"propertyKey": "abc123", "value": {}}

Types

`PropertyByName2Input`

Input Field	Description
`groupName` - `String!`
`property` - `String!`
`value` - `JSON`
`ts` - `Datetime`

Example

{
  "groupName": "abc123",
  "property": "abc123",
  "value": {},
  "ts": Datetime
}

Types

`PropertyByNameInput`

An input for mutations affecting PropertyByName

Input Field	Description
`groupName` - `String`
`property` - `String`
`value` - `JSON`
`ts` - `Datetime`

Example

{
  "groupName": "xyz789",
  "property": "xyz789",
  "value": {},
  "ts": Datetime
}

Types

`PropertyLinkInput`

An input for mutations affecting PropertyLink

Input Field	Description
`sourceObjectId` - `UUID`
`sourceGroupName` - `String`
`sourceProperty` - `String`
`destSchemaId` - `UUID`
`destGroupName` - `String`
`destProperty` - `String`

Example

{
  "sourceObjectId": UUID,
  "sourceGroupName": "xyz789",
  "sourceProperty": "abc123",
  "destSchemaId": UUID,
  "destGroupName": "xyz789",
  "destProperty": "xyz789"
}

Types

`PropertyType`

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`	Type id.
`name` - `String!`	Type name (must be unique)
`description` - `String`	Type description.
`schema` - `JSON`	JSON Schema to be used to validate input for that type. If NULL - no validation happens.
`schemaPropertiesByTypeIdConnection` - `SchemaPropertiesConnection!`	Reads and enables pagination through a set of `SchemaProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemaPropertiesSort!]` The specification of how the `SchemaProperty` records should be sorted. `orderBy` - `[SchemaPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaProperty`. `condition` - `SchemaPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`schemaPropertiesByTypeId` - `[SchemaProperty!]!`	Reads and enables pagination through a set of `SchemaProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemaPropertiesSort!]` The specification of how the `SchemaProperty` records should be sorted. `orderBy` - `[SchemaPropertiesOrderBy!]` The method to use when ordering `SchemaProperty`. `condition` - `SchemaPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaPropertyFilter` A filter to be used in determining which values should be returned by the collection.

Example

{
  "nodeId": ID,
  "id": UUID,
  "name": "abc123",
  "description": "abc123",
  "schema": {},
  "schemaPropertiesByTypeIdConnection": SchemaPropertiesConnection,
  "schemaPropertiesByTypeId": [SchemaProperty]
}

Types

`PropertyTypeCondition`

A condition to be used against PropertyType object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`name` - `String`	Checks for equality with the object’s `name` field.
`description` - `String`	Checks for equality with the object’s `description` field.
`schema` - `JSON`	Checks for equality with the object’s `schema` field.

Example

{
  "id": UUID,
  "name": "xyz789",
  "description": "xyz789",
  "schema": {}
}

Types

`PropertyTypeFilter`

A filter to be used against PropertyType object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`name` - `StringFilter`	Filter by the object’s `name` field.
`description` - `StringFilter`	Filter by the object’s `description` field.
`schema` - `JSONFilter`	Filter by the object’s `schema` field.
`schemaPropertiesByTypeIdConnection` - `PropertyTypeToManySchemaPropertyFilter`	Filter by the object’s `schemaPropertiesByTypeIdConnection` relation.
`schemaPropertiesByTypeIdConnectionExist` - `Boolean`	Some related `schemaPropertiesByTypeIdConnection` exist.
`and` - `[PropertyTypeFilter!]`	Checks for all expressions in this list.
`or` - `[PropertyTypeFilter!]`	Checks for any expressions in this list.
`not` - `PropertyTypeFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "name": StringFilter,
  "description": StringFilter,
  "schema": JSONFilter,
  "schemaPropertiesByTypeIdConnection": PropertyTypeToManySchemaPropertyFilter,
  "schemaPropertiesByTypeIdConnectionExist": false,
  "and": [PropertyTypeFilter],
  "or": [PropertyTypeFilter],
  "not": PropertyTypeFilter
}

Types

`PropertyTypeInput`

An input for mutations affecting PropertyType

Input Field	Description
`id` - `UUID`	Type id.
`name` - `String!`	Type name (must be unique)
`description` - `String`	Type description.
`schema` - `JSON`	JSON Schema to be used to validate input for that type. If NULL - no validation happens.

Example

{
  "id": UUID,
  "name": "xyz789",
  "description": "xyz789",
  "schema": {}
}

Types

`PropertyTypePatch`

Represents an update to a PropertyType. Fields that are set will be updated.

Input Field	Description
`id` - `UUID`	Type id.
`name` - `String`	Type name (must be unique)
`description` - `String`	Type description.
`schema` - `JSON`	JSON Schema to be used to validate input for that type. If NULL - no validation happens.

Example

{
  "id": UUID,
  "name": "abc123",
  "description": "xyz789",
  "schema": {}
}

Types

`PropertyTypeToManySchemaPropertyFilter`

A filter to be used against many SchemaProperty object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `SchemaPropertyFilter`	Every related `SchemaProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `SchemaPropertyFilter`	Some related `SchemaProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `SchemaPropertyFilter`	No related `SchemaProperty` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": SchemaPropertyFilter,
  "some": SchemaPropertyFilter,
  "none": SchemaPropertyFilter
}

Types

`PropertyTypesConnection`

A connection to a list of PropertyType values.

Field Name	Description
`nodes` - `[PropertyType]!`	A list of `PropertyType` objects.
`edges` - `[PropertyTypesEdge!]!`	A list of edges which contains the `PropertyType` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `PropertyType` you could get from the connection.

Example

{
  "nodes": [PropertyType],
  "edges": [PropertyTypesEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`PropertyTypesEdge`

A PropertyType edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `PropertyType`	The `PropertyType` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": PropertyType
}

Types

`PropertyTypesOrderBy`

Methods to use when ordering PropertyType.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`NAME_ASC`
`NAME_DESC`
`DESCRIPTION_ASC`
`DESCRIPTION_DESC`
`SCHEMA_ASC`
`SCHEMA_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`PropertyTypesSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `PropertyTypesSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": PropertyTypesSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`PropertyTypesSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `PropertyTypesSortableField`

Example

{"field": PropertyTypesSortableField}

Types

`PropertyTypesSortableField`

Sortable concrete fields for the PropertyType type.

Enum Value	Description
`ID`
`NAME`
`DESCRIPTION`
`SCHEMA`

Types

`RefreshToken`

Field Name	Description
`token` - `String`
`id` - `BigInt`
`userId` - `UUID`
`twoFa` - `TwoFa`
`license` - `License`

Example

{
  "token": "abc123",
  "id": BigInt,
  "userId": UUID,
  "twoFa": TwoFa,
  "license": License
}

Types

`ResetPropertyInput`

All input for the resetProperty mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`transactionId` - `BigInt`
`propertyId` - `UUID`

Example

{
  "clientMutationId": "xyz789",
  "transactionId": BigInt,
  "propertyId": UUID
}

Types

`ResetPropertyPayload`

The output of our resetProperty mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "xyz789", "boolean": true}

Types

`ResolveObjectPermissionsInput`

All input for the resolveObjectPermissions mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectId` - `UUID`
`userId` - `UUID`

Example

{
  "clientMutationId": "abc123",
  "objectId": UUID,
  "userId": UUID
}

Types

`ResolveObjectPermissionsPayload`

The output of our resolveObjectPermissions mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`accessRight` - `AccessRight`

Example

{"clientMutationId": "xyz789", "accessRight": AccessRight}

Types

`RpcResult`

Field Name	Description
`done` - `Boolean`
`ack` - `Boolean`
`progress` - `JSON`
`error` - `String`

Example

{
  "done": false,
  "ack": false,
  "progress": {},
  "error": "abc123"
}

Types

`Schema`

Schema is a second important data type within the platform. It describes which Properties and RPC/Controls would be supported by Objects instantiated from it.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`	Schema unique ID.
`name` - `String!`	Schema name.
`applicationOwner` - `UUID`	User ID of the Application responsible for RPC/Controls of this Schema (Schema Application Owner).
`type` - `SchemaTypes!`	Schema type (DEVICE/MEDIA/DATASET/other).
`enabled` - `Boolean!`	Administrative Schema's status.
`defaultTtl` - `Interval`	true
`description` - `String`	Schema description.
`mLongname` - `String`	Schema long name meta information.
`mVersion` - `String`	Schema version meta information.
`mManufacturer` - `String`	Schema manufacturer name meta information.
`mAuthor` - `String`	Schema author name meta information.
`mEmail` - `String`	Schema author's email meta information.
`mExternalId` - `UUID`	User ID in the external system meta information.
`editorgroup` - `UUID!`	User Group with EditorGroup access permission.
`usergroup` - `UUID!`	User Group with UserGroup access permission.
`readergroup` - `UUID!`	User Group with ReaderGroup access permission.
`createdAt` - `Datetime!`	Schema creation timestamp.
`updatedAt` - `Datetime!`	Schema last update timestamp.
`by` - `UUID`	User last updated the Schema.
`mTags` - `[String]`	Tags for Schema clusterization
`mPicture` - `String`	Schema picture in base64.
`mIcon` - `String`	Schema icon in base64.
`parentSchemaId` - `UUID`
`userByApplicationOwner` - `User`	Reads a single `User` that is related to this `Schema`.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userByBy` - `User`	Reads a single `User` that is related to this `Schema`.
`parentSchema` - `Schema`	Reads a single `Schema` that is related to this `Schema`.
`schemaPropertiesConnection` - `SchemaPropertiesConnection!`	Reads and enables pagination through a set of `SchemaProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemaPropertiesSort!]` The specification of how the `SchemaProperty` records should be sorted. `orderBy` - `[SchemaPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaProperty`. `condition` - `SchemaPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`schemaProperties` - `[SchemaProperty!]!`	Reads and enables pagination through a set of `SchemaProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemaPropertiesSort!]` The specification of how the `SchemaProperty` records should be sorted. `orderBy` - `[SchemaPropertiesOrderBy!]` The method to use when ordering `SchemaProperty`. `condition` - `SchemaPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`objectsConnection` - `ObjectsConnection!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objects` - `[Object!]!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`schemaControlsConnection` - `SchemaControlsConnection!`	Reads and enables pagination through a set of `SchemaControl`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemaControlsSort!]` The specification of how the `SchemaControl` records should be sorted. `orderBy` - `[SchemaControlsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaControl`. `condition` - `SchemaControlCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaControlFilter` A filter to be used in determining which values should be returned by the collection.
`schemaControls` - `[SchemaControl!]!`	Reads and enables pagination through a set of `SchemaControl`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemaControlsSort!]` The specification of how the `SchemaControl` records should be sorted. `orderBy` - `[SchemaControlsOrderBy!]` The method to use when ordering `SchemaControl`. `condition` - `SchemaControlCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaControlFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByParentSchemaIdConnection` - `SchemataConnection!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByParentSchemaId` - `[Schema!]!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`groupName` - `String`	Synthetic field: returns user group name based on the provided group type ("editorgroup/usergroup/readergroup") for this schema.
Arguments `groupName` - `String`
`objectsCount` - `Int`	Synthetic field: returns a total number of objects created from this schema.
`parentSchemaName` - `String`	Synthetic field: returns name of parent schema if any.
`property` - `JSON`	Synthetic field: returns default property value based on the provided property name in the format "group_name/property_name".
Arguments `propertyName` - `String`

Example

{
  "nodeId": ID,
  "id": UUID,
  "name": "xyz789",
  "applicationOwner": UUID,
  "type": SchemaTypes,
  "enabled": false,
  "defaultTtl": Interval,
  "description": "abc123",
  "mLongname": "xyz789",
  "mVersion": "abc123",
  "mManufacturer": "abc123",
  "mAuthor": "xyz789",
  "mEmail": "abc123",
  "mExternalId": UUID,
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "mTags": ["abc123"],
  "mPicture": "abc123",
  "mIcon": "xyz789",
  "parentSchemaId": UUID,
  "userByApplicationOwner": User,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "parentSchema": Schema,
  "schemaPropertiesConnection": SchemaPropertiesConnection,
  "schemaProperties": [SchemaProperty],
  "objectsConnection": ObjectsConnection,
  "objects": [Object],
  "schemaControlsConnection": SchemaControlsConnection,
  "schemaControls": [SchemaControl],
  "schemataByParentSchemaIdConnection": SchemataConnection,
  "schemataByParentSchemaId": [Schema],
  "groupName": "abc123",
  "objectsCount": 123,
  "parentSchemaName": "xyz789",
  "property": {}
}

Types

`SchemaCondition`

A condition to be used against Schema object types. All fields are tested for equality and combined with a logical ‘and.’

Field Name	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`name` - `String`	Checks for equality with the object’s `name` field.
`applicationOwner` - `UUID`	Checks for equality with the object’s `applicationOwner` field.
`type` - `SchemaTypes`	Checks for equality with the object’s `type` field.
`enabled` - `Boolean`	Checks for equality with the object’s `enabled` field.
`defaultTtl` - `IntervalInput`	Checks for equality with the object’s `defaultTtl` field.
`description` - `String`	Checks for equality with the object’s `description` field.
`mLongname` - `String`	Checks for equality with the object’s `mLongname` field.
`mVersion` - `String`	Checks for equality with the object’s `mVersion` field.
`mManufacturer` - `String`	Checks for equality with the object’s `mManufacturer` field.
`mAuthor` - `String`	Checks for equality with the object’s `mAuthor` field.
`mEmail` - `String`	Checks for equality with the object’s `mEmail` field.
`mExternalId` - `UUID`	Checks for equality with the object’s `mExternalId` field.
`editorgroup` - `UUID`	Checks for equality with the object’s `editorgroup` field.
`usergroup` - `UUID`	Checks for equality with the object’s `usergroup` field.
`readergroup` - `UUID`	Checks for equality with the object’s `readergroup` field.
`createdAt` - `Datetime`	Checks for equality with the object’s `createdAt` field.
`updatedAt` - `Datetime`	Checks for equality with the object’s `updatedAt` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.
`mTags` - `[String]`	Checks for equality with the object’s `mTags` field.
`mPicture` - `String`	Checks for equality with the object’s `mPicture` field.
`mIcon` - `String`	Checks for equality with the object’s `mIcon` field.
`parentSchemaId` - `UUID`	Checks for equality with the object’s `parentSchemaId` field.
`objectsCount` - `Int`	Checks for equality with the object’s `objectsCount` field.
`parentSchemaName` - `String`	Checks for equality with the object’s `parentSchemaName` field.

Example

{
  "id": UUID,
  "name": "abc123",
  "applicationOwner": UUID,
  "type": SchemaTypes,
  "enabled": true,
  "defaultTtl": IntervalInput,
  "description": "abc123",
  "mLongname": "xyz789",
  "mVersion": "xyz789",
  "mManufacturer": "xyz789",
  "mAuthor": "abc123",
  "mEmail": "xyz789",
  "mExternalId": UUID,
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "mTags": ["xyz789"],
  "mPicture": "abc123",
  "mIcon": "xyz789",
  "parentSchemaId": UUID,
  "objectsCount": 123,
  "parentSchemaName": "abc123"
}

Types

`SchemaControl`

Schema Control represents RPC/Controls methods which can be called within Objects instantiated from this Schema.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`	Schema Controls unique ID.
`rpc` - `String!`	RPC/Control function name.
`description` - `String`	RPC/Control function description.
`argument` - `String!`	RPC/Control function Argument name.
`typeSpec` - `String!`	RPC/Control function Argument type.
`hidden` - `Boolean!`	true
`schemaId` - `UUID!`	RPC/Control's Schema ID it belongs to.
`units` - `String`	Control argument units indication.
`regex` - `String`	Control argument regex for validation.
`valueRange` - `JSON`	Control argument supported value range.
`valueSet` - `JSON`	Control argument set of possible values.
`mask` - `String`	Control argument input mask.
`defaultValue` - `JSON`	Control argument default value.
`createdAt` - `Datetime!`	Control creation timestamp.
`updatedAt` - `Datetime!`	Control last update timestamp.
`by` - `UUID`	User last updated the Control.
`notNull` - `Boolean!`
`schema` - `Schema`	Reads a single `Schema` that is related to this `SchemaControl`.
`userByBy` - `User`	Reads a single `User` that is related to this `SchemaControl`.
`argumentDefault` - `String`
Arguments `objectId` - `UUID`
`isRpc` - `Boolean`

Example

{
  "nodeId": ID,
  "id": UUID,
  "rpc": "abc123",
  "description": "xyz789",
  "argument": "xyz789",
  "typeSpec": "abc123",
  "hidden": false,
  "schemaId": UUID,
  "units": "abc123",
  "regex": "abc123",
  "valueRange": {},
  "valueSet": {},
  "mask": "abc123",
  "defaultValue": {},
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "notNull": true,
  "schema": Schema,
  "userByBy": User,
  "argumentDefault": "xyz789",
  "isRpc": true
}

Types

`SchemaControlCondition`

A condition to be used against SchemaControl object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`rpc` - `String`	Checks for equality with the object’s `rpc` field.
`description` - `String`	Checks for equality with the object’s `description` field.
`argument` - `String`	Checks for equality with the object’s `argument` field.
`typeSpec` - `String`	Checks for equality with the object’s `typeSpec` field.
`hidden` - `Boolean`	Checks for equality with the object’s `hidden` field.
`schemaId` - `UUID`	Checks for equality with the object’s `schemaId` field.
`units` - `String`	Checks for equality with the object’s `units` field.
`regex` - `String`	Checks for equality with the object’s `regex` field.
`valueRange` - `JSON`	Checks for equality with the object’s `valueRange` field.
`valueSet` - `JSON`	Checks for equality with the object’s `valueSet` field.
`mask` - `String`	Checks for equality with the object’s `mask` field.
`defaultValue` - `JSON`	Checks for equality with the object’s `defaultValue` field.
`createdAt` - `Datetime`	Checks for equality with the object’s `createdAt` field.
`updatedAt` - `Datetime`	Checks for equality with the object’s `updatedAt` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.
`notNull` - `Boolean`	Checks for equality with the object’s `notNull` field.

Example

{
  "id": UUID,
  "rpc": "xyz789",
  "description": "abc123",
  "argument": "xyz789",
  "typeSpec": "xyz789",
  "hidden": false,
  "schemaId": UUID,
  "units": "abc123",
  "regex": "xyz789",
  "valueRange": {},
  "valueSet": {},
  "mask": "abc123",
  "defaultValue": {},
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "notNull": true
}

Types

`SchemaControlFilter`

A filter to be used against SchemaControl object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`rpc` - `StringFilter`	Filter by the object’s `rpc` field.
`description` - `StringFilter`	Filter by the object’s `description` field.
`argument` - `StringFilter`	Filter by the object’s `argument` field.
`typeSpec` - `StringFilter`	Filter by the object’s `typeSpec` field.
`hidden` - `BooleanFilter`	Filter by the object’s `hidden` field.
`schemaId` - `UUIDFilter`	Filter by the object’s `schemaId` field.
`units` - `StringFilter`	Filter by the object’s `units` field.
`regex` - `StringFilter`	Filter by the object’s `regex` field.
`valueRange` - `JSONFilter`	Filter by the object’s `valueRange` field.
`valueSet` - `JSONFilter`	Filter by the object’s `valueSet` field.
`mask` - `StringFilter`	Filter by the object’s `mask` field.
`defaultValue` - `JSONFilter`	Filter by the object’s `defaultValue` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`updatedAt` - `DatetimeFilter`	Filter by the object’s `updatedAt` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`notNull` - `BooleanFilter`	Filter by the object’s `notNull` field.
`isRpc` - `BooleanFilter`	Filter by the object’s `isRpc` field.
`schema` - `SchemaFilter`	Filter by the object’s `schema` relation.
`userByBy` - `UserFilter`	Filter by the object’s `userByBy` relation.
`userByByExists` - `Boolean`	A related `userByBy` exists.
`and` - `[SchemaControlFilter!]`	Checks for all expressions in this list.
`or` - `[SchemaControlFilter!]`	Checks for any expressions in this list.
`not` - `SchemaControlFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "rpc": StringFilter,
  "description": StringFilter,
  "argument": StringFilter,
  "typeSpec": StringFilter,
  "hidden": BooleanFilter,
  "schemaId": UUIDFilter,
  "units": StringFilter,
  "regex": StringFilter,
  "valueRange": JSONFilter,
  "valueSet": JSONFilter,
  "mask": StringFilter,
  "defaultValue": JSONFilter,
  "createdAt": DatetimeFilter,
  "updatedAt": DatetimeFilter,
  "by": UUIDFilter,
  "notNull": BooleanFilter,
  "isRpc": BooleanFilter,
  "schema": SchemaFilter,
  "userByBy": UserFilter,
  "userByByExists": false,
  "and": [SchemaControlFilter],
  "or": [SchemaControlFilter],
  "not": SchemaControlFilter
}

Types

`SchemaControlInput`

An input for mutations affecting SchemaControl

Input Field	Description
`id` - `UUID`	Schema Controls unique ID.
`rpc` - `String!`	RPC/Control function name.
`description` - `String`	RPC/Control function description.
`argument` - `String!`	RPC/Control function Argument name.
`typeSpec` - `String!`	RPC/Control function Argument type.
`hidden` - `Boolean`
`schemaId` - `UUID!`	RPC/Control's Schema ID it belongs to.
`units` - `String`	Control argument units indication.
`regex` - `String`	Control argument regex for validation.
`valueRange` - `JSON`	Control argument supported value range.
`valueSet` - `JSON`	Control argument set of possible values.
`mask` - `String`	Control argument input mask.
`defaultValue` - `JSON`	Control argument default value.
`notNull` - `Boolean`

Example

{
  "id": UUID,
  "rpc": "abc123",
  "description": "xyz789",
  "argument": "xyz789",
  "typeSpec": "xyz789",
  "hidden": true,
  "schemaId": UUID,
  "units": "abc123",
  "regex": "xyz789",
  "valueRange": {},
  "valueSet": {},
  "mask": "abc123",
  "defaultValue": {},
  "notNull": false
}

Types

`SchemaControlPatch`

Represents an update to a SchemaControl. Fields that are set will be updated.

Input Field	Description
`id` - `UUID`	Schema Controls unique ID.
`rpc` - `String`	RPC/Control function name.
`description` - `String`	RPC/Control function description.
`argument` - `String`	RPC/Control function Argument name.
`typeSpec` - `String`	RPC/Control function Argument type.
`hidden` - `Boolean`
`schemaId` - `UUID`	RPC/Control's Schema ID it belongs to.
`units` - `String`	Control argument units indication.
`regex` - `String`	Control argument regex for validation.
`valueRange` - `JSON`	Control argument supported value range.
`valueSet` - `JSON`	Control argument set of possible values.
`mask` - `String`	Control argument input mask.
`defaultValue` - `JSON`	Control argument default value.
`notNull` - `Boolean`

Example

{
  "id": UUID,
  "rpc": "xyz789",
  "description": "xyz789",
  "argument": "xyz789",
  "typeSpec": "xyz789",
  "hidden": false,
  "schemaId": UUID,
  "units": "abc123",
  "regex": "xyz789",
  "valueRange": {},
  "valueSet": {},
  "mask": "xyz789",
  "defaultValue": {},
  "notNull": false
}

Types

`SchemaControlsConnection`

A connection to a list of SchemaControl values.

Field Name	Description
`nodes` - `[SchemaControl]!`	A list of `SchemaControl` objects.
`edges` - `[SchemaControlsEdge!]!`	A list of edges which contains the `SchemaControl` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `SchemaControl` you could get from the connection.

Example

{
  "nodes": [SchemaControl],
  "edges": [SchemaControlsEdge],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

`SchemaControlsEdge`

A SchemaControl edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `SchemaControl`	The `SchemaControl` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": SchemaControl
}

Types

`SchemaControlsOrderBy`

Methods to use when ordering SchemaControl.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`RPC_ASC`
`RPC_DESC`
`DESCRIPTION_ASC`
`DESCRIPTION_DESC`
`ARGUMENT_ASC`
`ARGUMENT_DESC`
`TYPE_SPEC_ASC`
`TYPE_SPEC_DESC`
`HIDDEN_ASC`
`HIDDEN_DESC`
`SCHEMA_ID_ASC`
`SCHEMA_ID_DESC`
`UNITS_ASC`
`UNITS_DESC`
`REGEX_ASC`
`REGEX_DESC`
`VALUE_RANGE_ASC`
`VALUE_RANGE_DESC`
`VALUE_SET_ASC`
`VALUE_SET_DESC`
`MASK_ASC`
`MASK_DESC`
`DEFAULT_VALUE_ASC`
`DEFAULT_VALUE_DESC`
`CREATED_AT_ASC`
`CREATED_AT_DESC`
`UPDATED_AT_ASC`
`UPDATED_AT_DESC`
`BY_ASC`
`BY_DESC`
`NOT_NULL_ASC`
`NOT_NULL_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`SchemaControlsSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `SchemaControlsSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": SchemaControlsSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`SchemaControlsSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `SchemaControlsSortableField`

Example

{"field": SchemaControlsSortableField}

Types

`SchemaControlsSortableField`

Sortable concrete fields for the SchemaControl type.

Enum Value	Description
`ID`
`RPC`
`DESCRIPTION`
`ARGUMENT`
`TYPE_SPEC`
`HIDDEN`
`SCHEMA_ID`
`UNITS`
`REGEX`
`VALUE_RANGE`
`VALUE_SET`
`MASK`
`DEFAULT_VALUE`
`CREATED_AT`
`UPDATED_AT`
`BY`
`NOT_NULL`

Types

`SchemaFilter`

A filter to be used against Schema object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`name` - `StringFilter`	Filter by the object’s `name` field.
`applicationOwner` - `UUIDFilter`	Filter by the object’s `applicationOwner` field.
`type` - `SchemaTypesFilter`	Filter by the object’s `type` field.
`enabled` - `BooleanFilter`	Filter by the object’s `enabled` field.
`defaultTtl` - `IntervalFilter`	Filter by the object’s `defaultTtl` field.
`description` - `StringFilter`	Filter by the object’s `description` field.
`mLongname` - `StringFilter`	Filter by the object’s `mLongname` field.
`mVersion` - `StringFilter`	Filter by the object’s `mVersion` field.
`mManufacturer` - `StringFilter`	Filter by the object’s `mManufacturer` field.
`mAuthor` - `StringFilter`	Filter by the object’s `mAuthor` field.
`mEmail` - `StringFilter`	Filter by the object’s `mEmail` field.
`mExternalId` - `UUIDFilter`	Filter by the object’s `mExternalId` field.
`editorgroup` - `UUIDFilter`	Filter by the object’s `editorgroup` field.
`usergroup` - `UUIDFilter`	Filter by the object’s `usergroup` field.
`readergroup` - `UUIDFilter`	Filter by the object’s `readergroup` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`updatedAt` - `DatetimeFilter`	Filter by the object’s `updatedAt` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`mTags` - `StringListFilter`	Filter by the object’s `mTags` field.
`mPicture` - `StringFilter`	Filter by the object’s `mPicture` field.
`mIcon` - `StringFilter`	Filter by the object’s `mIcon` field.
`parentSchemaId` - `UUIDFilter`	Filter by the object’s `parentSchemaId` field.
`objectsCount` - `IntFilter`	Filter by the object’s `objectsCount` field.
`parentSchemaName` - `StringFilter`	Filter by the object’s `parentSchemaName` field.
`schemaPropertiesConnection` - `SchemaToManySchemaPropertyFilter`	Filter by the object’s `schemaPropertiesConnection` relation.
`schemaPropertiesConnectionExist` - `Boolean`	Some related `schemaPropertiesConnection` exist.
`objectsConnection` - `SchemaToManyObjectFilter`	Filter by the object’s `objectsConnection` relation.
`objectsConnectionExist` - `Boolean`	Some related `objectsConnection` exist.
`schemaControlsConnection` - `SchemaToManySchemaControlFilter`	Filter by the object’s `schemaControlsConnection` relation.
`schemaControlsConnectionExist` - `Boolean`	Some related `schemaControlsConnection` exist.
`schemataByParentSchemaIdConnection` - `SchemaToManySchemaFilter`	Filter by the object’s `schemataByParentSchemaIdConnection` relation.
`schemataByParentSchemaIdConnectionExist` - `Boolean`	Some related `schemataByParentSchemaIdConnection` exist.
`userByApplicationOwner` - `UserFilter`	Filter by the object’s `userByApplicationOwner` relation.
`userByApplicationOwnerExists` - `Boolean`	A related `userByApplicationOwner` exists.
`userGroupByEditorgroup` - `UserGroupFilter`	Filter by the object’s `userGroupByEditorgroup` relation.
`userGroupByUsergroup` - `UserGroupFilter`	Filter by the object’s `userGroupByUsergroup` relation.
`userGroupByReadergroup` - `UserGroupFilter`	Filter by the object’s `userGroupByReadergroup` relation.
`userByBy` - `UserFilter`	Filter by the object’s `userByBy` relation.
`userByByExists` - `Boolean`	A related `userByBy` exists.
`parentSchema` - `SchemaFilter`	Filter by the object’s `parentSchema` relation.
`parentSchemaExists` - `Boolean`	A related `parentSchema` exists.
`and` - `[SchemaFilter!]`	Checks for all expressions in this list.
`or` - `[SchemaFilter!]`	Checks for any expressions in this list.
`not` - `SchemaFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "name": StringFilter,
  "applicationOwner": UUIDFilter,
  "type": SchemaTypesFilter,
  "enabled": BooleanFilter,
  "defaultTtl": IntervalFilter,
  "description": StringFilter,
  "mLongname": StringFilter,
  "mVersion": StringFilter,
  "mManufacturer": StringFilter,
  "mAuthor": StringFilter,
  "mEmail": StringFilter,
  "mExternalId": UUIDFilter,
  "editorgroup": UUIDFilter,
  "usergroup": UUIDFilter,
  "readergroup": UUIDFilter,
  "createdAt": DatetimeFilter,
  "updatedAt": DatetimeFilter,
  "by": UUIDFilter,
  "mTags": StringListFilter,
  "mPicture": StringFilter,
  "mIcon": StringFilter,
  "parentSchemaId": UUIDFilter,
  "objectsCount": IntFilter,
  "parentSchemaName": StringFilter,
  "schemaPropertiesConnection": SchemaToManySchemaPropertyFilter,
  "schemaPropertiesConnectionExist": false,
  "objectsConnection": SchemaToManyObjectFilter,
  "objectsConnectionExist": false,
  "schemaControlsConnection": SchemaToManySchemaControlFilter,
  "schemaControlsConnectionExist": true,
  "schemataByParentSchemaIdConnection": SchemaToManySchemaFilter,
  "schemataByParentSchemaIdConnectionExist": true,
  "userByApplicationOwner": UserFilter,
  "userByApplicationOwnerExists": false,
  "userGroupByEditorgroup": UserGroupFilter,
  "userGroupByUsergroup": UserGroupFilter,
  "userGroupByReadergroup": UserGroupFilter,
  "userByBy": UserFilter,
  "userByByExists": true,
  "parentSchema": SchemaFilter,
  "parentSchemaExists": true,
  "and": [SchemaFilter],
  "or": [SchemaFilter],
  "not": SchemaFilter
}

Types

`SchemaInput`

An input for mutations affecting Schema

Field Name	Description
`id` - `UUID`	Schema unique ID.
`name` - `String!`	Schema name.
`applicationOwner` - `UUID`	User ID of the Application responsible for RPC/Controls of this Schema (Schema Application Owner).
`type` - `SchemaTypes!`	Schema type (DEVICE/MEDIA/DATASET/other).
`enabled` - `Boolean`	Administrative Schema's status.
`defaultTtl` - `IntervalInput`
`description` - `String`	Schema description.
`mLongname` - `String`	Schema long name meta information.
`mVersion` - `String`	Schema version meta information.
`mManufacturer` - `String`	Schema manufacturer name meta information.
`mAuthor` - `String`	Schema author name meta information.
`mEmail` - `String`	Schema author's email meta information.
`mExternalId` - `UUID`	User ID in the external system meta information.
`editorgroup` - `UUID`	User Group with EditorGroup access permission.
`usergroup` - `UUID`	User Group with UserGroup access permission.
`readergroup` - `UUID`	User Group with ReaderGroup access permission.
`mTags` - `[String]`	Tags for Schema clusterization
`mPicture` - `String`	Schema picture in base64.
`mIcon` - `String`	Schema icon in base64.
`parentSchemaId` - `UUID`

Example

{
  "id": UUID,
  "name": "xyz789",
  "applicationOwner": UUID,
  "type": SchemaTypes,
  "enabled": false,
  "defaultTtl": IntervalInput,
  "description": "abc123",
  "mLongname": "xyz789",
  "mVersion": "xyz789",
  "mManufacturer": "xyz789",
  "mAuthor": "xyz789",
  "mEmail": "abc123",
  "mExternalId": UUID,
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "mTags": ["xyz789"],
  "mPicture": "xyz789",
  "mIcon": "xyz789",
  "parentSchemaId": UUID
}

Types

`SchemaPatch`

Represents an update to a Schema. Fields that are set will be updated.

Field Name	Description
`id` - `UUID`	Schema unique ID.
`name` - `String`	Schema name.
`applicationOwner` - `UUID`	User ID of the Application responsible for RPC/Controls of this Schema (Schema Application Owner).
`type` - `SchemaTypes`	Schema type (DEVICE/MEDIA/DATASET/other).
`enabled` - `Boolean`	Administrative Schema's status.
`defaultTtl` - `IntervalInput`
`description` - `String`	Schema description.
`mLongname` - `String`	Schema long name meta information.
`mVersion` - `String`	Schema version meta information.
`mManufacturer` - `String`	Schema manufacturer name meta information.
`mAuthor` - `String`	Schema author name meta information.
`mEmail` - `String`	Schema author's email meta information.
`mExternalId` - `UUID`	User ID in the external system meta information.
`editorgroup` - `UUID`	User Group with EditorGroup access permission.
`usergroup` - `UUID`	User Group with UserGroup access permission.
`readergroup` - `UUID`	User Group with ReaderGroup access permission.
`mTags` - `[String]`	Tags for Schema clusterization
`mPicture` - `String`	Schema picture in base64.
`mIcon` - `String`	Schema icon in base64.
`parentSchemaId` - `UUID`

Example

{
  "id": UUID,
  "name": "xyz789",
  "applicationOwner": UUID,
  "type": SchemaTypes,
  "enabled": false,
  "defaultTtl": IntervalInput,
  "description": "abc123",
  "mLongname": "abc123",
  "mVersion": "abc123",
  "mManufacturer": "abc123",
  "mAuthor": "xyz789",
  "mEmail": "abc123",
  "mExternalId": UUID,
  "editorgroup": UUID,
  "usergroup": UUID,
  "readergroup": UUID,
  "mTags": ["abc123"],
  "mPicture": "abc123",
  "mIcon": "abc123",
  "parentSchemaId": UUID
}

Types

`SchemaPropertiesConnection`

A connection to a list of SchemaProperty values.

Field Name	Description
`nodes` - `[SchemaProperty]!`	A list of `SchemaProperty` objects.
`edges` - `[SchemaPropertiesEdge!]!`	A list of edges which contains the `SchemaProperty` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `SchemaProperty` you could get from the connection.

Example

{
  "nodes": [SchemaProperty],
  "edges": [SchemaPropertiesEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`SchemaPropertiesEdge`

A SchemaProperty edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `SchemaProperty`	The `SchemaProperty` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": SchemaProperty
}

Types

`SchemaPropertiesOrderBy`

Methods to use when ordering SchemaProperty.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`PROPERTY_ASC`
`PROPERTY_DESC`
`GROUP_NAME_ASC`
`GROUP_NAME_DESC`
`GROUP_DESCRIPTION_ASC`
`GROUP_DESCRIPTION_DESC`
`HIDDEN_ASC`
`HIDDEN_DESC`
`SCHEMA_ID_ASC`
`SCHEMA_ID_DESC`
`UNITS_ASC`
`UNITS_DESC`
`REGEX_ASC`
`REGEX_DESC`
`VALUE_RANGE_ASC`
`VALUE_RANGE_DESC`
`VALUE_SET_ASC`
`VALUE_SET_DESC`
`MASK_ASC`
`MASK_DESC`
`DEFAULT_VALUE_ASC`
`DEFAULT_VALUE_DESC`
`DESCRIPTION_ASC`
`DESCRIPTION_DESC`
`CREATED_AT_ASC`
`CREATED_AT_DESC`
`UPDATED_AT_ASC`
`UPDATED_AT_DESC`
`BY_ASC`
`BY_DESC`
`INDEX_ASC`
`INDEX_DESC`
`STEALTH_ASC`
`STEALTH_DESC`
`TYPE_ID_ASC`
`TYPE_ID_DESC`
`JSON_SCHEMA_ASC`
`JSON_SCHEMA_DESC`
`NOT_NULL_ASC`
`NOT_NULL_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`SchemaPropertiesSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `SchemaPropertiesSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": SchemaPropertiesSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`SchemaPropertiesSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `SchemaPropertiesSortableField`

Example

{"field": SchemaPropertiesSortableField}

Types

`SchemaPropertiesSortableField`

Sortable concrete fields for the SchemaProperty type.

Enum Value	Description
`ID`
`PROPERTY`
`GROUP_NAME`
`GROUP_DESCRIPTION`
`HIDDEN`
`SCHEMA_ID`
`UNITS`
`REGEX`
`VALUE_RANGE`
`VALUE_SET`
`MASK`
`DEFAULT_VALUE`
`DESCRIPTION`
`CREATED_AT`
`UPDATED_AT`
`BY`
`INDEX`
`STEALTH`
`TYPE_ID`
`JSON_SCHEMA`
`NOT_NULL`

Types

`SchemaProperty`

Schema Property represents Properties supported by Schema.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`	Schema Property unique ID.
`property` - `String!`	Schema Property name.
`groupName` - `String!`	Schema Property Group name.
`groupDescription` - `String`	Schema Property Group description.
`hidden` - `Boolean!`	true
`schemaId` - `UUID!`	Schema ID this Property belongs to.
`units` - `String`	Property units indication.
`regex` - `String`	Property regex for validation.
`valueRange` - `JSON`	Property supported value range.
`valueSet` - `JSON`	Property set of possible values.
`mask` - `String`	Property input mask.
`defaultValue` - `JSON`	Property default value used on Object instantiation.
`description` - `String`	Property description.
`createdAt` - `Datetime!`	Property creation timestamp.
`updatedAt` - `Datetime!`	Property last update timestamp.
`by` - `UUID`	User last updated the Property.
`index` - `BigInt!`	Property index (for arrays).
`stealth` - `Boolean`	If true, this Property would not be saved in Properties' History storage once instantiated.
`typeId` - `UUID!`
`jsonSchema` - `JSON`
`notNull` - `Boolean!`
`schema` - `Schema`	Reads a single `Schema` that is related to this `SchemaProperty`.
`userByBy` - `User`	Reads a single `User` that is related to this `SchemaProperty`.
`type` - `PropertyType`	Reads a single `PropertyType` that is related to this `SchemaProperty`.
`key` - `String`
`propertyI18N` - `String`

Example

{
  "nodeId": ID,
  "id": UUID,
  "property": "xyz789",
  "groupName": "xyz789",
  "groupDescription": "abc123",
  "hidden": false,
  "schemaId": UUID,
  "units": "abc123",
  "regex": "xyz789",
  "valueRange": {},
  "valueSet": {},
  "mask": "abc123",
  "defaultValue": {},
  "description": "abc123",
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "index": BigInt,
  "stealth": false,
  "typeId": UUID,
  "jsonSchema": {},
  "notNull": false,
  "schema": Schema,
  "userByBy": User,
  "type": PropertyType,
  "key": "xyz789",
  "propertyI18N": "abc123"
}

Types

`SchemaPropertyChangedFilterType`

Input Field	Description
`groupName` - `String`
`property` - `String`

Example

{"groupName": "abc123", "property": "abc123"}

Types

`SchemaPropertyCondition`

A condition to be used against SchemaProperty object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`property` - `String`	Checks for equality with the object’s `property` field.
`groupName` - `String`	Checks for equality with the object’s `groupName` field.
`groupDescription` - `String`	Checks for equality with the object’s `groupDescription` field.
`hidden` - `Boolean`	Checks for equality with the object’s `hidden` field.
`schemaId` - `UUID`	Checks for equality with the object’s `schemaId` field.
`units` - `String`	Checks for equality with the object’s `units` field.
`regex` - `String`	Checks for equality with the object’s `regex` field.
`valueRange` - `JSON`	Checks for equality with the object’s `valueRange` field.
`valueSet` - `JSON`	Checks for equality with the object’s `valueSet` field.
`mask` - `String`	Checks for equality with the object’s `mask` field.
`defaultValue` - `JSON`	Checks for equality with the object’s `defaultValue` field.
`description` - `String`	Checks for equality with the object’s `description` field.
`createdAt` - `Datetime`	Checks for equality with the object’s `createdAt` field.
`updatedAt` - `Datetime`	Checks for equality with the object’s `updatedAt` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.
`index` - `BigInt`	Checks for equality with the object’s `index` field.
`stealth` - `Boolean`	Checks for equality with the object’s `stealth` field.
`typeId` - `UUID`	Checks for equality with the object’s `typeId` field.
`jsonSchema` - `JSON`	Checks for equality with the object’s `jsonSchema` field.
`notNull` - `Boolean`	Checks for equality with the object’s `notNull` field.

Example

{
  "id": UUID,
  "property": "xyz789",
  "groupName": "xyz789",
  "groupDescription": "xyz789",
  "hidden": true,
  "schemaId": UUID,
  "units": "xyz789",
  "regex": "xyz789",
  "valueRange": {},
  "valueSet": {},
  "mask": "xyz789",
  "defaultValue": {},
  "description": "xyz789",
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "index": BigInt,
  "stealth": true,
  "typeId": UUID,
  "jsonSchema": {},
  "notNull": true
}

Types

`SchemaPropertyFilter`

A filter to be used against SchemaProperty object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`property` - `StringFilter`	Filter by the object’s `property` field.
`groupName` - `StringFilter`	Filter by the object’s `groupName` field.
`groupDescription` - `StringFilter`	Filter by the object’s `groupDescription` field.
`hidden` - `BooleanFilter`	Filter by the object’s `hidden` field.
`schemaId` - `UUIDFilter`	Filter by the object’s `schemaId` field.
`units` - `StringFilter`	Filter by the object’s `units` field.
`regex` - `StringFilter`	Filter by the object’s `regex` field.
`mask` - `StringFilter`	Filter by the object’s `mask` field.
`defaultValue` - `JSONFilter`	Filter by the object’s `defaultValue` field.
`description` - `StringFilter`	Filter by the object’s `description` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`updatedAt` - `DatetimeFilter`	Filter by the object’s `updatedAt` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`index` - `BigIntFilter`	Filter by the object’s `index` field.
`stealth` - `BooleanFilter`	Filter by the object’s `stealth` field.
`typeId` - `UUIDFilter`	Filter by the object’s `typeId` field.
`jsonSchema` - `JSONFilter`	Filter by the object’s `jsonSchema` field.
`notNull` - `BooleanFilter`	Filter by the object’s `notNull` field.
`key` - `StringFilter`	Filter by the object’s `key` field.
`propertyI18N` - `StringFilter`	Filter by the object’s `propertyI18N` field.
`schema` - `SchemaFilter`	Filter by the object’s `schema` relation.
`userByBy` - `UserFilter`	Filter by the object’s `userByBy` relation.
`userByByExists` - `Boolean`	A related `userByBy` exists.
`type` - `PropertyTypeFilter`	Filter by the object’s `type` relation.
`and` - `[SchemaPropertyFilter!]`	Checks for all expressions in this list.
`or` - `[SchemaPropertyFilter!]`	Checks for any expressions in this list.
`not` - `SchemaPropertyFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "property": StringFilter,
  "groupName": StringFilter,
  "groupDescription": StringFilter,
  "hidden": BooleanFilter,
  "schemaId": UUIDFilter,
  "units": StringFilter,
  "regex": StringFilter,
  "mask": StringFilter,
  "defaultValue": JSONFilter,
  "description": StringFilter,
  "createdAt": DatetimeFilter,
  "updatedAt": DatetimeFilter,
  "by": UUIDFilter,
  "index": BigIntFilter,
  "stealth": BooleanFilter,
  "typeId": UUIDFilter,
  "jsonSchema": JSONFilter,
  "notNull": BooleanFilter,
  "key": StringFilter,
  "propertyI18N": StringFilter,
  "schema": SchemaFilter,
  "userByBy": UserFilter,
  "userByByExists": true,
  "type": PropertyTypeFilter,
  "and": [SchemaPropertyFilter],
  "or": [SchemaPropertyFilter],
  "not": SchemaPropertyFilter
}

Types

`SchemaPropertyInput`

An input for mutations affecting SchemaProperty

Input Field	Description
`id` - `UUID`	Schema Property unique ID.
`property` - `String!`	Schema Property name.
`groupName` - `String!`	Schema Property Group name.
`groupDescription` - `String`	Schema Property Group description.
`hidden` - `Boolean`
`schemaId` - `UUID!`	Schema ID this Property belongs to.
`units` - `String`	Property units indication.
`regex` - `String`	Property regex for validation.
`valueRange` - `JSON`	Property supported value range.
`valueSet` - `JSON`	Property set of possible values.
`mask` - `String`	Property input mask.
`defaultValue` - `JSON`	Property default value used on Object instantiation.
`description` - `String`	Property description.
`index` - `BigInt`	Property index (for arrays).
`stealth` - `Boolean`	If true, this Property would not be saved in Properties' History storage once instantiated.
`typeId` - `UUID!`
`jsonSchema` - `JSON`
`notNull` - `Boolean`

Example

{
  "id": UUID,
  "property": "abc123",
  "groupName": "abc123",
  "groupDescription": "abc123",
  "hidden": false,
  "schemaId": UUID,
  "units": "abc123",
  "regex": "xyz789",
  "valueRange": {},
  "valueSet": {},
  "mask": "xyz789",
  "defaultValue": {},
  "description": "abc123",
  "index": BigInt,
  "stealth": false,
  "typeId": UUID,
  "jsonSchema": {},
  "notNull": false
}

Types

`SchemaPropertyPatch`

Represents an update to a SchemaProperty. Fields that are set will be updated.

Input Field	Description
`id` - `UUID`	Schema Property unique ID.
`property` - `String`	Schema Property name.
`groupName` - `String`	Schema Property Group name.
`groupDescription` - `String`	Schema Property Group description.
`hidden` - `Boolean`
`schemaId` - `UUID`	Schema ID this Property belongs to.
`units` - `String`	Property units indication.
`regex` - `String`	Property regex for validation.
`valueRange` - `JSON`	Property supported value range.
`valueSet` - `JSON`	Property set of possible values.
`mask` - `String`	Property input mask.
`defaultValue` - `JSON`	Property default value used on Object instantiation.
`description` - `String`	Property description.
`index` - `BigInt`	Property index (for arrays).
`stealth` - `Boolean`	If true, this Property would not be saved in Properties' History storage once instantiated.
`typeId` - `UUID`
`jsonSchema` - `JSON`
`notNull` - `Boolean`

Example

{
  "id": UUID,
  "property": "abc123",
  "groupName": "xyz789",
  "groupDescription": "xyz789",
  "hidden": false,
  "schemaId": UUID,
  "units": "abc123",
  "regex": "xyz789",
  "valueRange": {},
  "valueSet": {},
  "mask": "abc123",
  "defaultValue": {},
  "description": "abc123",
  "index": BigInt,
  "stealth": false,
  "typeId": UUID,
  "jsonSchema": {},
  "notNull": false
}

Types

`SchemaToManyObjectFilter`

A filter to be used against many Object object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ObjectFilter`	Every related `Object` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ObjectFilter`	Some related `Object` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ObjectFilter`	No related `Object` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ObjectFilter,
  "some": ObjectFilter,
  "none": ObjectFilter
}

Types

`SchemaToManySchemaControlFilter`

A filter to be used against many SchemaControl object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `SchemaControlFilter`	Every related `SchemaControl` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `SchemaControlFilter`	Some related `SchemaControl` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `SchemaControlFilter`	No related `SchemaControl` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": SchemaControlFilter,
  "some": SchemaControlFilter,
  "none": SchemaControlFilter
}

Types

`SchemaToManySchemaFilter`

A filter to be used against many Schema object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `SchemaFilter`	Every related `Schema` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `SchemaFilter`	Some related `Schema` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `SchemaFilter`	No related `Schema` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": SchemaFilter,
  "some": SchemaFilter,
  "none": SchemaFilter
}

Types

`SchemaToManySchemaPropertyFilter`

A filter to be used against many SchemaProperty object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `SchemaPropertyFilter`	Every related `SchemaProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `SchemaPropertyFilter`	Some related `SchemaProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `SchemaPropertyFilter`	No related `SchemaProperty` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": SchemaPropertyFilter,
  "some": SchemaPropertyFilter,
  "none": SchemaPropertyFilter
}

Types

`SchemaTypes`

Enum Value	Description
`DEVICE`
`MEDIA`
`DATASET`
`APPLICATION`

Types

`SchemaTypesFilter`

A filter to be used against SchemaTypes fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `SchemaTypes`	Equal to the specified value.
`notEqualTo` - `SchemaTypes`	Not equal to the specified value.
`distinctFrom` - `SchemaTypes`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `SchemaTypes`	Equal to the specified value, treating null like an ordinary value.
`in` - `[SchemaTypes!]`	Included in the specified list.
`notIn` - `[SchemaTypes!]`	Not included in the specified list.
`lessThan` - `SchemaTypes`	Less than the specified value.
`lessThanOrEqualTo` - `SchemaTypes`	Less than or equal to the specified value.
`greaterThan` - `SchemaTypes`	Greater than the specified value.
`greaterThanOrEqualTo` - `SchemaTypes`	Greater than or equal to the specified value.

Example

{
  "isNull": false,
  "equalTo": SchemaTypes,
  "notEqualTo": SchemaTypes,
  "distinctFrom": SchemaTypes,
  "notDistinctFrom": SchemaTypes,
  "in": [SchemaTypes],
  "notIn": [SchemaTypes],
  "lessThan": SchemaTypes,
  "lessThanOrEqualTo": SchemaTypes,
  "greaterThan": SchemaTypes,
  "greaterThanOrEqualTo": SchemaTypes
}

Types

`SchemasSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `SchemasSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": SchemasSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`SchemasSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `SchemasSortableField`

Example

{"field": SchemasSortableField}

Types

`SchemasSortableField`

Sortable concrete fields for the Schema type.

Enum Value	Description
`ID`
`NAME`
`APPLICATION_OWNER`
`TYPE`
`ENABLED`
`DEFAULT_TTL`
`DESCRIPTION`
`M_LONGNAME`
`M_VERSION`
`M_MANUFACTURER`
`M_AUTHOR`
`M_EMAIL`
`M_EXTERNAL_ID`
`EDITORGROUP`
`USERGROUP`
`READERGROUP`
`CREATED_AT`
`UPDATED_AT`
`BY`
`M_TAGS`
`M_PICTURE`
`M_ICON`
`PARENT_SCHEMA_ID`

Types

`SchemataConnection`

A connection to a list of Schema values.

Field Name	Description
`nodes` - `[Schema]!`	A list of `Schema` objects.
`edges` - `[SchemataEdge!]!`	A list of edges which contains the `Schema` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `Schema` you could get from the connection.

Example

{
  "nodes": [Schema],
  "edges": [SchemataEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`SchemataEdge`

A Schema edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `Schema`	The `Schema` at the end of the edge.

Example

{"cursor": Cursor, "node": Schema}

Types

`SchemataOrderBy`

Methods to use when ordering Schema.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`NAME_ASC`
`NAME_DESC`
`APPLICATION_OWNER_ASC`
`APPLICATION_OWNER_DESC`
`TYPE_ASC`
`TYPE_DESC`
`ENABLED_ASC`
`ENABLED_DESC`
`DEFAULT_TTL_ASC`
`DEFAULT_TTL_DESC`
`DESCRIPTION_ASC`
`DESCRIPTION_DESC`
`M_LONGNAME_ASC`
`M_LONGNAME_DESC`
`M_VERSION_ASC`
`M_VERSION_DESC`
`M_MANUFACTURER_ASC`
`M_MANUFACTURER_DESC`
`M_AUTHOR_ASC`
`M_AUTHOR_DESC`
`M_EMAIL_ASC`
`M_EMAIL_DESC`
`M_EXTERNAL_ID_ASC`
`M_EXTERNAL_ID_DESC`
`EDITORGROUP_ASC`
`EDITORGROUP_DESC`
`USERGROUP_ASC`
`USERGROUP_DESC`
`READERGROUP_ASC`
`READERGROUP_DESC`
`CREATED_AT_ASC`
`CREATED_AT_DESC`
`UPDATED_AT_ASC`
`UPDATED_AT_DESC`
`BY_ASC`
`BY_DESC`
`M_TAGS_ASC`
`M_TAGS_DESC`
`M_PICTURE_ASC`
`M_PICTURE_DESC`
`M_ICON_ASC`
`M_ICON_DESC`
`PARENT_SCHEMA_ID_ASC`
`PARENT_SCHEMA_ID_DESC`
`OBJECTS_COUNT_ASC`
`OBJECTS_COUNT_DESC`
`PARENT_SCHEMA_NAME_ASC`
`PARENT_SCHEMA_NAME_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`SetObjectFavouriteInput`

All input for the setObjectFavourite mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectsId` - `[UUID]!`
`favourite` - `Boolean!`

Example

{
  "clientMutationId": "xyz789",
  "objectsId": [UUID],
  "favourite": false
}

Types

`SetObjectFavouritePayload`

The output of our setObjectFavourite mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "xyz789", "boolean": false}

Types

`SetObjectMutedInput`

All input for the setObjectMuted mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectsId` - `[UUID]!`
`muted` - `Boolean!`

Example

{
  "clientMutationId": "xyz789",
  "objectsId": [UUID],
  "muted": false
}

Types

`SetObjectMutedPayload`

The output of our setObjectMuted mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "abc123", "boolean": false}

Types

`SetUserEnabledInput`

All input for the setUserEnabled mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`userIds` - `[UUID]!`
`enable` - `Boolean`

Example

{
  "clientMutationId": "abc123",
  "userIds": [UUID],
  "enable": false
}

Types

`SetUserEnabledPayload`

The output of our setUserEnabled mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "xyz789", "boolean": false}

Types

`SortNulls`

When the given sortable is null, should we position this at the end of the list or the beginning of the list?

Enum Value	Description
`DEFAULT`	Order nulls last when in ascending order, or first when in descending order.
`FIRST`	Order nulls first (at the beginning of the list).
`LAST`	Order nulls last (at the end of the list).

Types

`String`

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.

Types

`StringFilter`

A filter to be used against String fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `String`	Equal to the specified value.
`notEqualTo` - `String`	Not equal to the specified value.
`distinctFrom` - `String`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `String`	Equal to the specified value, treating null like an ordinary value.
`in` - `[String!]`	Included in the specified list.
`notIn` - `[String!]`	Not included in the specified list.
`lessThan` - `String`	Less than the specified value.
`lessThanOrEqualTo` - `String`	Less than or equal to the specified value.
`greaterThan` - `String`	Greater than the specified value.
`greaterThanOrEqualTo` - `String`	Greater than or equal to the specified value.
`includes` - `String`	Contains the specified string (case-sensitive).
`notIncludes` - `String`	Does not contain the specified string (case-sensitive).
`includesInsensitive` - `String`	Contains the specified string (case-insensitive).
`notIncludesInsensitive` - `String`	Does not contain the specified string (case-insensitive).
`startsWith` - `String`	Starts with the specified string (case-sensitive).
`notStartsWith` - `String`	Does not start with the specified string (case-sensitive).
`startsWithInsensitive` - `String`	Starts with the specified string (case-insensitive).
`notStartsWithInsensitive` - `String`	Does not start with the specified string (case-insensitive).
`endsWith` - `String`	Ends with the specified string (case-sensitive).
`notEndsWith` - `String`	Does not end with the specified string (case-sensitive).
`endsWithInsensitive` - `String`	Ends with the specified string (case-insensitive).
`notEndsWithInsensitive` - `String`	Does not end with the specified string (case-insensitive).
`like` - `String`	Matches the specified pattern (case-sensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters.
`notLike` - `String`	Does not match the specified pattern (case-sensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters.
`likeInsensitive` - `String`	Matches the specified pattern (case-insensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters.
`notLikeInsensitive` - `String`	Does not match the specified pattern (case-insensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters.
`equalToInsensitive` - `String`	Equal to the specified value (case-insensitive).
`notEqualToInsensitive` - `String`	Not equal to the specified value (case-insensitive).
`distinctFromInsensitive` - `String`	Not equal to the specified value, treating null like an ordinary value (case-insensitive).
`notDistinctFromInsensitive` - `String`	Equal to the specified value, treating null like an ordinary value (case-insensitive).
`inInsensitive` - `[String!]`	Included in the specified list (case-insensitive).
`notInInsensitive` - `[String!]`	Not included in the specified list (case-insensitive).
`lessThanInsensitive` - `String`	Less than the specified value (case-insensitive).
`lessThanOrEqualToInsensitive` - `String`	Less than or equal to the specified value (case-insensitive).
`greaterThanInsensitive` - `String`	Greater than the specified value (case-insensitive).
`greaterThanOrEqualToInsensitive` - `String`	Greater than or equal to the specified value (case-insensitive).

Example

{
  "isNull": false,
  "equalTo": "abc123",
  "notEqualTo": "abc123",
  "distinctFrom": "xyz789",
  "notDistinctFrom": "xyz789",
  "in": ["xyz789"],
  "notIn": ["xyz789"],
  "lessThan": "xyz789",
  "lessThanOrEqualTo": "abc123",
  "greaterThan": "xyz789",
  "greaterThanOrEqualTo": "abc123",
  "includes": "xyz789",
  "notIncludes": "abc123",
  "includesInsensitive": "xyz789",
  "notIncludesInsensitive": "abc123",
  "startsWith": "xyz789",
  "notStartsWith": "xyz789",
  "startsWithInsensitive": "abc123",
  "notStartsWithInsensitive": "abc123",
  "endsWith": "abc123",
  "notEndsWith": "abc123",
  "endsWithInsensitive": "abc123",
  "notEndsWithInsensitive": "abc123",
  "like": "abc123",
  "notLike": "xyz789",
  "likeInsensitive": "abc123",
  "notLikeInsensitive": "abc123",
  "equalToInsensitive": "abc123",
  "notEqualToInsensitive": "xyz789",
  "distinctFromInsensitive": "abc123",
  "notDistinctFromInsensitive": "abc123",
  "inInsensitive": ["xyz789"],
  "notInInsensitive": ["abc123"],
  "lessThanInsensitive": "xyz789",
  "lessThanOrEqualToInsensitive": "xyz789",
  "greaterThanInsensitive": "abc123",
  "greaterThanOrEqualToInsensitive": "abc123"
}

Types

`StringListFilter`

A filter to be used against String List fields. All fields are combined with a logical ‘and.’

Field Name	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `[String]`	Equal to the specified value.
`notEqualTo` - `[String]`	Not equal to the specified value.
`distinctFrom` - `[String]`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `[String]`	Equal to the specified value, treating null like an ordinary value.
`lessThan` - `[String]`	Less than the specified value.
`lessThanOrEqualTo` - `[String]`	Less than or equal to the specified value.
`greaterThan` - `[String]`	Greater than the specified value.
`greaterThanOrEqualTo` - `[String]`	Greater than or equal to the specified value.
`contains` - `[String]`	Contains the specified list of values.
`containedBy` - `[String]`	Contained by the specified list of values.
`overlaps` - `[String]`	Overlaps the specified list of values.
`anyEqualTo` - `String`	Any array item is equal to the specified value.
`anyNotEqualTo` - `String`	Any array item is not equal to the specified value.
`anyLessThan` - `String`	Any array item is less than the specified value.
`anyLessThanOrEqualTo` - `String`	Any array item is less than or equal to the specified value.
`anyGreaterThan` - `String`	Any array item is greater than the specified value.
`anyGreaterThanOrEqualTo` - `String`	Any array item is greater than or equal to the specified value.

Example

{
  "isNull": false,
  "equalTo": ["xyz789"],
  "notEqualTo": ["xyz789"],
  "distinctFrom": ["abc123"],
  "notDistinctFrom": ["xyz789"],
  "lessThan": ["abc123"],
  "lessThanOrEqualTo": ["abc123"],
  "greaterThan": ["abc123"],
  "greaterThanOrEqualTo": ["xyz789"],
  "contains": ["abc123"],
  "containedBy": ["abc123"],
  "overlaps": ["abc123"],
  "anyEqualTo": "abc123",
  "anyNotEqualTo": "xyz789",
  "anyLessThan": "xyz789",
  "anyLessThanOrEqualTo": "abc123",
  "anyGreaterThan": "xyz789",
  "anyGreaterThanOrEqualTo": "abc123"
}

Types

`Subscription`

The root subscription type: contains realtime events you can subscribe to with the subscription operation.

Field Name	Description
`listen` - `ListenPayload`	Listen for any changes in the Platform based on Topic tag
Arguments `topic` - `String!`
`Objects` - `ListenObjectsPayload`	Listen for any changes in Objects, ObjectProperties and ObjectToObjects with filter functionality
Arguments `filterA` - `SubscriptionObjectsFilter` `filterB` - `SubscriptionObjectsFilter`
`Schemas` - `ListenSchemasPayload`	Listen for any changes in Schemas and SchemaProperties with filter functionality
Arguments `filterA` - `SubscriptionSchemaFilter`
`Notifications` - `ListenNotificationsPayload`	Listen for any new Notifications with filter functionality
Arguments `filterA` - `SubscriptionNotificationFilter`
`ControlExecutions` - `ListenControlExecutionsPayload`	Listen for any new Control Executions with filter functionality
Arguments `filterA` - `SubscriptionControlExecutionFilter`
`Users` - `ListenUsersPayload`	Listen for any changes in Users with filter functionality
Arguments `filterA` - `SubscriptionUserFilter`

Example

{
  "listen": ListenPayload,
  "Objects": ListenObjectsPayload,
  "Schemas": ListenSchemasPayload,
  "Notifications": ListenNotificationsPayload,
  "ControlExecutions": ListenControlExecutionsPayload,
  "Users": ListenUsersPayload
}

Types

`SubscriptionControlExecutionFilter`

Field Name	Description
`linked_control_id` - `Int`
`object_id` - `[UUID]`
`caller_id` - `[UUID]`
`controller` - `[UUID]`
`done` - `Boolean`
`error` - `String`
`type` - `[ControlTypes]`

Example

{
  "linked_control_id": 123,
  "object_id": [UUID],
  "caller_id": [UUID],
  "controller": [UUID],
  "done": false,
  "error": "xyz789",
  "type": [ControlTypes]
}

Types

`SubscriptionNotificationFilter`

Field Name	Description
`tags` - `[String]`
`object_id` - `[UUID]`
`by` - `[UUID]`
`deliveryUser` - `[UUID]`
`deliveryPath` - `[String]`

Example

{
  "tags": ["abc123"],
  "object_id": [UUID],
  "by": [UUID],
  "deliveryUser": [UUID],
  "deliveryPath": ["xyz789"]
}

Types

`SubscriptionObjectsFilter`

Field Name	Description
`tags` - `[String]`
`id` - `[UUID!]`
`schemaId` - `[UUID!]`
`type` - `String`
`childObjects` - `[UUID!]`
`parentObjects` - `[UUID!]`
`propertyChanged` - `[ObjectPropertyChangedFilterType!]`

Example

{
  "tags": ["abc123"],
  "id": [UUID],
  "schemaId": [UUID],
  "type": "xyz789",
  "childObjects": [UUID],
  "parentObjects": [UUID],
  "propertyChanged": [ObjectPropertyChangedFilterType]
}

Types

`SubscriptionSchemaFilter`

Field Name	Description
`tags` - `[String]`
`id` - `[UUID!]`
`type` - `String`
`propertyChanged` - `[SchemaPropertyChangedFilterType!]`

Example

{
  "tags": ["xyz789"],
  "id": [UUID],
  "type": "xyz789",
  "propertyChanged": [SchemaPropertyChangedFilterType]
}

Types

`SubscriptionUserFilter`

Field Name	Description
`login` - `[String]`
`id` - `[UUID!]`

Example

{"login": ["xyz789"], "id": [UUID]}

Types

`Translation`

Simple Translations item representation.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`uuid` - `UUID!`	Translation item unique ID.
`query` - `String`	Translation item GraphQL related query object name.
`key` - `String`	Translation item GraphQL related query field name.
`ru` - `String`	Translation item in Russian.
`en` - `String`	Translation item in English.
`th` - `String`	Translation item in Thai.
`cn` - `String`	Translation item in Chinese.

Example

{
  "nodeId": ID,
  "uuid": UUID,
  "query": "xyz789",
  "key": "xyz789",
  "ru": "abc123",
  "en": "xyz789",
  "th": "abc123",
  "cn": "abc123"
}

Types

`TranslationCondition`

A condition to be used against Translation object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`uuid` - `UUID`	Checks for equality with the object’s `uuid` field.
`query` - `String`	Checks for equality with the object’s `query` field.
`key` - `String`	Checks for equality with the object’s `key` field.
`ru` - `String`	Checks for equality with the object’s `ru` field.
`en` - `String`	Checks for equality with the object’s `en` field.
`th` - `String`	Checks for equality with the object’s `th` field.
`cn` - `String`	Checks for equality with the object’s `cn` field.

Example

{
  "uuid": UUID,
  "query": "abc123",
  "key": "abc123",
  "ru": "xyz789",
  "en": "abc123",
  "th": "abc123",
  "cn": "xyz789"
}

Types

`TranslationFilter`

A filter to be used against Translation object types. All fields are combined with a logical ‘and.’

Input Field	Description
`uuid` - `UUIDFilter`	Filter by the object’s `uuid` field.
`query` - `StringFilter`	Filter by the object’s `query` field.
`key` - `StringFilter`	Filter by the object’s `key` field.
`ru` - `StringFilter`	Filter by the object’s `ru` field.
`en` - `StringFilter`	Filter by the object’s `en` field.
`th` - `StringFilter`	Filter by the object’s `th` field.
`cn` - `StringFilter`	Filter by the object’s `cn` field.
`and` - `[TranslationFilter!]`	Checks for all expressions in this list.
`or` - `[TranslationFilter!]`	Checks for any expressions in this list.
`not` - `TranslationFilter`	Negates the expression.

Example

{
  "uuid": UUIDFilter,
  "query": StringFilter,
  "key": StringFilter,
  "ru": StringFilter,
  "en": StringFilter,
  "th": StringFilter,
  "cn": StringFilter,
  "and": [TranslationFilter],
  "or": [TranslationFilter],
  "not": TranslationFilter
}

Types

`TranslationInput`

An input for mutations affecting Translation

Input Field	Description
`uuid` - `UUID`	Translation item unique ID.
`query` - `String`	Translation item GraphQL related query object name.
`key` - `String`	Translation item GraphQL related query field name.
`ru` - `String`	Translation item in Russian.
`en` - `String`	Translation item in English.
`th` - `String`	Translation item in Thai.
`cn` - `String`	Translation item in Chinese.

Example

{
  "uuid": UUID,
  "query": "xyz789",
  "key": "xyz789",
  "ru": "xyz789",
  "en": "abc123",
  "th": "abc123",
  "cn": "xyz789"
}

Types

`TranslationsConnection`

A connection to a list of Translation values.

Field Name	Description
`nodes` - `[Translation]!`	A list of `Translation` objects.
`edges` - `[TranslationsEdge!]!`	A list of edges which contains the `Translation` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `Translation` you could get from the connection.

Example

{
  "nodes": [Translation],
  "edges": [TranslationsEdge],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Types

`TranslationsEdge`

A Translation edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `Translation`	The `Translation` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": Translation
}

Types

`TranslationsOrderBy`

Methods to use when ordering Translation.

Enum Value	Description
`NATURAL`
`UUID_ASC`
`UUID_DESC`
`QUERY_ASC`
`QUERY_DESC`
`KEY_ASC`
`KEY_DESC`
`RU_ASC`
`RU_DESC`
`EN_ASC`
`EN_DESC`
`TH_ASC`
`TH_DESC`
`CN_ASC`
`CN_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`TranslationsSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `TranslationsSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": TranslationsSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`TranslationsSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `TranslationsSortableField`

Example

{"field": TranslationsSortableField}

Types

`TranslationsSortableField`

Sortable concrete fields for the Translation type.

Enum Value	Description
`UUID`
`QUERY`
`KEY`
`RU`
`EN`
`TH`
`CN`

Types

`TwoFa`

Field Name	Description
`type` - `String`
`info` - `String`

Example

{"type": "abc123", "info": "abc123"}

Types

`TwoFaTypes`

Enum Value	Description
`EMAIL`
`NONE`
`SMS`

Types

`TwoFaTypesFilter`

A filter to be used against TwoFaTypes fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `TwoFaTypes`	Equal to the specified value.
`notEqualTo` - `TwoFaTypes`	Not equal to the specified value.
`distinctFrom` - `TwoFaTypes`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `TwoFaTypes`	Equal to the specified value, treating null like an ordinary value.
`in` - `[TwoFaTypes!]`	Included in the specified list.
`notIn` - `[TwoFaTypes!]`	Not included in the specified list.
`lessThan` - `TwoFaTypes`	Less than the specified value.
`lessThanOrEqualTo` - `TwoFaTypes`	Less than or equal to the specified value.
`greaterThan` - `TwoFaTypes`	Greater than the specified value.
`greaterThanOrEqualTo` - `TwoFaTypes`	Greater than or equal to the specified value.

Example

{
  "isNull": false,
  "equalTo": TwoFaTypes,
  "notEqualTo": TwoFaTypes,
  "distinctFrom": TwoFaTypes,
  "notDistinctFrom": TwoFaTypes,
  "in": [TwoFaTypes],
  "notIn": [TwoFaTypes],
  "lessThan": TwoFaTypes,
  "lessThanOrEqualTo": TwoFaTypes,
  "greaterThan": TwoFaTypes,
  "greaterThanOrEqualTo": TwoFaTypes
}

Types

`UUID`

A universally unique identifier as defined by RFC 4122.

Example

object

Types

`UUIDFilter`

A filter to be used against UUID fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `UUID`	Equal to the specified value.
`notEqualTo` - `UUID`	Not equal to the specified value.
`distinctFrom` - `UUID`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `UUID`	Equal to the specified value, treating null like an ordinary value.
`in` - `[UUID!]`	Included in the specified list.
`notIn` - `[UUID!]`	Not included in the specified list.
`lessThan` - `UUID`	Less than the specified value.
`lessThanOrEqualTo` - `UUID`	Less than or equal to the specified value.
`greaterThan` - `UUID`	Greater than the specified value.
`greaterThanOrEqualTo` - `UUID`	Greater than or equal to the specified value.

Example

{
  "isNull": false,
  "equalTo": UUID,
  "notEqualTo": UUID,
  "distinctFrom": UUID,
  "notDistinctFrom": UUID,
  "in": [UUID],
  "notIn": [UUID],
  "lessThan": UUID,
  "lessThanOrEqualTo": UUID,
  "greaterThan": UUID,
  "greaterThanOrEqualTo": UUID
}

Types

`UpdateControlExecutionAckInput`

All input for the updateControlExecutionAck mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`controlsExecutionId` - `BigInt!`

Example

{
  "clientMutationId": "xyz789",
  "controlsExecutionId": BigInt
}

Types

`UpdateControlExecutionAckPayload`

The output of our updateControlExecutionAck mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "xyz789", "boolean": true}

Types

`UpdateJsonPropertyArrayInput`

All input for the updateJsonPropertyArray mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`propertyId` - `UUID!`
`arrayElement` - `JSON!`
`elementPosition` - `Int!`

Example

{
  "clientMutationId": "xyz789",
  "propertyId": UUID,
  "arrayElement": {},
  "elementPosition": 123
}

Types

`UpdateJsonPropertyArrayPayload`

The output of our updateJsonPropertyArray mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "abc123", "boolean": false}

Types

`UpdateObjectByNodeIdInput`

All input for the updateObjectByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `Object` to be updated.
`patch` - `ObjectPatch!`	An object where the defined keys will be set on the `Object` being updated.

Example

{
  "clientMutationId": "xyz789",
  "nodeId": ID,
  "patch": ObjectPatch
}

Types

`UpdateObjectInput`

All input for the updateObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `ObjectPatch!`	An object where the defined keys will be set on the `Object` being updated.
`id` - `UUID!`	Unique Object ID.

Example

{
  "clientMutationId": "xyz789",
  "patch": ObjectPatch,
  "id": UUID
}

Types

`UpdateObjectPayload`

The output of our update Object mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`object` - `Object`	The `Object` that was updated by this mutation.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userByBy` - `User`	Reads a single `User` that is related to this `Object`.
`schema` - `Schema`	Reads a single `Schema` that is related to this `Object`.
`objectEdge` - `ObjectsEdge`	An edge for our `Object`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`.

Example

{
  "clientMutationId": "xyz789",
  "object": Object,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "schema": Schema,
  "objectEdge": ObjectsEdge
}

Types

`UpdateObjectPropertiesByIdInput`

All input for the updateObjectPropertiesById mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`transactionId` - `BigInt`
`propertiesArray` - `[PropertyByIdInput]`

Example

{
  "clientMutationId": "abc123",
  "transactionId": BigInt,
  "propertiesArray": [PropertyByIdInput]
}

Types

`UpdateObjectPropertiesByIdPayload`

The output of our updateObjectPropertiesById mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "xyz789", "boolean": false}

Types

`UpdateObjectPropertiesByKeyInput`

All input for the updateObjectPropertiesByKey mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objectId` - `UUID`
`transactionId` - `BigInt`
`propertiesArray` - `[PropertyByKeyInput]`

Example

{
  "clientMutationId": "abc123",
  "objectId": UUID,
  "transactionId": BigInt,
  "propertiesArray": [PropertyByKeyInput]
}

Types

`UpdateObjectPropertiesByKeyPayload`

The output of our updateObjectPropertiesByKey mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "abc123", "boolean": false}

Types

`UpdateObjectPropertiesByNameInput`

Input Field	Description
`objectId` - `UUID!`
`transactionId` - `BigInt!`
`propertiesArray` - `[PropertyByName2Input!]!`

Example

{
  "objectId": UUID,
  "transactionId": BigInt,
  "propertiesArray": [PropertyByName2Input]
}

Types

`UpdateObjectPropertiesByNamePayload`

Field Name	Description
`clientMutationId` - `String`
`boolean` - `Boolean`

Example

{"clientMutationId": "xyz789", "boolean": false}

Types

`UpdateObjectPropertiesHistoryByNodeIdInput`

All input for the updateObjectPropertiesHistoryByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `ObjectPropertiesHistory` to be updated.
`patch` - `ObjectPropertiesHistoryPatch!`	An object where the defined keys will be set on the `ObjectPropertiesHistory` being updated.

Example

{
  "clientMutationId": "xyz789",
  "nodeId": ID,
  "patch": ObjectPropertiesHistoryPatch
}

Types

`UpdateObjectPropertiesHistoryInput`

All input for the updateObjectPropertiesHistory mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `ObjectPropertiesHistoryPatch!`	An object where the defined keys will be set on the `ObjectPropertiesHistory` being updated.
`recordedAt` - `Datetime!`
`id` - `Int!`

Example

{
  "clientMutationId": "abc123",
  "patch": ObjectPropertiesHistoryPatch,
  "recordedAt": Datetime,
  "id": 123
}

Types

`UpdateObjectPropertiesHistoryPayload`

The output of our update ObjectPropertiesHistory mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`objectPropertiesHistory` - `ObjectPropertiesHistory`	The `ObjectPropertiesHistory` that was updated by this mutation.
`userByBy` - `User`	Reads a single `User` that is related to this `ObjectPropertiesHistory`.
`objectPropertiesHistoryEdge` - `ObjectPropertiesHistoriesEdge`	An edge for our `ObjectPropertiesHistory`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectPropertiesHistoriesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectPropertiesHistory`.

Example

{
  "clientMutationId": "abc123",
  "objectPropertiesHistory": ObjectPropertiesHistory,
  "userByBy": User,
  "objectPropertiesHistoryEdge": ObjectPropertiesHistoriesEdge
}

Types

`UpdateObjectPropertyByNodeIdInput`

All input for the updateObjectPropertyByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `ObjectProperty` to be updated.
`patch` - `ObjectPropertyPatch!`	An object where the defined keys will be set on the `ObjectProperty` being updated.

Example

{
  "clientMutationId": "xyz789",
  "nodeId": ID,
  "patch": ObjectPropertyPatch
}

Types

`UpdateObjectPropertyByObjectGroupPropertyInput`

All input for the updateObjectPropertyByObjectGroupProperty mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`objId` - `UUID`
`groupName` - `String`
`propertyName` - `String`
`propertyValue` - `JSON`
`transactionId` - `BigInt`

Example

{
  "clientMutationId": "xyz789",
  "objId": UUID,
  "groupName": "xyz789",
  "propertyName": "abc123",
  "propertyValue": {},
  "transactionId": BigInt
}

Types

`UpdateObjectPropertyByObjectGroupPropertyPayload`

The output of our updateObjectPropertyByObjectGroupProperty mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "abc123", "boolean": false}

Types

`UpdateObjectPropertyInput`

All input for the updateObjectProperty mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `ObjectPropertyPatch!`	An object where the defined keys will be set on the `ObjectProperty` being updated.
`id` - `UUID!`	Property unique ID.

Example

{
  "clientMutationId": "abc123",
  "patch": ObjectPropertyPatch,
  "id": UUID
}

Types

`UpdateObjectPropertyPayload`

The output of our update ObjectProperty mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`objectProperty` - `ObjectProperty`	The `ObjectProperty` that was updated by this mutation.
`object` - `Object`	Reads a single `Object` that is related to this `ObjectProperty`.
`linkedProperty` - `ObjectProperty`	Reads a single `ObjectProperty` that is related to this `ObjectProperty`.
`userByBy` - `User`	Reads a single `User` that is related to this `ObjectProperty`.
`objectPropertyEdge` - `ObjectPropertiesEdge`	An edge for our `ObjectProperty`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectProperty`.

Example

{
  "clientMutationId": "xyz789",
  "objectProperty": ObjectProperty,
  "object": Object,
  "linkedProperty": ObjectProperty,
  "userByBy": User,
  "objectPropertyEdge": ObjectPropertiesEdge
}

Types

`UpdateObjectWithPropertiesInput`

All input for the updateObjectWithProperties mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`detailedObject` - `[DetailedObjectInput]`

Example

{
  "clientMutationId": "xyz789",
  "detailedObject": [DetailedObjectInput]
}

Types

`UpdateObjectWithPropertiesPayload`

The output of our updateObjectWithProperties mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "abc123", "boolean": true}

Types

`UpdateObjectsPropertiesByKeyInput`

All input for the updateObjectsPropertiesByKey mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`schemaId` - `UUID`
`objectIds` - `[UUID]`
`transactionId` - `BigInt`
`propertiesArray` - `[PropertyByKeyInput]`

Example

{
  "clientMutationId": "abc123",
  "schemaId": UUID,
  "objectIds": [UUID],
  "transactionId": BigInt,
  "propertiesArray": [PropertyByKeyInput]
}

Types

`UpdateObjectsPropertiesByKeyPayload`

The output of our updateObjectsPropertiesByKey mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "abc123", "boolean": true}

Types

`UpdatePropertyTypeByNameInput`

All input for the updatePropertyTypeByName mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `PropertyTypePatch!`	An object where the defined keys will be set on the `PropertyType` being updated.
`name` - `String!`	Type name (must be unique)

Example

{
  "clientMutationId": "xyz789",
  "patch": PropertyTypePatch,
  "name": "xyz789"
}

Types

`UpdatePropertyTypeByNodeIdInput`

All input for the updatePropertyTypeByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `PropertyType` to be updated.
`patch` - `PropertyTypePatch!`	An object where the defined keys will be set on the `PropertyType` being updated.

Example

{
  "clientMutationId": "xyz789",
  "nodeId": ID,
  "patch": PropertyTypePatch
}

Types

`UpdatePropertyTypeInput`

All input for the updatePropertyType mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `PropertyTypePatch!`	An object where the defined keys will be set on the `PropertyType` being updated.
`id` - `UUID!`	Type id.

Example

{
  "clientMutationId": "abc123",
  "patch": PropertyTypePatch,
  "id": UUID
}

Types

`UpdatePropertyTypePayload`

The output of our update PropertyType mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`propertyType` - `PropertyType`	The `PropertyType` that was updated by this mutation.
`propertyTypeEdge` - `PropertyTypesEdge`	An edge for our `PropertyType`. May be used by Relay 1.
Arguments `orderBy` - `[PropertyTypesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `PropertyType`.

Example

{
  "clientMutationId": "abc123",
  "propertyType": PropertyType,
  "propertyTypeEdge": PropertyTypesEdge
}

Types

`UpdateSchemaByNodeIdInput`

All input for the updateSchemaByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `Schema` to be updated.
`patch` - `SchemaPatch!`	An object where the defined keys will be set on the `Schema` being updated.

Example

{
  "clientMutationId": "xyz789",
  "nodeId": ID,
  "patch": SchemaPatch
}

Types

`UpdateSchemaControlByNodeIdInput`

All input for the updateSchemaControlByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `SchemaControl` to be updated.
`patch` - `SchemaControlPatch!`	An object where the defined keys will be set on the `SchemaControl` being updated.

Example

{
  "clientMutationId": "xyz789",
  "nodeId": ID,
  "patch": SchemaControlPatch
}

Types

`UpdateSchemaControlInput`

All input for the updateSchemaControl mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `SchemaControlPatch!`	An object where the defined keys will be set on the `SchemaControl` being updated.
`id` - `UUID!`	Schema Controls unique ID.

Example

{
  "clientMutationId": "abc123",
  "patch": SchemaControlPatch,
  "id": UUID
}

Types

`UpdateSchemaControlPayload`

The output of our update SchemaControl mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schemaControl` - `SchemaControl`	The `SchemaControl` that was updated by this mutation.
`schema` - `Schema`	Reads a single `Schema` that is related to this `SchemaControl`.
`userByBy` - `User`	Reads a single `User` that is related to this `SchemaControl`.
`schemaControlEdge` - `SchemaControlsEdge`	An edge for our `SchemaControl`. May be used by Relay 1.
Arguments `orderBy` - `[SchemaControlsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaControl`.

Example

{
  "clientMutationId": "abc123",
  "schemaControl": SchemaControl,
  "schema": Schema,
  "userByBy": User,
  "schemaControlEdge": SchemaControlsEdge
}

Types

`UpdateSchemaInput`

All input for the updateSchema mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `SchemaPatch!`	An object where the defined keys will be set on the `Schema` being updated.
`id` - `UUID!`	Schema unique ID.

Example

{
  "clientMutationId": "xyz789",
  "patch": SchemaPatch,
  "id": UUID
}

Types

`UpdateSchemaPayload`

The output of our update Schema mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schema` - `Schema`	The `Schema` that was updated by this mutation.
`userByApplicationOwner` - `User`	Reads a single `User` that is related to this `Schema`.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userByBy` - `User`	Reads a single `User` that is related to this `Schema`.
`parentSchema` - `Schema`	Reads a single `Schema` that is related to this `Schema`.
`schemaEdge` - `SchemataEdge`	An edge for our `Schema`. May be used by Relay 1.
Arguments `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`.

Example

{
  "clientMutationId": "xyz789",
  "schema": Schema,
  "userByApplicationOwner": User,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "parentSchema": Schema,
  "schemaEdge": SchemataEdge
}

Types

`UpdateSchemaPropertiesByIdInput`

All input for the updateSchemaPropertiesById mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`propertiesArray` - `[PropertyByIdInput]`

Example

{
  "clientMutationId": "xyz789",
  "propertiesArray": [PropertyByIdInput]
}

Types

`UpdateSchemaPropertiesByIdPayload`

The output of our updateSchemaPropertiesById mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "xyz789", "boolean": true}

Types

`UpdateSchemaPropertiesDefaultsInput`

All input for the updateSchemaPropertiesDefaults mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`schemaId` - `UUID!`
`propertiesArray` - `[PropertyByIdInput]!`
`propertiesByKeyArray` - `[PropertyByKeyInput]!`
`valueInit` - `Boolean!`

Example

{
  "clientMutationId": "abc123",
  "schemaId": UUID,
  "propertiesArray": [PropertyByIdInput],
  "propertiesByKeyArray": [PropertyByKeyInput],
  "valueInit": true
}

Types

`UpdateSchemaPropertiesDefaultsPayload`

The output of our updateSchemaPropertiesDefaults mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "xyz789", "boolean": true}

Types

`UpdateSchemaPropertyByNodeIdInput`

All input for the updateSchemaPropertyByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `SchemaProperty` to be updated.
`patch` - `SchemaPropertyPatch!`	An object where the defined keys will be set on the `SchemaProperty` being updated.

Example

{
  "clientMutationId": "xyz789",
  "nodeId": ID,
  "patch": SchemaPropertyPatch
}

Types

`UpdateSchemaPropertyInput`

All input for the updateSchemaProperty mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `SchemaPropertyPatch!`	An object where the defined keys will be set on the `SchemaProperty` being updated.
`id` - `UUID!`	Schema Property unique ID.

Example

{
  "clientMutationId": "abc123",
  "patch": SchemaPropertyPatch,
  "id": UUID
}

Types

`UpdateSchemaPropertyPayload`

The output of our update SchemaProperty mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schemaProperty` - `SchemaProperty`	The `SchemaProperty` that was updated by this mutation.
`schema` - `Schema`	Reads a single `Schema` that is related to this `SchemaProperty`.
`userByBy` - `User`	Reads a single `User` that is related to this `SchemaProperty`.
`type` - `PropertyType`	Reads a single `PropertyType` that is related to this `SchemaProperty`.
`schemaPropertyEdge` - `SchemaPropertiesEdge`	An edge for our `SchemaProperty`. May be used by Relay 1.
Arguments `orderBy` - `[SchemaPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaProperty`.

Example

{
  "clientMutationId": "xyz789",
  "schemaProperty": SchemaProperty,
  "schema": Schema,
  "userByBy": User,
  "type": PropertyType,
  "schemaPropertyEdge": SchemaPropertiesEdge
}

Types

`UpdateSchemasBasicsInput`

All input for the updateSchemasBasics mutation.

Field Name	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`schemaIds` - `[UUID]`
`editorGroup` - `UUID`
`userGroup` - `UUID`
`readerGroup` - `UUID`
`enabled` - `Boolean`

Example

{
  "clientMutationId": "abc123",
  "schemaIds": [UUID],
  "editorGroup": UUID,
  "userGroup": UUID,
  "readerGroup": UUID,
  "enabled": true
}

Types

`UpdateSchemasBasicsPayload`

The output of our updateSchemasBasics mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`boolean` - `Boolean`

Example

{"clientMutationId": "abc123", "boolean": true}

Types

`UpdateUserByLoginInput`

All input for the updateUserByLogin mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `UserPatch!`	An object where the defined keys will be set on the `User` being updated.
`login` - `String!`	User's login name (User name).

Example

{
  "clientMutationId": "abc123",
  "patch": UserPatch,
  "login": "xyz789"
}

Types

`UpdateUserByNodeIdInput`

All input for the updateUserByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `User` to be updated.
`patch` - `UserPatch!`	An object where the defined keys will be set on the `User` being updated.

Example

{
  "clientMutationId": "abc123",
  "nodeId": ID,
  "patch": UserPatch
}

Types

`UpdateUserGroupByGroupNameInput`

All input for the updateUserGroupByGroupName mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `UserGroupPatch!`	An object where the defined keys will be set on the `UserGroup` being updated.
`groupName` - `String!`	User Group name.

Example

{
  "clientMutationId": "xyz789",
  "patch": UserGroupPatch,
  "groupName": "xyz789"
}

Types

`UpdateUserGroupByNodeIdInput`

All input for the updateUserGroupByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `UserGroup` to be updated.
`patch` - `UserGroupPatch!`	An object where the defined keys will be set on the `UserGroup` being updated.

Example

{
  "clientMutationId": "abc123",
  "nodeId": ID,
  "patch": UserGroupPatch
}

Types

`UpdateUserGroupInput`

All input for the updateUserGroup mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `UserGroupPatch!`	An object where the defined keys will be set on the `UserGroup` being updated.
`id` - `UUID!`	User Group unique ID.

Example

{
  "clientMutationId": "xyz789",
  "patch": UserGroupPatch,
  "id": UUID
}

Types

`UpdateUserGroupPayload`

The output of our update UserGroup mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`userGroup` - `UserGroup`	The `UserGroup` that was updated by this mutation.
`userByBy` - `User`	Reads a single `User` that is related to this `UserGroup`.
`userGroupEdge` - `UserGroupsEdge`	An edge for our `UserGroup`. May be used by Relay 1.
Arguments `orderBy` - `[UserGroupsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UserGroup`.

Example

{
  "clientMutationId": "xyz789",
  "userGroup": UserGroup,
  "userByBy": User,
  "userGroupEdge": UserGroupsEdge
}

Types

`UpdateUserInput`

All input for the updateUser mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `UserPatch!`	An object where the defined keys will be set on the `User` being updated.
`id` - `UUID!`	User unique ID.

Example

{
  "clientMutationId": "xyz789",
  "patch": UserPatch,
  "id": UUID
}

Types

`UpdateUserPayload`

The output of our update User mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`user` - `User`	The `User` that was updated by this mutation.
`userGroupByDefaultEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userEdge` - `UsersEdge`	An edge for our `User`. May be used by Relay 1.
Arguments `orderBy` - `[UsersOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `User`.

Example

{
  "clientMutationId": "abc123",
  "user": User,
  "userGroupByDefaultEditorgroup": UserGroup,
  "userGroupByDefaultUsergroup": UserGroup,
  "userGroupByDefaultReadergroup": UserGroup,
  "userEdge": UsersEdge
}

Types

`UpdateUsersToGroupByNodeIdInput`

All input for the updateUsersToGroupByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `UsersToGroup` to be updated.
`patch` - `UsersToGroupPatch!`	An object where the defined keys will be set on the `UsersToGroup` being updated.

Example

{
  "clientMutationId": "xyz789",
  "nodeId": ID,
  "patch": UsersToGroupPatch
}

Types

`UpdateUsersToGroupByUserIdAndUserGroupIdInput`

All input for the updateUsersToGroupByUserIdAndUserGroupId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `UsersToGroupPatch!`	An object where the defined keys will be set on the `UsersToGroup` being updated.
`userId` - `UUID!`	User unique ID.
`userGroupId` - `UUID!`	User Group unique ID.

Example

{
  "clientMutationId": "abc123",
  "patch": UsersToGroupPatch,
  "userId": UUID,
  "userGroupId": UUID
}

Types

`UpdateUsersToGroupInput`

All input for the updateUsersToGroup mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `UsersToGroupPatch!`	An object where the defined keys will be set on the `UsersToGroup` being updated.
`id` - `UUID!`

Example

{
  "clientMutationId": "xyz789",
  "patch": UsersToGroupPatch,
  "id": UUID
}

Types

`UpdateUsersToGroupPayload`

The output of our update UsersToGroup mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`usersToGroup` - `UsersToGroup`	The `UsersToGroup` that was updated by this mutation.
`user` - `User`	Reads a single `User` that is related to this `UsersToGroup`.
`userGroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `UsersToGroup`.
`usersToGroupEdge` - `UsersToGroupsEdge`	An edge for our `UsersToGroup`. May be used by Relay 1.
Arguments `orderBy` - `[UsersToGroupsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToGroup`.

Example

{
  "clientMutationId": "xyz789",
  "usersToGroup": UsersToGroup,
  "user": User,
  "userGroup": UserGroup,
  "usersToGroupEdge": UsersToGroupsEdge
}

Types

`UpdateUsersToObjectByNodeIdInput`

All input for the updateUsersToObjectByNodeId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`nodeId` - `ID!`	The globally unique `ID` which will identify a single `UsersToObject` to be updated.
`patch` - `UsersToObjectPatch!`	An object where the defined keys will be set on the `UsersToObject` being updated.

Example

{
  "clientMutationId": "abc123",
  "nodeId": ID,
  "patch": UsersToObjectPatch
}

Types

`UpdateUsersToObjectByUserIdAndObjectIdInput`

All input for the updateUsersToObjectByUserIdAndObjectId mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `UsersToObjectPatch!`	An object where the defined keys will be set on the `UsersToObject` being updated.
`userId` - `UUID!`	User unique ID.
`objectId` - `UUID!`	Object unique ID.

Example

{
  "clientMutationId": "xyz789",
  "patch": UsersToObjectPatch,
  "userId": UUID,
  "objectId": UUID
}

Types

`UpdateUsersToObjectInput`

All input for the updateUsersToObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`patch` - `UsersToObjectPatch!`	An object where the defined keys will be set on the `UsersToObject` being updated.
`id` - `UUID!`

Example

{
  "clientMutationId": "abc123",
  "patch": UsersToObjectPatch,
  "id": UUID
}

Types

`UpdateUsersToObjectPayload`

The output of our update UsersToObject mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`usersToObject` - `UsersToObject`	The `UsersToObject` that was updated by this mutation.
`user` - `User`	Reads a single `User` that is related to this `UsersToObject`.
`object` - `Object`	Reads a single `Object` that is related to this `UsersToObject`.
`usersToObjectEdge` - `UsersToObjectsEdge`	An edge for our `UsersToObject`. May be used by Relay 1.
Arguments `orderBy` - `[UsersToObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToObject`.

Example

{
  "clientMutationId": "xyz789",
  "usersToObject": UsersToObject,
  "user": User,
  "object": Object,
  "usersToObjectEdge": UsersToObjectsEdge
}

Types

`User`

Users existing within the platform.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`	User unique ID.
`login` - `String!`	User's login name (User name).
`password` - `String!`	User password hash.
`showhidden` - `Boolean`	true
`enabled` - `Boolean!`	Administrative User's status.
`description` - `String`	User description.
`mName` - `String`	User name meta information.
`mExternalId` - `JSON`	User ID in the external system meta information.
`mPhone` - `String`	User phone meta information.
`mEmail` - `String`	User email meta information.
`mPicture` - `UUID`	User picture (Media Object) meta information.
`mIcon` - `UUID`	User icon (Media Object) meta information.
`createdAt` - `Datetime!`	User creation timestamp.
`updatedAt` - `Datetime!`	User last update timestamp.
`by` - `UUID`	User last updated the User.
`type` - `UserTypes!`	User type (USER or APP)
`tokenExp` - `BigInt`	Refresh token expiration in days.
`activated` - `Boolean`	Indicates if the User is activated.
`passwordReset` - `Boolean`	Indicates if the User's password reset requested.
`mTags` - `[String]`
`defaultEditorgroup` - `UUID`
`defaultUsergroup` - `UUID!`
`defaultReadergroup` - `UUID!`
`um` - `Boolean!`
`passwordExpireAt` - `Datetime!`
`logonStatus` - `String`
`twoFaType` - `TwoFaTypes!`
`userGroupByDefaultEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`notificationsByByConnection` - `NotificationsConnection!`	Reads and enables pagination through a set of `Notification`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[NotificationsSort!]` The specification of how the `Notification` records should be sorted. `orderBy` - `[NotificationsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Notification`. `condition` - `NotificationCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationFilter` A filter to be used in determining which values should be returned by the collection.
`notificationsByBy` - `[Notification!]!`	Reads and enables pagination through a set of `Notification`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[NotificationsSort!]` The specification of how the `Notification` records should be sorted. `orderBy` - `[NotificationsOrderBy!]` The method to use when ordering `Notification`. `condition` - `NotificationCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationFilter` A filter to be used in determining which values should be returned by the collection.
`schemaPropertiesByByConnection` - `SchemaPropertiesConnection!`	Reads and enables pagination through a set of `SchemaProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemaPropertiesSort!]` The specification of how the `SchemaProperty` records should be sorted. `orderBy` - `[SchemaPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaProperty`. `condition` - `SchemaPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`schemaPropertiesByBy` - `[SchemaProperty!]!`	Reads and enables pagination through a set of `SchemaProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemaPropertiesSort!]` The specification of how the `SchemaProperty` records should be sorted. `orderBy` - `[SchemaPropertiesOrderBy!]` The method to use when ordering `SchemaProperty`. `condition` - `SchemaPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`objectPropertiesByByConnection` - `ObjectPropertiesConnection!`	Reads and enables pagination through a set of `ObjectProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectPropertiesSort!]` The specification of how the `ObjectProperty` records should be sorted. `orderBy` - `[ObjectPropertiesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectProperty`. `condition` - `ObjectPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`objectPropertiesByBy` - `[ObjectProperty!]!`	Reads and enables pagination through a set of `ObjectProperty`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectPropertiesSort!]` The specification of how the `ObjectProperty` records should be sorted. `orderBy` - `[ObjectPropertiesOrderBy!]` The method to use when ordering `ObjectProperty`. `condition` - `ObjectPropertyCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectPropertyFilter` A filter to be used in determining which values should be returned by the collection.
`objectsByByConnection` - `ObjectsConnection!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objectsByBy` - `[Object!]!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`schemaControlsByByConnection` - `SchemaControlsConnection!`	Reads and enables pagination through a set of `SchemaControl`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemaControlsSort!]` The specification of how the `SchemaControl` records should be sorted. `orderBy` - `[SchemaControlsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `SchemaControl`. `condition` - `SchemaControlCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaControlFilter` A filter to be used in determining which values should be returned by the collection.
`schemaControlsByBy` - `[SchemaControl!]!`	Reads and enables pagination through a set of `SchemaControl`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemaControlsSort!]` The specification of how the `SchemaControl` records should be sorted. `orderBy` - `[SchemaControlsOrderBy!]` The method to use when ordering `SchemaControl`. `condition` - `SchemaControlCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaControlFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByApplicationOwnerConnection` - `SchemataConnection!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByApplicationOwner` - `[Schema!]!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByByConnection` - `SchemataConnection!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByBy` - `[Schema!]!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`objectPropertiesHistoriesByByConnection` - `ObjectPropertiesHistoriesConnection!`	Reads and enables pagination through a set of `ObjectPropertiesHistory`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectPropertiesHistorySort!]` The specification of how the `ObjectPropertiesHistory` records should be sorted. `orderBy` - `[ObjectPropertiesHistoriesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ObjectPropertiesHistory`. `condition` - `ObjectPropertiesHistoryCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectPropertiesHistoryFilter` A filter to be used in determining which values should be returned by the collection.
`objectPropertiesHistoriesByBy` - `[ObjectPropertiesHistory!]!`	Reads and enables pagination through a set of `ObjectPropertiesHistory`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectPropertiesHistorySort!]` The specification of how the `ObjectPropertiesHistory` records should be sorted. `orderBy` - `[ObjectPropertiesHistoriesOrderBy!]` The method to use when ordering `ObjectPropertiesHistory`. `condition` - `ObjectPropertiesHistoryCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectPropertiesHistoryFilter` A filter to be used in determining which values should be returned by the collection.
`controlExecutionsByCallerIdConnection` - `ControlExecutionsConnection!`	Reads and enables pagination through a set of `ControlExecution`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ControlExecutionsSort!]` The specification of how the `ControlExecution` records should be sorted. `orderBy` - `[ControlExecutionsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `ControlExecution`. `condition` - `ControlExecutionCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ControlExecutionFilter` A filter to be used in determining which values should be returned by the collection.
`controlExecutionsByCallerId` - `[ControlExecution!]!`	Reads and enables pagination through a set of `ControlExecution`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ControlExecutionsSort!]` The specification of how the `ControlExecution` records should be sorted. `orderBy` - `[ControlExecutionsOrderBy!]` The method to use when ordering `ControlExecution`. `condition` - `ControlExecutionCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ControlExecutionFilter` A filter to be used in determining which values should be returned by the collection.
`notificationDeliveriesByUserConnection` - `NotificationDeliveriesConnection!`	Reads and enables pagination through a set of `NotificationDelivery`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[NotificationDeliveriesSort!]` The specification of how the `NotificationDelivery` records should be sorted. `orderBy` - `[NotificationDeliveriesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `NotificationDelivery`. `condition` - `NotificationDeliveryCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationDeliveryFilter` A filter to be used in determining which values should be returned by the collection.
`notificationDeliveriesByUser` - `[NotificationDelivery!]!`	Reads and enables pagination through a set of `NotificationDelivery`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[NotificationDeliveriesSort!]` The specification of how the `NotificationDelivery` records should be sorted. `orderBy` - `[NotificationDeliveriesOrderBy!]` The method to use when ordering `NotificationDelivery`. `condition` - `NotificationDeliveryCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `NotificationDeliveryFilter` A filter to be used in determining which values should be returned by the collection.
`userGroupsByByConnection` - `UserGroupsConnection!`	Reads and enables pagination through a set of `UserGroup`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UserGroupsSort!]` The specification of how the `UserGroup` records should be sorted. `orderBy` - `[UserGroupsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UserGroup`. `condition` - `UserGroupCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserGroupFilter` A filter to be used in determining which values should be returned by the collection.
`userGroupsByBy` - `[UserGroup!]!`	Reads and enables pagination through a set of `UserGroup`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UserGroupsSort!]` The specification of how the `UserGroup` records should be sorted. `orderBy` - `[UserGroupsOrderBy!]` The method to use when ordering `UserGroup`. `condition` - `UserGroupCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserGroupFilter` A filter to be used in determining which values should be returned by the collection.
`userProfilesConnection` - `UserProfilesConnection!`	Reads and enables pagination through a set of `UserProfile`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UserProfilesSort!]` The specification of how the `UserProfile` records should be sorted. `orderBy` - `[UserProfilesOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UserProfile`. `condition` - `UserProfileCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserProfileFilter` A filter to be used in determining which values should be returned by the collection.
`userProfiles` - `[UserProfile!]!`	Reads and enables pagination through a set of `UserProfile`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UserProfilesSort!]` The specification of how the `UserProfile` records should be sorted. `orderBy` - `[UserProfilesOrderBy!]` The method to use when ordering `UserProfile`. `condition` - `UserProfileCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserProfileFilter` A filter to be used in determining which values should be returned by the collection.
`usersToGroupsConnection` - `UsersToGroupsConnection!`	Reads and enables pagination through a set of `UsersToGroup`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UsersToGroupsSort!]` The specification of how the `UsersToGroup` records should be sorted. `orderBy` - `[UsersToGroupsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToGroup`. `condition` - `UsersToGroupCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UsersToGroupFilter` A filter to be used in determining which values should be returned by the collection.
`usersToGroups` - `[UsersToGroup!]!`	Reads and enables pagination through a set of `UsersToGroup`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UsersToGroupsSort!]` The specification of how the `UsersToGroup` records should be sorted. `orderBy` - `[UsersToGroupsOrderBy!]` The method to use when ordering `UsersToGroup`. `condition` - `UsersToGroupCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UsersToGroupFilter` A filter to be used in determining which values should be returned by the collection.
`usersToObjectsConnection` - `UsersToObjectsConnection!`	Reads and enables pagination through a set of `UsersToObject`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UsersToObjectsSort!]` The specification of how the `UsersToObject` records should be sorted. `orderBy` - `[UsersToObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToObject`. `condition` - `UsersToObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UsersToObjectFilter` A filter to be used in determining which values should be returned by the collection.
`usersToObjects` - `[UsersToObject!]!`	Reads and enables pagination through a set of `UsersToObject`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UsersToObjectsSort!]` The specification of how the `UsersToObject` records should be sorted. `orderBy` - `[UsersToObjectsOrderBy!]` The method to use when ordering `UsersToObject`. `condition` - `UsersToObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UsersToObjectFilter` A filter to be used in determining which values should be returned by the collection.

Example

{
  "nodeId": ID,
  "id": UUID,
  "login": "abc123",
  "password": "abc123",
  "showhidden": true,
  "enabled": true,
  "description": "xyz789",
  "mName": "xyz789",
  "mExternalId": {},
  "mPhone": "xyz789",
  "mEmail": "xyz789",
  "mPicture": UUID,
  "mIcon": UUID,
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "type": UserTypes,
  "tokenExp": BigInt,
  "activated": false,
  "passwordReset": true,
  "mTags": ["abc123"],
  "defaultEditorgroup": UUID,
  "defaultUsergroup": UUID,
  "defaultReadergroup": UUID,
  "um": false,
  "passwordExpireAt": Datetime,
  "logonStatus": "abc123",
  "twoFaType": TwoFaTypes,
  "userGroupByDefaultEditorgroup": UserGroup,
  "userGroupByDefaultUsergroup": UserGroup,
  "userGroupByDefaultReadergroup": UserGroup,
  "notificationsByByConnection": NotificationsConnection,
  "notificationsByBy": [Notification],
  "schemaPropertiesByByConnection": SchemaPropertiesConnection,
  "schemaPropertiesByBy": [SchemaProperty],
  "objectPropertiesByByConnection": ObjectPropertiesConnection,
  "objectPropertiesByBy": [ObjectProperty],
  "objectsByByConnection": ObjectsConnection,
  "objectsByBy": [Object],
  "schemaControlsByByConnection": SchemaControlsConnection,
  "schemaControlsByBy": [SchemaControl],
  "schemataByApplicationOwnerConnection": SchemataConnection,
  "schemataByApplicationOwner": [Schema],
  "schemataByByConnection": SchemataConnection,
  "schemataByBy": [Schema],
  "objectPropertiesHistoriesByByConnection": ObjectPropertiesHistoriesConnection,
  "objectPropertiesHistoriesByBy": [
    ObjectPropertiesHistory
  ],
  "controlExecutionsByCallerIdConnection": ControlExecutionsConnection,
  "controlExecutionsByCallerId": [ControlExecution],
  "notificationDeliveriesByUserConnection": NotificationDeliveriesConnection,
  "notificationDeliveriesByUser": [NotificationDelivery],
  "userGroupsByByConnection": UserGroupsConnection,
  "userGroupsByBy": [UserGroup],
  "userProfilesConnection": UserProfilesConnection,
  "userProfiles": [UserProfile],
  "usersToGroupsConnection": UsersToGroupsConnection,
  "usersToGroups": [UsersToGroup],
  "usersToObjectsConnection": UsersToObjectsConnection,
  "usersToObjects": [UsersToObject]
}

Types

`UserCondition`

A condition to be used against User object types. All fields are tested for equality and combined with a logical ‘and.’

Field Name	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`login` - `String`	Checks for equality with the object’s `login` field.
`password` - `String`	Checks for equality with the object’s `password` field.
`showhidden` - `Boolean`	Checks for equality with the object’s `showhidden` field.
`enabled` - `Boolean`	Checks for equality with the object’s `enabled` field.
`description` - `String`	Checks for equality with the object’s `description` field.
`mName` - `String`	Checks for equality with the object’s `mName` field.
`mExternalId` - `JSON`	Checks for equality with the object’s `mExternalId` field.
`mPhone` - `String`	Checks for equality with the object’s `mPhone` field.
`mEmail` - `String`	Checks for equality with the object’s `mEmail` field.
`mPicture` - `UUID`	Checks for equality with the object’s `mPicture` field.
`mIcon` - `UUID`	Checks for equality with the object’s `mIcon` field.
`createdAt` - `Datetime`	Checks for equality with the object’s `createdAt` field.
`updatedAt` - `Datetime`	Checks for equality with the object’s `updatedAt` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.
`type` - `UserTypes`	Checks for equality with the object’s `type` field.
`tokenExp` - `BigInt`	Checks for equality with the object’s `tokenExp` field.
`activated` - `Boolean`	Checks for equality with the object’s `activated` field.
`passwordReset` - `Boolean`	Checks for equality with the object’s `passwordReset` field.
`mTags` - `[String]`	Checks for equality with the object’s `mTags` field.
`defaultEditorgroup` - `UUID`	Checks for equality with the object’s `defaultEditorgroup` field.
`defaultUsergroup` - `UUID`	Checks for equality with the object’s `defaultUsergroup` field.
`defaultReadergroup` - `UUID`	Checks for equality with the object’s `defaultReadergroup` field.
`um` - `Boolean`	Checks for equality with the object’s `um` field.
`passwordExpireAt` - `Datetime`	Checks for equality with the object’s `passwordExpireAt` field.
`logonStatus` - `String`	Checks for equality with the object’s `logonStatus` field.
`twoFaType` - `TwoFaTypes`	Checks for equality with the object’s `twoFaType` field.

Example

{
  "id": UUID,
  "login": "xyz789",
  "password": "abc123",
  "showhidden": true,
  "enabled": true,
  "description": "xyz789",
  "mName": "abc123",
  "mExternalId": {},
  "mPhone": "xyz789",
  "mEmail": "xyz789",
  "mPicture": UUID,
  "mIcon": UUID,
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "type": UserTypes,
  "tokenExp": BigInt,
  "activated": true,
  "passwordReset": true,
  "mTags": ["xyz789"],
  "defaultEditorgroup": UUID,
  "defaultUsergroup": UUID,
  "defaultReadergroup": UUID,
  "um": true,
  "passwordExpireAt": Datetime,
  "logonStatus": "abc123",
  "twoFaType": TwoFaTypes
}

Types

`UserFilter`

A filter to be used against User object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`login` - `StringFilter`	Filter by the object’s `login` field.
`password` - `StringFilter`	Filter by the object’s `password` field.
`showhidden` - `BooleanFilter`	Filter by the object’s `showhidden` field.
`enabled` - `BooleanFilter`	Filter by the object’s `enabled` field.
`description` - `StringFilter`	Filter by the object’s `description` field.
`mName` - `StringFilter`	Filter by the object’s `mName` field.
`mExternalId` - `JSONFilter`	Filter by the object’s `mExternalId` field.
`mPhone` - `StringFilter`	Filter by the object’s `mPhone` field.
`mEmail` - `StringFilter`	Filter by the object’s `mEmail` field.
`mPicture` - `UUIDFilter`	Filter by the object’s `mPicture` field.
`mIcon` - `UUIDFilter`	Filter by the object’s `mIcon` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`updatedAt` - `DatetimeFilter`	Filter by the object’s `updatedAt` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`type` - `UserTypesFilter`	Filter by the object’s `type` field.
`tokenExp` - `BigIntFilter`	Filter by the object’s `tokenExp` field.
`activated` - `BooleanFilter`	Filter by the object’s `activated` field.
`passwordReset` - `BooleanFilter`	Filter by the object’s `passwordReset` field.
`mTags` - `StringListFilter`	Filter by the object’s `mTags` field.
`defaultEditorgroup` - `UUIDFilter`	Filter by the object’s `defaultEditorgroup` field.
`defaultUsergroup` - `UUIDFilter`	Filter by the object’s `defaultUsergroup` field.
`defaultReadergroup` - `UUIDFilter`	Filter by the object’s `defaultReadergroup` field.
`um` - `BooleanFilter`	Filter by the object’s `um` field.
`passwordExpireAt` - `DatetimeFilter`	Filter by the object’s `passwordExpireAt` field.
`logonStatus` - `StringFilter`	Filter by the object’s `logonStatus` field.
`twoFaType` - `TwoFaTypesFilter`	Filter by the object’s `twoFaType` field.
`notificationsByByConnection` - `UserToManyNotificationFilter`	Filter by the object’s `notificationsByByConnection` relation.
`notificationsByByConnectionExist` - `Boolean`	Some related `notificationsByByConnection` exist.
`schemaPropertiesByByConnection` - `UserToManySchemaPropertyFilter`	Filter by the object’s `schemaPropertiesByByConnection` relation.
`schemaPropertiesByByConnectionExist` - `Boolean`	Some related `schemaPropertiesByByConnection` exist.
`objectPropertiesByByConnection` - `UserToManyObjectPropertyFilter`	Filter by the object’s `objectPropertiesByByConnection` relation.
`objectPropertiesByByConnectionExist` - `Boolean`	Some related `objectPropertiesByByConnection` exist.
`objectsByByConnection` - `UserToManyObjectFilter`	Filter by the object’s `objectsByByConnection` relation.
`objectsByByConnectionExist` - `Boolean`	Some related `objectsByByConnection` exist.
`schemaControlsByByConnection` - `UserToManySchemaControlFilter`	Filter by the object’s `schemaControlsByByConnection` relation.
`schemaControlsByByConnectionExist` - `Boolean`	Some related `schemaControlsByByConnection` exist.
`schemataByApplicationOwnerConnection` - `UserToManySchemaFilter`	Filter by the object’s `schemataByApplicationOwnerConnection` relation.
`schemataByApplicationOwnerConnectionExist` - `Boolean`	Some related `schemataByApplicationOwnerConnection` exist.
`schemataByByConnection` - `UserToManySchemaFilter`	Filter by the object’s `schemataByByConnection` relation.
`schemataByByConnectionExist` - `Boolean`	Some related `schemataByByConnection` exist.
`objectPropertiesHistoriesByByConnection` - `UserToManyObjectPropertiesHistoryFilter`	Filter by the object’s `objectPropertiesHistoriesByByConnection` relation.
`objectPropertiesHistoriesByByConnectionExist` - `Boolean`	Some related `objectPropertiesHistoriesByByConnection` exist.
`controlExecutionsByCallerIdConnection` - `UserToManyControlExecutionFilter`	Filter by the object’s `controlExecutionsByCallerIdConnection` relation.
`controlExecutionsByCallerIdConnectionExist` - `Boolean`	Some related `controlExecutionsByCallerIdConnection` exist.
`notificationDeliveriesByUserConnection` - `UserToManyNotificationDeliveryFilter`	Filter by the object’s `notificationDeliveriesByUserConnection` relation.
`notificationDeliveriesByUserConnectionExist` - `Boolean`	Some related `notificationDeliveriesByUserConnection` exist.
`userGroupsByByConnection` - `UserToManyUserGroupFilter`	Filter by the object’s `userGroupsByByConnection` relation.
`userGroupsByByConnectionExist` - `Boolean`	Some related `userGroupsByByConnection` exist.
`userProfilesConnection` - `UserToManyUserProfileFilter`	Filter by the object’s `userProfilesConnection` relation.
`userProfilesConnectionExist` - `Boolean`	Some related `userProfilesConnection` exist.
`usersToGroupsConnection` - `UserToManyUsersToGroupFilter`	Filter by the object’s `usersToGroupsConnection` relation.
`usersToGroupsConnectionExist` - `Boolean`	Some related `usersToGroupsConnection` exist.
`usersToObjectsConnection` - `UserToManyUsersToObjectFilter`	Filter by the object’s `usersToObjectsConnection` relation.
`usersToObjectsConnectionExist` - `Boolean`	Some related `usersToObjectsConnection` exist.
`userGroupByDefaultEditorgroup` - `UserGroupFilter`	Filter by the object’s `userGroupByDefaultEditorgroup` relation.
`userGroupByDefaultEditorgroupExists` - `Boolean`	A related `userGroupByDefaultEditorgroup` exists.
`userGroupByDefaultUsergroup` - `UserGroupFilter`	Filter by the object’s `userGroupByDefaultUsergroup` relation.
`userGroupByDefaultReadergroup` - `UserGroupFilter`	Filter by the object’s `userGroupByDefaultReadergroup` relation.
`and` - `[UserFilter!]`	Checks for all expressions in this list.
`or` - `[UserFilter!]`	Checks for any expressions in this list.
`not` - `UserFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "login": StringFilter,
  "password": StringFilter,
  "showhidden": BooleanFilter,
  "enabled": BooleanFilter,
  "description": StringFilter,
  "mName": StringFilter,
  "mExternalId": JSONFilter,
  "mPhone": StringFilter,
  "mEmail": StringFilter,
  "mPicture": UUIDFilter,
  "mIcon": UUIDFilter,
  "createdAt": DatetimeFilter,
  "updatedAt": DatetimeFilter,
  "by": UUIDFilter,
  "type": UserTypesFilter,
  "tokenExp": BigIntFilter,
  "activated": BooleanFilter,
  "passwordReset": BooleanFilter,
  "mTags": StringListFilter,
  "defaultEditorgroup": UUIDFilter,
  "defaultUsergroup": UUIDFilter,
  "defaultReadergroup": UUIDFilter,
  "um": BooleanFilter,
  "passwordExpireAt": DatetimeFilter,
  "logonStatus": StringFilter,
  "twoFaType": TwoFaTypesFilter,
  "notificationsByByConnection": UserToManyNotificationFilter,
  "notificationsByByConnectionExist": false,
  "schemaPropertiesByByConnection": UserToManySchemaPropertyFilter,
  "schemaPropertiesByByConnectionExist": false,
  "objectPropertiesByByConnection": UserToManyObjectPropertyFilter,
  "objectPropertiesByByConnectionExist": true,
  "objectsByByConnection": UserToManyObjectFilter,
  "objectsByByConnectionExist": true,
  "schemaControlsByByConnection": UserToManySchemaControlFilter,
  "schemaControlsByByConnectionExist": true,
  "schemataByApplicationOwnerConnection": UserToManySchemaFilter,
  "schemataByApplicationOwnerConnectionExist": false,
  "schemataByByConnection": UserToManySchemaFilter,
  "schemataByByConnectionExist": false,
  "objectPropertiesHistoriesByByConnection": UserToManyObjectPropertiesHistoryFilter,
  "objectPropertiesHistoriesByByConnectionExist": true,
  "controlExecutionsByCallerIdConnection": UserToManyControlExecutionFilter,
  "controlExecutionsByCallerIdConnectionExist": true,
  "notificationDeliveriesByUserConnection": UserToManyNotificationDeliveryFilter,
  "notificationDeliveriesByUserConnectionExist": true,
  "userGroupsByByConnection": UserToManyUserGroupFilter,
  "userGroupsByByConnectionExist": true,
  "userProfilesConnection": UserToManyUserProfileFilter,
  "userProfilesConnectionExist": false,
  "usersToGroupsConnection": UserToManyUsersToGroupFilter,
  "usersToGroupsConnectionExist": true,
  "usersToObjectsConnection": UserToManyUsersToObjectFilter,
  "usersToObjectsConnectionExist": false,
  "userGroupByDefaultEditorgroup": UserGroupFilter,
  "userGroupByDefaultEditorgroupExists": false,
  "userGroupByDefaultUsergroup": UserGroupFilter,
  "userGroupByDefaultReadergroup": UserGroupFilter,
  "and": [UserFilter],
  "or": [UserFilter],
  "not": UserFilter
}

Types

`UserGroup`

User Groups represent groups of Users.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`	User Group unique ID.
`groupName` - `String!`	User Group name.
`description` - `String`	User Group description.
`createdAt` - `Datetime!`	User Group creation timestamp.
`updatedAt` - `Datetime!`	User Group last update timestamp.
`by` - `UUID`	User last updated the Object.
`isSystem` - `Boolean`	Indicates if the User Group is a system group.
`userByBy` - `User`	Reads a single `User` that is related to this `UserGroup`.
`objectsByEditorgroupConnection` - `ObjectsConnection!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objectsByEditorgroup` - `[Object!]!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objectsByUsergroupConnection` - `ObjectsConnection!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objectsByUsergroup` - `[Object!]!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objectsByReadergroupConnection` - `ObjectsConnection!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`objectsByReadergroup` - `[Object!]!`	Reads and enables pagination through a set of `Object`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[ObjectsSort!]` The specification of how the `Object` records should be sorted. `orderBy` - `[ObjectsOrderBy!]` The method to use when ordering `Object`. `condition` - `ObjectCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `ObjectFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByEditorgroupConnection` - `SchemataConnection!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByEditorgroup` - `[Schema!]!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByUsergroupConnection` - `SchemataConnection!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByUsergroup` - `[Schema!]!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByReadergroupConnection` - `SchemataConnection!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`schemataByReadergroup` - `[Schema!]!`	Reads and enables pagination through a set of `Schema`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[SchemasSort!]` The specification of how the `Schema` records should be sorted. `orderBy` - `[SchemataOrderBy!]` The method to use when ordering `Schema`. `condition` - `SchemaCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `SchemaFilter` A filter to be used in determining which values should be returned by the collection.
`usersByDefaultEditorgroupConnection` - `UsersConnection!`	Reads and enables pagination through a set of `User`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UsersSort!]` The specification of how the `User` records should be sorted. `orderBy` - `[UsersOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `User`. `condition` - `UserCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserFilter` A filter to be used in determining which values should be returned by the collection.
`usersByDefaultEditorgroup` - `[User!]!`	Reads and enables pagination through a set of `User`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UsersSort!]` The specification of how the `User` records should be sorted. `orderBy` - `[UsersOrderBy!]` The method to use when ordering `User`. `condition` - `UserCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserFilter` A filter to be used in determining which values should be returned by the collection.
`usersByDefaultUsergroupConnection` - `UsersConnection!`	Reads and enables pagination through a set of `User`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UsersSort!]` The specification of how the `User` records should be sorted. `orderBy` - `[UsersOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `User`. `condition` - `UserCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserFilter` A filter to be used in determining which values should be returned by the collection.
`usersByDefaultUsergroup` - `[User!]!`	Reads and enables pagination through a set of `User`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UsersSort!]` The specification of how the `User` records should be sorted. `orderBy` - `[UsersOrderBy!]` The method to use when ordering `User`. `condition` - `UserCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserFilter` A filter to be used in determining which values should be returned by the collection.
`usersByDefaultReadergroupConnection` - `UsersConnection!`	Reads and enables pagination through a set of `User`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UsersSort!]` The specification of how the `User` records should be sorted. `orderBy` - `[UsersOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `User`. `condition` - `UserCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserFilter` A filter to be used in determining which values should be returned by the collection.
`usersByDefaultReadergroup` - `[User!]!`	Reads and enables pagination through a set of `User`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UsersSort!]` The specification of how the `User` records should be sorted. `orderBy` - `[UsersOrderBy!]` The method to use when ordering `User`. `condition` - `UserCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UserFilter` A filter to be used in determining which values should be returned by the collection.
`usersToGroupsConnection` - `UsersToGroupsConnection!`	Reads and enables pagination through a set of `UsersToGroup`.
Arguments `first` - `Int` Only read the first `n` values of the set. `last` - `Int` Only read the last `n` values of the set. `offset` - `Int` Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`. `before` - `Cursor` Read all values in the set before (above) this cursor. `after` - `Cursor` Read all values in the set after (below) this cursor. `sort` - `[UsersToGroupsSort!]` The specification of how the `UsersToGroup` records should be sorted. `orderBy` - `[UsersToGroupsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `UsersToGroup`. `condition` - `UsersToGroupCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UsersToGroupFilter` A filter to be used in determining which values should be returned by the collection.
`usersToGroups` - `[UsersToGroup!]!`	Reads and enables pagination through a set of `UsersToGroup`.
Arguments `first` - `Int` Only read the first `n` values of the set. `offset` - `Int` Skip the first `n` values. `sort` - `[UsersToGroupsSort!]` The specification of how the `UsersToGroup` records should be sorted. `orderBy` - `[UsersToGroupsOrderBy!]` The method to use when ordering `UsersToGroup`. `condition` - `UsersToGroupCondition` A condition to be used in determining which values should be returned by the collection. `filter` - `UsersToGroupFilter` A filter to be used in determining which values should be returned by the collection.

Example

{
  "nodeId": ID,
  "id": UUID,
  "groupName": "abc123",
  "description": "xyz789",
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "isSystem": true,
  "userByBy": User,
  "objectsByEditorgroupConnection": ObjectsConnection,
  "objectsByEditorgroup": [Object],
  "objectsByUsergroupConnection": ObjectsConnection,
  "objectsByUsergroup": [Object],
  "objectsByReadergroupConnection": ObjectsConnection,
  "objectsByReadergroup": [Object],
  "schemataByEditorgroupConnection": SchemataConnection,
  "schemataByEditorgroup": [Schema],
  "schemataByUsergroupConnection": SchemataConnection,
  "schemataByUsergroup": [Schema],
  "schemataByReadergroupConnection": SchemataConnection,
  "schemataByReadergroup": [Schema],
  "usersByDefaultEditorgroupConnection": UsersConnection,
  "usersByDefaultEditorgroup": [User],
  "usersByDefaultUsergroupConnection": UsersConnection,
  "usersByDefaultUsergroup": [User],
  "usersByDefaultReadergroupConnection": UsersConnection,
  "usersByDefaultReadergroup": [User],
  "usersToGroupsConnection": UsersToGroupsConnection,
  "usersToGroups": [UsersToGroup]
}

Types

`UserGroupCondition`

A condition to be used against UserGroup object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`groupName` - `String`	Checks for equality with the object’s `groupName` field.
`description` - `String`	Checks for equality with the object’s `description` field.
`createdAt` - `Datetime`	Checks for equality with the object’s `createdAt` field.
`updatedAt` - `Datetime`	Checks for equality with the object’s `updatedAt` field.
`by` - `UUID`	Checks for equality with the object’s `by` field.
`isSystem` - `Boolean`	Checks for equality with the object’s `isSystem` field.

Example

{
  "id": UUID,
  "groupName": "xyz789",
  "description": "abc123",
  "createdAt": Datetime,
  "updatedAt": Datetime,
  "by": UUID,
  "isSystem": false
}

Types

`UserGroupFilter`

A filter to be used against UserGroup object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`groupName` - `StringFilter`	Filter by the object’s `groupName` field.
`description` - `StringFilter`	Filter by the object’s `description` field.
`createdAt` - `DatetimeFilter`	Filter by the object’s `createdAt` field.
`updatedAt` - `DatetimeFilter`	Filter by the object’s `updatedAt` field.
`by` - `UUIDFilter`	Filter by the object’s `by` field.
`isSystem` - `BooleanFilter`	Filter by the object’s `isSystem` field.
`objectsByEditorgroupConnection` - `UserGroupToManyObjectFilter`	Filter by the object’s `objectsByEditorgroupConnection` relation.
`objectsByEditorgroupConnectionExist` - `Boolean`	Some related `objectsByEditorgroupConnection` exist.
`objectsByUsergroupConnection` - `UserGroupToManyObjectFilter`	Filter by the object’s `objectsByUsergroupConnection` relation.
`objectsByUsergroupConnectionExist` - `Boolean`	Some related `objectsByUsergroupConnection` exist.
`objectsByReadergroupConnection` - `UserGroupToManyObjectFilter`	Filter by the object’s `objectsByReadergroupConnection` relation.
`objectsByReadergroupConnectionExist` - `Boolean`	Some related `objectsByReadergroupConnection` exist.
`schemataByEditorgroupConnection` - `UserGroupToManySchemaFilter`	Filter by the object’s `schemataByEditorgroupConnection` relation.
`schemataByEditorgroupConnectionExist` - `Boolean`	Some related `schemataByEditorgroupConnection` exist.
`schemataByUsergroupConnection` - `UserGroupToManySchemaFilter`	Filter by the object’s `schemataByUsergroupConnection` relation.
`schemataByUsergroupConnectionExist` - `Boolean`	Some related `schemataByUsergroupConnection` exist.
`schemataByReadergroupConnection` - `UserGroupToManySchemaFilter`	Filter by the object’s `schemataByReadergroupConnection` relation.
`schemataByReadergroupConnectionExist` - `Boolean`	Some related `schemataByReadergroupConnection` exist.
`usersByDefaultEditorgroupConnection` - `UserGroupToManyUserFilter`	Filter by the object’s `usersByDefaultEditorgroupConnection` relation.
`usersByDefaultEditorgroupConnectionExist` - `Boolean`	Some related `usersByDefaultEditorgroupConnection` exist.
`usersByDefaultUsergroupConnection` - `UserGroupToManyUserFilter`	Filter by the object’s `usersByDefaultUsergroupConnection` relation.
`usersByDefaultUsergroupConnectionExist` - `Boolean`	Some related `usersByDefaultUsergroupConnection` exist.
`usersByDefaultReadergroupConnection` - `UserGroupToManyUserFilter`	Filter by the object’s `usersByDefaultReadergroupConnection` relation.
`usersByDefaultReadergroupConnectionExist` - `Boolean`	Some related `usersByDefaultReadergroupConnection` exist.
`usersToGroupsConnection` - `UserGroupToManyUsersToGroupFilter`	Filter by the object’s `usersToGroupsConnection` relation.
`usersToGroupsConnectionExist` - `Boolean`	Some related `usersToGroupsConnection` exist.
`userByBy` - `UserFilter`	Filter by the object’s `userByBy` relation.
`userByByExists` - `Boolean`	A related `userByBy` exists.
`and` - `[UserGroupFilter!]`	Checks for all expressions in this list.
`or` - `[UserGroupFilter!]`	Checks for any expressions in this list.
`not` - `UserGroupFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "groupName": StringFilter,
  "description": StringFilter,
  "createdAt": DatetimeFilter,
  "updatedAt": DatetimeFilter,
  "by": UUIDFilter,
  "isSystem": BooleanFilter,
  "objectsByEditorgroupConnection": UserGroupToManyObjectFilter,
  "objectsByEditorgroupConnectionExist": false,
  "objectsByUsergroupConnection": UserGroupToManyObjectFilter,
  "objectsByUsergroupConnectionExist": false,
  "objectsByReadergroupConnection": UserGroupToManyObjectFilter,
  "objectsByReadergroupConnectionExist": true,
  "schemataByEditorgroupConnection": UserGroupToManySchemaFilter,
  "schemataByEditorgroupConnectionExist": true,
  "schemataByUsergroupConnection": UserGroupToManySchemaFilter,
  "schemataByUsergroupConnectionExist": true,
  "schemataByReadergroupConnection": UserGroupToManySchemaFilter,
  "schemataByReadergroupConnectionExist": true,
  "usersByDefaultEditorgroupConnection": UserGroupToManyUserFilter,
  "usersByDefaultEditorgroupConnectionExist": false,
  "usersByDefaultUsergroupConnection": UserGroupToManyUserFilter,
  "usersByDefaultUsergroupConnectionExist": false,
  "usersByDefaultReadergroupConnection": UserGroupToManyUserFilter,
  "usersByDefaultReadergroupConnectionExist": false,
  "usersToGroupsConnection": UserGroupToManyUsersToGroupFilter,
  "usersToGroupsConnectionExist": true,
  "userByBy": UserFilter,
  "userByByExists": false,
  "and": [UserGroupFilter],
  "or": [UserGroupFilter],
  "not": UserGroupFilter
}

Types

`UserGroupInput`

An input for mutations affecting UserGroup

Input Field	Description
`id` - `UUID`	User Group unique ID.
`groupName` - `String!`	User Group name.
`description` - `String`	User Group description.
`isSystem` - `Boolean`	Indicates if the User Group is a system group.

Example

{
  "id": UUID,
  "groupName": "xyz789",
  "description": "xyz789",
  "isSystem": true
}

Types

`UserGroupPatch`

Represents an update to a UserGroup. Fields that are set will be updated.

Input Field	Description
`id` - `UUID`	User Group unique ID.
`groupName` - `String`	User Group name.
`description` - `String`	User Group description.
`isSystem` - `Boolean`	Indicates if the User Group is a system group.

Example

{
  "id": UUID,
  "groupName": "xyz789",
  "description": "xyz789",
  "isSystem": true
}

Types

`UserGroupToManyObjectFilter`

A filter to be used against many Object object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ObjectFilter`	Every related `Object` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ObjectFilter`	Some related `Object` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ObjectFilter`	No related `Object` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ObjectFilter,
  "some": ObjectFilter,
  "none": ObjectFilter
}

Types

`UserGroupToManySchemaFilter`

A filter to be used against many Schema object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `SchemaFilter`	Every related `Schema` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `SchemaFilter`	Some related `Schema` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `SchemaFilter`	No related `Schema` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": SchemaFilter,
  "some": SchemaFilter,
  "none": SchemaFilter
}

Types

`UserGroupToManyUserFilter`

A filter to be used against many User object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `UserFilter`	Every related `User` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `UserFilter`	Some related `User` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `UserFilter`	No related `User` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": UserFilter,
  "some": UserFilter,
  "none": UserFilter
}

Types

`UserGroupToManyUsersToGroupFilter`

A filter to be used against many UsersToGroup object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `UsersToGroupFilter`	Every related `UsersToGroup` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `UsersToGroupFilter`	Some related `UsersToGroup` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `UsersToGroupFilter`	No related `UsersToGroup` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": UsersToGroupFilter,
  "some": UsersToGroupFilter,
  "none": UsersToGroupFilter
}

Types

`UserGroupsConnection`

A connection to a list of UserGroup values.

Field Name	Description
`nodes` - `[UserGroup]!`	A list of `UserGroup` objects.
`edges` - `[UserGroupsEdge!]!`	A list of edges which contains the `UserGroup` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `UserGroup` you could get from the connection.

Example

{
  "nodes": [UserGroup],
  "edges": [UserGroupsEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`UserGroupsEdge`

A UserGroup edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `UserGroup`	The `UserGroup` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": UserGroup
}

Types

`UserGroupsOrderBy`

Methods to use when ordering UserGroup.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`GROUP_NAME_ASC`
`GROUP_NAME_DESC`
`DESCRIPTION_ASC`
`DESCRIPTION_DESC`
`CREATED_AT_ASC`
`CREATED_AT_DESC`
`UPDATED_AT_ASC`
`UPDATED_AT_DESC`
`BY_ASC`
`BY_DESC`
`IS_SYSTEM_ASC`
`IS_SYSTEM_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`UserGroupsSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `UserGroupsSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": UserGroupsSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`UserGroupsSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `UserGroupsSortableField`

Example

{"field": UserGroupsSortableField}

Types

`UserGroupsSortableField`

Sortable concrete fields for the UserGroup type.

Enum Value	Description
`ID`
`GROUP_NAME`
`DESCRIPTION`
`CREATED_AT`
`UPDATED_AT`
`BY`
`IS_SYSTEM`

Types

`UserInput`

An input for mutations affecting User

Field Name	Description
`id` - `UUID`	User unique ID.
`login` - `String!`	User's login name (User name).
`password` - `String!`	User password hash.
`showhidden` - `Boolean`
`enabled` - `Boolean`	Administrative User's status.
`description` - `String`	User description.
`mName` - `String`	User name meta information.
`mExternalId` - `JSON`	User ID in the external system meta information.
`mPhone` - `String`	User phone meta information.
`mEmail` - `String`	User email meta information.
`mPicture` - `UUID`	User picture (Media Object) meta information.
`mIcon` - `UUID`	User icon (Media Object) meta information.
`type` - `UserTypes!`	User type (USER or APP)
`tokenExp` - `BigInt`	Refresh token expiration in days.
`activated` - `Boolean`	Indicates if the User is activated.
`passwordReset` - `Boolean`	Indicates if the User's password reset requested.
`mTags` - `[String]`
`defaultEditorgroup` - `UUID`
`defaultUsergroup` - `UUID`
`defaultReadergroup` - `UUID`
`um` - `Boolean`
`passwordExpireAt` - `Datetime`
`logonStatus` - `String`
`twoFaType` - `TwoFaTypes`

Example

{
  "id": UUID,
  "login": "xyz789",
  "password": "abc123",
  "showhidden": false,
  "enabled": true,
  "description": "abc123",
  "mName": "xyz789",
  "mExternalId": {},
  "mPhone": "abc123",
  "mEmail": "xyz789",
  "mPicture": UUID,
  "mIcon": UUID,
  "type": UserTypes,
  "tokenExp": BigInt,
  "activated": false,
  "passwordReset": true,
  "mTags": ["xyz789"],
  "defaultEditorgroup": UUID,
  "defaultUsergroup": UUID,
  "defaultReadergroup": UUID,
  "um": true,
  "passwordExpireAt": Datetime,
  "logonStatus": "xyz789",
  "twoFaType": TwoFaTypes
}

Types

`UserPatch`

Represents an update to a User. Fields that are set will be updated.

Field Name	Description
`id` - `UUID`	User unique ID.
`login` - `String`	User's login name (User name).
`password` - `String`	User password hash.
`showhidden` - `Boolean`
`enabled` - `Boolean`	Administrative User's status.
`description` - `String`	User description.
`mName` - `String`	User name meta information.
`mExternalId` - `JSON`	User ID in the external system meta information.
`mPhone` - `String`	User phone meta information.
`mEmail` - `String`	User email meta information.
`mPicture` - `UUID`	User picture (Media Object) meta information.
`mIcon` - `UUID`	User icon (Media Object) meta information.
`tokenExp` - `BigInt`	Refresh token expiration in days.
`activated` - `Boolean`	Indicates if the User is activated.
`passwordReset` - `Boolean`	Indicates if the User's password reset requested.
`mTags` - `[String]`
`defaultEditorgroup` - `UUID`
`defaultUsergroup` - `UUID`
`defaultReadergroup` - `UUID`
`um` - `Boolean`
`passwordExpireAt` - `Datetime`
`logonStatus` - `String`
`twoFaType` - `TwoFaTypes`

Example

{
  "id": UUID,
  "login": "xyz789",
  "password": "abc123",
  "showhidden": true,
  "enabled": false,
  "description": "abc123",
  "mName": "xyz789",
  "mExternalId": {},
  "mPhone": "abc123",
  "mEmail": "xyz789",
  "mPicture": UUID,
  "mIcon": UUID,
  "tokenExp": BigInt,
  "activated": false,
  "passwordReset": true,
  "mTags": ["xyz789"],
  "defaultEditorgroup": UUID,
  "defaultUsergroup": UUID,
  "defaultReadergroup": UUID,
  "um": false,
  "passwordExpireAt": Datetime,
  "logonStatus": "abc123",
  "twoFaType": TwoFaTypes
}

Types

`UserProfile`

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`id` - `UUID!`
`userId` - `UUID!`
`objectId` - `UUID!`
`user` - `User`	Reads a single `User` that is related to this `UserProfile`.
`object` - `Object`	Reads a single `Object` that is related to this `UserProfile`.

Example

{
  "nodeId": ID,
  "id": UUID,
  "userId": UUID,
  "objectId": UUID,
  "user": User,
  "object": Object
}

Types

`UserProfileCondition`

A condition to be used against UserProfile object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`userId` - `UUID`	Checks for equality with the object’s `userId` field.
`objectId` - `UUID`	Checks for equality with the object’s `objectId` field.

Example

{
  "id": UUID,
  "userId": UUID,
  "objectId": UUID
}

Types

`UserProfileFilter`

A filter to be used against UserProfile object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`userId` - `UUIDFilter`	Filter by the object’s `userId` field.
`objectId` - `UUIDFilter`	Filter by the object’s `objectId` field.
`user` - `UserFilter`	Filter by the object’s `user` relation.
`object` - `ObjectFilter`	Filter by the object’s `object` relation.
`and` - `[UserProfileFilter!]`	Checks for all expressions in this list.
`or` - `[UserProfileFilter!]`	Checks for any expressions in this list.
`not` - `UserProfileFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "userId": UUIDFilter,
  "objectId": UUIDFilter,
  "user": UserFilter,
  "object": ObjectFilter,
  "and": [UserProfileFilter],
  "or": [UserProfileFilter],
  "not": UserProfileFilter
}

Types

`UserProfilesConnection`

A connection to a list of UserProfile values.

Field Name	Description
`nodes` - `[UserProfile]!`	A list of `UserProfile` objects.
`edges` - `[UserProfilesEdge!]!`	A list of edges which contains the `UserProfile` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `UserProfile` you could get from the connection.

Example

{
  "nodes": [UserProfile],
  "edges": [UserProfilesEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`UserProfilesEdge`

A UserProfile edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `UserProfile`	The `UserProfile` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": UserProfile
}

Types

`UserProfilesOrderBy`

Methods to use when ordering UserProfile.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`USER_ID_ASC`
`USER_ID_DESC`
`OBJECT_ID_ASC`
`OBJECT_ID_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`UserProfilesSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `UserProfilesSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": UserProfilesSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`UserProfilesSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `UserProfilesSortableField`

Example

{"field": UserProfilesSortableField}

Types

`UserProfilesSortableField`

Sortable concrete fields for the UserProfile type.

Enum Value	Description
`ID`
`USER_ID`
`OBJECT_ID`

Types

`UserToManyControlExecutionFilter`

A filter to be used against many ControlExecution object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ControlExecutionFilter`	Every related `ControlExecution` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ControlExecutionFilter`	Some related `ControlExecution` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ControlExecutionFilter`	No related `ControlExecution` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ControlExecutionFilter,
  "some": ControlExecutionFilter,
  "none": ControlExecutionFilter
}

Types

`UserToManyNotificationDeliveryFilter`

A filter to be used against many NotificationDelivery object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `NotificationDeliveryFilter`	Every related `NotificationDelivery` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `NotificationDeliveryFilter`	Some related `NotificationDelivery` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `NotificationDeliveryFilter`	No related `NotificationDelivery` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": NotificationDeliveryFilter,
  "some": NotificationDeliveryFilter,
  "none": NotificationDeliveryFilter
}

Types

`UserToManyNotificationFilter`

A filter to be used against many Notification object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `NotificationFilter`	Every related `Notification` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `NotificationFilter`	Some related `Notification` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `NotificationFilter`	No related `Notification` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": NotificationFilter,
  "some": NotificationFilter,
  "none": NotificationFilter
}

Types

`UserToManyObjectFilter`

A filter to be used against many Object object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ObjectFilter`	Every related `Object` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ObjectFilter`	Some related `Object` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ObjectFilter`	No related `Object` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ObjectFilter,
  "some": ObjectFilter,
  "none": ObjectFilter
}

Types

`UserToManyObjectPropertiesHistoryFilter`

A filter to be used against many ObjectPropertiesHistory object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ObjectPropertiesHistoryFilter`	Every related `ObjectPropertiesHistory` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ObjectPropertiesHistoryFilter`	Some related `ObjectPropertiesHistory` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ObjectPropertiesHistoryFilter`	No related `ObjectPropertiesHistory` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ObjectPropertiesHistoryFilter,
  "some": ObjectPropertiesHistoryFilter,
  "none": ObjectPropertiesHistoryFilter
}

Types

`UserToManyObjectPropertyFilter`

A filter to be used against many ObjectProperty object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `ObjectPropertyFilter`	Every related `ObjectProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `ObjectPropertyFilter`	Some related `ObjectProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `ObjectPropertyFilter`	No related `ObjectProperty` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": ObjectPropertyFilter,
  "some": ObjectPropertyFilter,
  "none": ObjectPropertyFilter
}

Types

`UserToManySchemaControlFilter`

A filter to be used against many SchemaControl object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `SchemaControlFilter`	Every related `SchemaControl` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `SchemaControlFilter`	Some related `SchemaControl` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `SchemaControlFilter`	No related `SchemaControl` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": SchemaControlFilter,
  "some": SchemaControlFilter,
  "none": SchemaControlFilter
}

Types

`UserToManySchemaFilter`

A filter to be used against many Schema object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `SchemaFilter`	Every related `Schema` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `SchemaFilter`	Some related `Schema` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `SchemaFilter`	No related `Schema` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": SchemaFilter,
  "some": SchemaFilter,
  "none": SchemaFilter
}

Types

`UserToManySchemaPropertyFilter`

A filter to be used against many SchemaProperty object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `SchemaPropertyFilter`	Every related `SchemaProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `SchemaPropertyFilter`	Some related `SchemaProperty` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `SchemaPropertyFilter`	No related `SchemaProperty` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": SchemaPropertyFilter,
  "some": SchemaPropertyFilter,
  "none": SchemaPropertyFilter
}

Types

`UserToManyUserGroupFilter`

A filter to be used against many UserGroup object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `UserGroupFilter`	Every related `UserGroup` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `UserGroupFilter`	Some related `UserGroup` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `UserGroupFilter`	No related `UserGroup` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": UserGroupFilter,
  "some": UserGroupFilter,
  "none": UserGroupFilter
}

Types

`UserToManyUserProfileFilter`

A filter to be used against many UserProfile object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `UserProfileFilter`	Every related `UserProfile` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `UserProfileFilter`	Some related `UserProfile` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `UserProfileFilter`	No related `UserProfile` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": UserProfileFilter,
  "some": UserProfileFilter,
  "none": UserProfileFilter
}

Types

`UserToManyUsersToGroupFilter`

A filter to be used against many UsersToGroup object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `UsersToGroupFilter`	Every related `UsersToGroup` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `UsersToGroupFilter`	Some related `UsersToGroup` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `UsersToGroupFilter`	No related `UsersToGroup` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": UsersToGroupFilter,
  "some": UsersToGroupFilter,
  "none": UsersToGroupFilter
}

Types

`UserToManyUsersToObjectFilter`

A filter to be used against many UsersToObject object types. All fields are combined with a logical ‘and.’

Input Field	Description
`every` - `UsersToObjectFilter`	Every related `UsersToObject` matches the filter criteria. All fields are combined with a logical ‘and.’
`some` - `UsersToObjectFilter`	Some related `UsersToObject` matches the filter criteria. All fields are combined with a logical ‘and.’
`none` - `UsersToObjectFilter`	No related `UsersToObject` matches the filter criteria. All fields are combined with a logical ‘and.’

Example

{
  "every": UsersToObjectFilter,
  "some": UsersToObjectFilter,
  "none": UsersToObjectFilter
}

Types

`UserTypes`

Enum Value	Description
`APP`
`USER`

Types

`UserTypesFilter`

A filter to be used against UserTypes fields. All fields are combined with a logical ‘and.’

Input Field	Description
`isNull` - `Boolean`	Is null (if `true` is specified) or is not null (if `false` is specified).
`equalTo` - `UserTypes`	Equal to the specified value.
`notEqualTo` - `UserTypes`	Not equal to the specified value.
`distinctFrom` - `UserTypes`	Not equal to the specified value, treating null like an ordinary value.
`notDistinctFrom` - `UserTypes`	Equal to the specified value, treating null like an ordinary value.
`in` - `[UserTypes!]`	Included in the specified list.
`notIn` - `[UserTypes!]`	Not included in the specified list.
`lessThan` - `UserTypes`	Less than the specified value.
`lessThanOrEqualTo` - `UserTypes`	Less than or equal to the specified value.
`greaterThan` - `UserTypes`	Greater than the specified value.
`greaterThanOrEqualTo` - `UserTypes`	Greater than or equal to the specified value.

Example

{
  "isNull": false,
  "equalTo": UserTypes,
  "notEqualTo": UserTypes,
  "distinctFrom": UserTypes,
  "notDistinctFrom": UserTypes,
  "in": [UserTypes],
  "notIn": [UserTypes],
  "lessThan": UserTypes,
  "lessThanOrEqualTo": UserTypes,
  "greaterThan": UserTypes,
  "greaterThanOrEqualTo": UserTypes
}

Types

`UsersConnection`

A connection to a list of User values.

Field Name	Description
`nodes` - `[User]!`	A list of `User` objects.
`edges` - `[UsersEdge!]!`	A list of edges which contains the `User` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `User` you could get from the connection.

Example

{
  "nodes": [User],
  "edges": [UsersEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`UsersEdge`

A User edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `User`	The `User` at the end of the edge.

Example

{"cursor": Cursor, "node": User}

Types

`UsersOrderBy`

Methods to use when ordering User.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`LOGIN_ASC`
`LOGIN_DESC`
`PASSWORD_ASC`
`PASSWORD_DESC`
`SHOWHIDDEN_ASC`
`SHOWHIDDEN_DESC`
`ENABLED_ASC`
`ENABLED_DESC`
`DESCRIPTION_ASC`
`DESCRIPTION_DESC`
`M_NAME_ASC`
`M_NAME_DESC`
`M_EXTERNAL_ID_ASC`
`M_EXTERNAL_ID_DESC`
`M_PHONE_ASC`
`M_PHONE_DESC`
`M_EMAIL_ASC`
`M_EMAIL_DESC`
`M_PICTURE_ASC`
`M_PICTURE_DESC`
`M_ICON_ASC`
`M_ICON_DESC`
`CREATED_AT_ASC`
`CREATED_AT_DESC`
`UPDATED_AT_ASC`
`UPDATED_AT_DESC`
`BY_ASC`
`BY_DESC`
`TYPE_ASC`
`TYPE_DESC`
`TOKEN_EXP_ASC`
`TOKEN_EXP_DESC`
`ACTIVATED_ASC`
`ACTIVATED_DESC`
`PASSWORD_RESET_ASC`
`PASSWORD_RESET_DESC`
`M_TAGS_ASC`
`M_TAGS_DESC`
`DEFAULT_EDITORGROUP_ASC`
`DEFAULT_EDITORGROUP_DESC`
`DEFAULT_USERGROUP_ASC`
`DEFAULT_USERGROUP_DESC`
`DEFAULT_READERGROUP_ASC`
`DEFAULT_READERGROUP_DESC`
`UM_ASC`
`UM_DESC`
`PASSWORD_EXPIRE_AT_ASC`
`PASSWORD_EXPIRE_AT_DESC`
`LOGON_STATUS_ASC`
`LOGON_STATUS_DESC`
`TWO_FA_TYPE_ASC`
`TWO_FA_TYPE_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`UsersSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `UsersSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": UsersSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`UsersSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `UsersSortableField`

Example

{"field": UsersSortableField}

Types

`UsersSortableField`

Sortable concrete fields for the User type.

Enum Value	Description
`ID`
`LOGIN`
`PASSWORD`
`SHOWHIDDEN`
`ENABLED`
`DESCRIPTION`
`M_NAME`
`M_EXTERNAL_ID`
`M_PHONE`
`M_EMAIL`
`M_PICTURE`
`M_ICON`
`CREATED_AT`
`UPDATED_AT`
`BY`
`TYPE`
`TOKEN_EXP`
`ACTIVATED`
`PASSWORD_RESET`
`M_TAGS`
`DEFAULT_EDITORGROUP`
`DEFAULT_USERGROUP`
`DEFAULT_READERGROUP`
`UM`
`PASSWORD_EXPIRE_AT`
`LOGON_STATUS`
`TWO_FA_TYPE`

Types

`UsersToGroup`

Users and Groups relation.

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`userId` - `UUID!`	User unique ID.
`userGroupId` - `UUID!`	User Group unique ID.
`id` - `UUID!`
`user` - `User`	Reads a single `User` that is related to this `UsersToGroup`.
`userGroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `UsersToGroup`.

Example

{
  "nodeId": ID,
  "userId": UUID,
  "userGroupId": UUID,
  "id": UUID,
  "user": User,
  "userGroup": UserGroup
}

Types

`UsersToGroupCondition`

A condition to be used against UsersToGroup object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`userId` - `UUID`	Checks for equality with the object’s `userId` field.
`userGroupId` - `UUID`	Checks for equality with the object’s `userGroupId` field.
`id` - `UUID`	Checks for equality with the object’s `id` field.

Example

{
  "userId": UUID,
  "userGroupId": UUID,
  "id": UUID
}

Types

`UsersToGroupFilter`

A filter to be used against UsersToGroup object types. All fields are combined with a logical ‘and.’

Input Field	Description
`userId` - `UUIDFilter`	Filter by the object’s `userId` field.
`userGroupId` - `UUIDFilter`	Filter by the object’s `userGroupId` field.
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`user` - `UserFilter`	Filter by the object’s `user` relation.
`userGroup` - `UserGroupFilter`	Filter by the object’s `userGroup` relation.
`and` - `[UsersToGroupFilter!]`	Checks for all expressions in this list.
`or` - `[UsersToGroupFilter!]`	Checks for any expressions in this list.
`not` - `UsersToGroupFilter`	Negates the expression.

Example

{
  "userId": UUIDFilter,
  "userGroupId": UUIDFilter,
  "id": UUIDFilter,
  "user": UserFilter,
  "userGroup": UserGroupFilter,
  "and": [UsersToGroupFilter],
  "or": [UsersToGroupFilter],
  "not": UsersToGroupFilter
}

Types

`UsersToGroupInput`

An input for mutations affecting UsersToGroup

Input Field	Description
`userId` - `UUID!`	User unique ID.
`userGroupId` - `UUID!`	User Group unique ID.
`id` - `UUID`

Example

{
  "userId": UUID,
  "userGroupId": UUID,
  "id": UUID
}

Types

`UsersToGroupPatch`

Represents an update to a UsersToGroup. Fields that are set will be updated.

Input Field	Description
`userId` - `UUID`	User unique ID.
`userGroupId` - `UUID`	User Group unique ID.
`id` - `UUID`

Example

{
  "userId": UUID,
  "userGroupId": UUID,
  "id": UUID
}

Types

`UsersToGroupsConnection`

A connection to a list of UsersToGroup values.

Field Name	Description
`nodes` - `[UsersToGroup]!`	A list of `UsersToGroup` objects.
`edges` - `[UsersToGroupsEdge!]!`	A list of edges which contains the `UsersToGroup` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `UsersToGroup` you could get from the connection.

Example

{
  "nodes": [UsersToGroup],
  "edges": [UsersToGroupsEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`UsersToGroupsEdge`

A UsersToGroup edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `UsersToGroup`	The `UsersToGroup` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": UsersToGroup
}

Types

`UsersToGroupsOrderBy`

Methods to use when ordering UsersToGroup.

Enum Value	Description
`NATURAL`
`USER_ID_ASC`
`USER_ID_DESC`
`USER_GROUP_ID_ASC`
`USER_GROUP_ID_DESC`
`ID_ASC`
`ID_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`UsersToGroupsSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `UsersToGroupsSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": UsersToGroupsSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`UsersToGroupsSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `UsersToGroupsSortableField`

Example

{"field": UsersToGroupsSortableField}

Types

`UsersToGroupsSortableField`

Sortable concrete fields for the UsersToGroup type.

Enum Value	Description
`USER_ID`
`USER_GROUP_ID`
`ID`

Types

`UsersToObject`

Users and Objects relation. Deprecated?

Field Name	Description
`nodeId` - `ID!`	A globally unique identifier. Can be used in various places throughout the system to identify this single value.
`userId` - `UUID!`	User unique ID.
`objectId` - `UUID!`	Object unique ID.
`id` - `UUID!`
`user` - `User`	Reads a single `User` that is related to this `UsersToObject`.
`object` - `Object`	Reads a single `Object` that is related to this `UsersToObject`.

Example

{
  "nodeId": ID,
  "userId": UUID,
  "objectId": UUID,
  "id": UUID,
  "user": User,
  "object": Object
}

Types

`UsersToObjectCondition`

A condition to be used against UsersToObject object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`userId` - `UUID`	Checks for equality with the object’s `userId` field.
`objectId` - `UUID`	Checks for equality with the object’s `objectId` field.
`id` - `UUID`	Checks for equality with the object’s `id` field.

Example

{
  "userId": UUID,
  "objectId": UUID,
  "id": UUID
}

Types

`UsersToObjectFilter`

A filter to be used against UsersToObject object types. All fields are combined with a logical ‘and.’

Input Field	Description
`userId` - `UUIDFilter`	Filter by the object’s `userId` field.
`objectId` - `UUIDFilter`	Filter by the object’s `objectId` field.
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`user` - `UserFilter`	Filter by the object’s `user` relation.
`object` - `ObjectFilter`	Filter by the object’s `object` relation.
`and` - `[UsersToObjectFilter!]`	Checks for all expressions in this list.
`or` - `[UsersToObjectFilter!]`	Checks for any expressions in this list.
`not` - `UsersToObjectFilter`	Negates the expression.

Example

{
  "userId": UUIDFilter,
  "objectId": UUIDFilter,
  "id": UUIDFilter,
  "user": UserFilter,
  "object": ObjectFilter,
  "and": [UsersToObjectFilter],
  "or": [UsersToObjectFilter],
  "not": UsersToObjectFilter
}

Types

`UsersToObjectInput`

An input for mutations affecting UsersToObject

Input Field	Description
`userId` - `UUID!`	User unique ID.
`objectId` - `UUID!`	Object unique ID.
`id` - `UUID`

Example

{
  "userId": UUID,
  "objectId": UUID,
  "id": UUID
}

Types

`UsersToObjectPatch`

Represents an update to a UsersToObject. Fields that are set will be updated.

Input Field	Description
`userId` - `UUID`	User unique ID.
`objectId` - `UUID`	Object unique ID.
`id` - `UUID`

Example

{
  "userId": UUID,
  "objectId": UUID,
  "id": UUID
}

Types

`UsersToObjectsConnection`

A connection to a list of UsersToObject values.

Field Name	Description
`nodes` - `[UsersToObject]!`	A list of `UsersToObject` objects.
`edges` - `[UsersToObjectsEdge!]!`	A list of edges which contains the `UsersToObject` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `UsersToObject` you could get from the connection.

Example

{
  "nodes": [UsersToObject],
  "edges": [UsersToObjectsEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`UsersToObjectsEdge`

A UsersToObject edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `UsersToObject`	The `UsersToObject` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": UsersToObject
}

Types

`UsersToObjectsOrderBy`

Methods to use when ordering UsersToObject.

Enum Value	Description
`NATURAL`
`USER_ID_ASC`
`USER_ID_DESC`
`OBJECT_ID_ASC`
`OBJECT_ID_DESC`
`ID_ASC`
`ID_DESC`
`PRIMARY_KEY_ASC`
`PRIMARY_KEY_DESC`

Types

`UsersToObjectsSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `UsersToObjectsSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": UsersToObjectsSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`UsersToObjectsSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `UsersToObjectsSortableField`

Example

{"field": UsersToObjectsSortableField}

Types

`UsersToObjectsSortableField`

Sortable concrete fields for the UsersToObject type.

Enum Value	Description
`USER_ID`
`OBJECT_ID`
`ID`

Types

`Version`

Field Name	Description
`short` - `String`
`long` - `String`

Example

{"short": "xyz789", "long": "xyz789"}

Types

`ViewSearch`

Field Name	Description
`id` - `UUID`
`name` - `String`
`type` - `String`
`stringId` - `String`

Example

{
  "id": UUID,
  "name": "abc123",
  "type": "xyz789",
  "stringId": "xyz789"
}

Types

`ViewSearchCondition`

A condition to be used against ViewSearch object types. All fields are tested for equality and combined with a logical ‘and.’

Input Field	Description
`id` - `UUID`	Checks for equality with the object’s `id` field.
`name` - `String`	Checks for equality with the object’s `name` field.
`type` - `String`	Checks for equality with the object’s `type` field.
`stringId` - `String`	Checks for equality with the object’s `stringId` field.

Example

{
  "id": UUID,
  "name": "abc123",
  "type": "abc123",
  "stringId": "abc123"
}

Types

`ViewSearchFilter`

A filter to be used against ViewSearch object types. All fields are combined with a logical ‘and.’

Input Field	Description
`id` - `UUIDFilter`	Filter by the object’s `id` field.
`name` - `StringFilter`	Filter by the object’s `name` field.
`type` - `StringFilter`	Filter by the object’s `type` field.
`stringId` - `StringFilter`	Filter by the object’s `stringId` field.
`and` - `[ViewSearchFilter!]`	Checks for all expressions in this list.
`or` - `[ViewSearchFilter!]`	Checks for any expressions in this list.
`not` - `ViewSearchFilter`	Negates the expression.

Example

{
  "id": UUIDFilter,
  "name": StringFilter,
  "type": StringFilter,
  "stringId": StringFilter,
  "and": [ViewSearchFilter],
  "or": [ViewSearchFilter],
  "not": ViewSearchFilter
}

Types

`ViewSearchSort`

Specifies a sort for the Object type - what should we sort by, should it be ascending or descending, and how should we handle nulls?

Input Field	Description
`sortBy` - `ViewSearchSortBy!`
`ascending` - `Boolean!` default = `true`
`nulls` - `SortNulls!` default = `"DEFAULT"`

Example

{
  "sortBy": ViewSearchSortBy,
  "ascending": true,
  "nulls": "DEFAULT"
}

Types

`ViewSearchSortBy`

The specifier of what we should sort by. Exactly one of these values must be specified and non-null (this will use @oneOf when that feature is merged into GraphQL).

Input Field	Description
`field` - `ViewSearchSortableField`

Example

{"field": ViewSearchSortableField}

Types

`ViewSearchSortableField`

Sortable concrete fields for the ViewSearch type.

Enum Value	Description
`ID`
`NAME`
`TYPE`
`STRING_ID`

Types

`ViewSearchesConnection`

A connection to a list of ViewSearch values.

Field Name	Description
`nodes` - `[ViewSearch]!`	A list of `ViewSearch` objects.
`edges` - `[ViewSearchesEdge!]!`	A list of edges which contains the `ViewSearch` and cursor to aid in pagination.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The count of all `ViewSearch` you could get from the connection.

Example

{
  "nodes": [ViewSearch],
  "edges": [ViewSearchesEdge],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Types

`ViewSearchesEdge`

A ViewSearch edge in the connection.

Field Name	Description
`cursor` - `Cursor`	A cursor for use in pagination.
`node` - `ViewSearch`	The `ViewSearch` at the end of the edge.

Example

{
  "cursor": Cursor,
  "node": ViewSearch
}

Types

`ViewSearchesOrderBy`

Methods to use when ordering ViewSearch.

Enum Value	Description
`NATURAL`
`ID_ASC`
`ID_DESC`
`NAME_ASC`
`NAME_DESC`
`TYPE_ASC`
`TYPE_DESC`
`STRING_ID_ASC`
`STRING_ID_DESC`

Types

`mnCreateObjectInput`

All input for the create mnObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`mnObject` - `[ObjectInput!]`	The one or many `Object` to be created by this mutation.

Example

{"clientMutationId": "abc123", "mnObject": [ObjectInput]}

Types

`mnCreateObjectPayload`

The output of our many create Object mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`object` - `Object`	The `Object` that was created by this mutation.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userByBy` - `User`	Reads a single `User` that is related to this `Object`.
`schema` - `Schema`	Reads a single `Schema` that is related to this `Object`.
`objectEdge` - `ObjectsEdge`	An edge for our `Object`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`.

Example

{
  "clientMutationId": "abc123",
  "object": Object,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "schema": Schema,
  "objectEdge": ObjectsEdge
}

Types

`mnCreateSchemaInput`

All input for the create mnSchema mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`mnSchema` - `[SchemaInput!]`	The one or many `Schema` to be created by this mutation.

Example

{"clientMutationId": "abc123", "mnSchema": [SchemaInput]}

Types

`mnCreateSchemaPayload`

The output of our many create Schema mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schema` - `Schema`	The `Schema` that was created by this mutation.
`userByApplicationOwner` - `User`	Reads a single `User` that is related to this `Schema`.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userByBy` - `User`	Reads a single `User` that is related to this `Schema`.
`parentSchema` - `Schema`	Reads a single `Schema` that is related to this `Schema`.
`schemaEdge` - `SchemataEdge`	An edge for our `Schema`. May be used by Relay 1.
Arguments `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`.

Example

{
  "clientMutationId": "xyz789",
  "schema": Schema,
  "userByApplicationOwner": User,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "parentSchema": Schema,
  "schemaEdge": SchemataEdge
}

Types

`mnCreateUserInput`

All input for the create mnUser mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`mnUser` - `[UserInput!]`	The one or many `User` to be created by this mutation.

Example

{"clientMutationId": "xyz789", "mnUser": [UserInput]}

Types

`mnCreateUserPayload`

The output of our many create User mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`user` - `User`	The `User` that was created by this mutation.
`userGroupByDefaultEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userEdge` - `UsersEdge`	An edge for our `User`. May be used by Relay 1.
Arguments `orderBy` - `[UsersOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `User`.

Example

{
  "clientMutationId": "abc123",
  "user": User,
  "userGroupByDefaultEditorgroup": UserGroup,
  "userGroupByDefaultUsergroup": UserGroup,
  "userGroupByDefaultReadergroup": UserGroup,
  "userEdge": UsersEdge
}

Types

`mnDeleteObjectInput`

All input for the delete mnDeleteObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`mnPatch` - `[ObjectPatch!]`	The one or many `Object` to be deleted. You must provide the PK values!

Example

{"clientMutationId": "xyz789", "mnPatch": [ObjectPatch]}

Types

`mnDeleteObjectPayload`

The output of our delete mn Object mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`object` - `Object`	The `Object` that was deleted by this mutation.
`deletedObjectNodeId` - `ID`
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userByBy` - `User`	Reads a single `User` that is related to this `Object`.
`schema` - `Schema`	Reads a single `Schema` that is related to this `Object`.
`objectEdge` - `ObjectsEdge`	An edge for our `Object`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`.

Example

{
  "clientMutationId": "xyz789",
  "object": Object,
  "deletedObjectNodeId": ID,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "schema": Schema,
  "objectEdge": ObjectsEdge
}

Types

`mnDeleteSchemaInput`

All input for the delete mnDeleteSchema mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`mnPatch` - `[SchemaPatch!]`	The one or many `Schema` to be deleted. You must provide the PK values!

Example

{"clientMutationId": "xyz789", "mnPatch": [SchemaPatch]}

Types

`mnDeleteSchemaPayload`

The output of our delete mn Schema mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schema` - `Schema`	The `Schema` that was deleted by this mutation.
`deletedSchemaNodeId` - `ID`
`userByApplicationOwner` - `User`	Reads a single `User` that is related to this `Schema`.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userByBy` - `User`	Reads a single `User` that is related to this `Schema`.
`parentSchema` - `Schema`	Reads a single `Schema` that is related to this `Schema`.
`schemaEdge` - `SchemataEdge`	An edge for our `Schema`. May be used by Relay 1.
Arguments `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`.

Example

{
  "clientMutationId": "abc123",
  "schema": Schema,
  "deletedSchemaNodeId": ID,
  "userByApplicationOwner": User,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "parentSchema": Schema,
  "schemaEdge": SchemataEdge
}

Types

`mnDeleteUserInput`

All input for the delete mnDeleteUser mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`mnPatch` - `[UserPatch!]`	The one or many `User` to be deleted. You must provide the PK values!

Example

{"clientMutationId": "xyz789", "mnPatch": [UserPatch]}

Types

`mnDeleteUserPayload`

The output of our delete mn User mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`user` - `User`	The `User` that was deleted by this mutation.
`deletedUserNodeId` - `ID`
`userGroupByDefaultEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userEdge` - `UsersEdge`	An edge for our `User`. May be used by Relay 1.
Arguments `orderBy` - `[UsersOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `User`.

Example

{
  "clientMutationId": "abc123",
  "user": User,
  "deletedUserNodeId": ID,
  "userGroupByDefaultEditorgroup": UserGroup,
  "userGroupByDefaultUsergroup": UserGroup,
  "userGroupByDefaultReadergroup": UserGroup,
  "userEdge": UsersEdge
}

Types

`mnUpdateObjectInput`

All input for the update mnUpdateObject mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`mnPatch` - `[ObjectPatch!]`	The one or many `Object` to be updated.

Example

{"clientMutationId": "xyz789", "mnPatch": [ObjectPatch]}

Types

`mnUpdateObjectPayload`

The output of our update mn Object mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`object` - `Object`	The `Object` that was updated by this mutation.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Object`.
`userByBy` - `User`	Reads a single `User` that is related to this `Object`.
`schema` - `Schema`	Reads a single `Schema` that is related to this `Object`.
`objectEdge` - `ObjectsEdge`	An edge for our `Object`. May be used by Relay 1.
Arguments `orderBy` - `[ObjectsOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Object`.

Example

{
  "clientMutationId": "xyz789",
  "object": Object,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "schema": Schema,
  "objectEdge": ObjectsEdge
}

Types

`mnUpdateSchemaInput`

All input for the update mnUpdateSchema mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`mnPatch` - `[SchemaPatch!]`	The one or many `Schema` to be updated.

Example

{"clientMutationId": "xyz789", "mnPatch": [SchemaPatch]}

Types

`mnUpdateSchemaPayload`

The output of our update mn Schema mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`schema` - `Schema`	The `Schema` that was updated by this mutation.
`userByApplicationOwner` - `User`	Reads a single `User` that is related to this `Schema`.
`userGroupByEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userGroupByReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `Schema`.
`userByBy` - `User`	Reads a single `User` that is related to this `Schema`.
`parentSchema` - `Schema`	Reads a single `Schema` that is related to this `Schema`.
`schemaEdge` - `SchemataEdge`	An edge for our `Schema`. May be used by Relay 1.
Arguments `orderBy` - `[SchemataOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `Schema`.

Example

{
  "clientMutationId": "abc123",
  "schema": Schema,
  "userByApplicationOwner": User,
  "userGroupByEditorgroup": UserGroup,
  "userGroupByUsergroup": UserGroup,
  "userGroupByReadergroup": UserGroup,
  "userByBy": User,
  "parentSchema": Schema,
  "schemaEdge": SchemataEdge
}

Types

`mnUpdateUserInput`

All input for the update mnUpdateUser mutation.

Input Field	Description
`clientMutationId` - `String`	An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
`mnPatch` - `[UserPatch!]`	The one or many `User` to be updated.

Example

{"clientMutationId": "xyz789", "mnPatch": [UserPatch]}

Types

`mnUpdateUserPayload`

The output of our update mn User mutation.

Field Name	Description
`clientMutationId` - `String`	The exact same `clientMutationId` that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.
`user` - `User`	The `User` that was updated by this mutation.
`userGroupByDefaultEditorgroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultUsergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userGroupByDefaultReadergroup` - `UserGroup`	Reads a single `UserGroup` that is related to this `User`.
`userEdge` - `UsersEdge`	An edge for our `User`. May be used by Relay 1.
Arguments `orderBy` - `[UsersOrderBy!]` default = `["PRIMARY_KEY_ASC"]` The method to use when ordering `User`.

Example

{
  "clientMutationId": "abc123",
  "user": User,
  "userGroupByDefaultEditorgroup": UserGroup,
  "userGroupByDefaultUsergroup": UserGroup,
  "userGroupByDefaultReadergroup": UserGroup,
  "userEdge": UsersEdge
}

Documentation by Anvil SpectaQL