Factbird GraphQL API
The Factbird API is a GraphQL API which, unlike REST, is served at the same endpoint and uses a query to request specific fields in a nested JSON structure. The following documentation lists the different queries and mutations that we support including examples of how such data would look like.
To communicate with our API the following headers must be provided:
Accept: application/json
Content-Type: application/json
Authorization: <api-token>
To request an API token, contact our support on the mail listed to the right.
This is the same API that is used by the Factbird application and you may inspect the network requests there to find concrete examples of possible queries and/or mutations. Any HTTP client supporting TLS 1+ may be used to communicate with the API, but may require custom configurations in setups like PowerBI, Alteryx, SAP, etc.
On the left hand side, you may expand the available queries in order to fetch specific information from the system. Mutations are changes you may make to the system, e.g. create a batch, register stop etc.
HTTP GET and -POST requests are used to perform queries and mutations, respectively. For GET requests, variables must be supplied as query parameters and be URL encoded.
A GraphQL request payload takes the following JSON shape:
{
"query": "<GraphQL Query>",
"variables": {
"argument": "value"
}
}
To learn more about GraphQL, see https://graphql.org/.
API Endpoints
https://api.cloud.factbird.comQueries
_entities
Response
Returns [_Entity]!
Arguments
| Name | Description |
|---|---|
representations - [_Any!]!
|
Example
Query
query _entities($representations: [_Any!]!) {
_entities(representations: $representations) {
... on Line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{"representations": [_Any]}
Response
{"data": {"_entities": [Line]}}
_service
Response
Returns a _Service!
Example
Query
query _service {
_service {
sdl
}
}
Response
{"data": {"_service": {"sdl": "xyz789"}}}
actionPlanCategories
Internal use only
Response
Returns [ActionPlanCategory!]!
Example
Query
query ActionPlanCategories {
actionPlanCategories {
id
meta {
name
languageCode
}
color
version
nodeId
}
}
Response
{
"data": {
"actionPlanCategories": [
{
"id": "abc123",
"meta": [ActionPlanCategoryMeta],
"color": "xyz789",
"version": 123,
"nodeId": "xyz789"
}
]
}
}
activities
Internal use only
Response
Returns an ActivityConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
|
before - String
|
|
first - Int
|
|
last - Int
|
|
filter - ActivityFilter
|
|
orderBy - ActivityOrdering
|
Example
Query
query Activities(
$after: String,
$before: String,
$first: Int,
$last: Int,
$filter: ActivityFilter,
$orderBy: ActivityOrdering
) {
activities(
after: $after,
before: $before,
first: $first,
last: $last,
filter: $filter,
orderBy: $orderBy
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...ActivityFragment
}
cursor
}
nodes {
id
status
activityTemplate {
...ActivityTemplateFragment
}
trigger {
...TriggerFragment
}
customFormData {
...CustomFormDataFragment
}
stopRegistration {
...ActivityStopRegistrationFragment
}
createdAt
archivedAt
version
locationId
isPassing
batch {
...BatchFragment
}
line {
...LineFragment
}
}
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 987,
"filter": ActivityFilter,
"orderBy": ActivityOrdering
}
Response
{
"data": {
"activities": {
"pageInfo": PageInfo,
"edges": [ActivityEdge],
"nodes": [Activity]
}
}
}
activity
Internal use only
Response
Returns an Activity!
Arguments
| Name | Description |
|---|---|
id - ActivityId!
|
Example
Query
query Activity($id: ActivityId!) {
activity(id: $id) {
id
status
activityTemplate {
id
title
description
translations {
...ActivityTemplateTranslationFragment
}
customFormId
customFormVersion
triggers {
...TriggerFragment
}
expiresAfterMinutes
locationIds
version
createdAt
deletedAt
versions {
...VersionedActivityTemplatesConnectionFragment
}
customForm {
...CustomFormFragment
}
tags {
...ActivityTagFragment
}
}
trigger {
id
type {
...ActivityTriggerTypeFragment
}
conditions {
...TriggerConditionsFragment
}
}
customFormData {
formId
formVersion
values {
...CustomFieldValueFragment
}
initials
form {
...CustomFormFragment
}
schema
}
stopRegistration {
start
end
comment
initials
stopCause {
...ActivityStopCauseFragment
}
}
createdAt
archivedAt
version
locationId
isPassing
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{"id": ActivityId}
Response
{
"data": {
"activity": {
"id": ActivityId,
"status": "PENDING",
"activityTemplate": ActivityTemplate,
"trigger": Trigger,
"customFormData": CustomFormData,
"stopRegistration": ActivityStopRegistration,
"createdAt": "2007-12-03T10:15:30Z",
"archivedAt": "2007-12-03T10:15:30Z",
"version": 123,
"locationId": NodeId,
"isPassing": false,
"batch": Batch,
"line": Line
}
}
}
activityCountByStatus
Internal use only
Response
Returns a CountByStatus!
Arguments
| Name | Description |
|---|---|
filter - ActivityFilter
|
Example
Query
query ActivityCountByStatus($filter: ActivityFilter) {
activityCountByStatus(filter: $filter) {
passed
failed
pending
skipped
}
}
Variables
{"filter": ActivityFilter}
Response
{
"data": {
"activityCountByStatus": {
"passed": 123,
"failed": 987,
"pending": 123,
"skipped": 987
}
}
}
activityTag
Internal use only
Response
Returns an ActivityTag!
Arguments
| Name | Description |
|---|---|
id - ActivityTagId!
|
Example
Query
query ActivityTag($id: ActivityTagId!) {
activityTag(id: $id) {
id
name
createdAt
modifiedAt
deletedAt
templateCount
}
}
Variables
{"id": ActivityTagId}
Response
{
"data": {
"activityTag": {
"id": ActivityTagId,
"name": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"modifiedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"templateCount": 987
}
}
}
activityTags
Internal use only
Response
Returns [ActivityTag!]!
Example
Query
query ActivityTags {
activityTags {
id
name
createdAt
modifiedAt
deletedAt
templateCount
}
}
Response
{
"data": {
"activityTags": [
{
"id": ActivityTagId,
"name": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"modifiedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"templateCount": 987
}
]
}
}
activityTemplate
Internal use only
Response
Returns an ActivityTemplate!
Arguments
| Name | Description |
|---|---|
id - ActivityTemplateId!
|
|
version - Int
|
Example
Query
query ActivityTemplate(
$id: ActivityTemplateId!,
$version: Int
) {
activityTemplate(
id: $id,
version: $version
) {
id
title
description
translations {
title
description
languageCode
}
customFormId
customFormVersion
triggers {
id
type {
...ActivityTriggerTypeFragment
}
conditions {
...TriggerConditionsFragment
}
}
expiresAfterMinutes
locationIds
version
createdAt
deletedAt
versions {
pageInfo {
...PageInfoFragment
}
edges {
...VersionedActivityTemplateEdgeFragment
}
nodes {
...ActivityTemplateFragment
}
}
customForm {
id
title
description
translations {
...CustomFormTranslationFragment
}
fields {
...CustomFormFieldFragment
}
requireInitials
version
createdAt
deletedAt
versions {
...VersionedCustomFormsConnectionFragment
}
}
tags {
id
name
createdAt
modifiedAt
deletedAt
templateCount
}
}
}
Variables
{"id": ActivityTemplateId, "version": 987}
Response
{
"data": {
"activityTemplate": {
"id": ActivityTemplateId,
"title": "xyz789",
"description": "abc123",
"translations": [ActivityTemplateTranslation],
"customFormId": CustomFormId,
"customFormVersion": 987,
"triggers": [Trigger],
"expiresAfterMinutes": 123,
"locationIds": [NodeId],
"version": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedActivityTemplatesConnection,
"customForm": CustomForm,
"tags": [ActivityTag]
}
}
}
activityTemplateCount
Internal use only
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filter - ActivityTemplateFilter
|
Example
Query
query ActivityTemplateCount($filter: ActivityTemplateFilter) {
activityTemplateCount(filter: $filter)
}
Variables
{"filter": ActivityTemplateFilter}
Response
{"data": {"activityTemplateCount": 987}}
activityTemplates
Internal use only
Response
Returns an ActivityTemplateConnection!
Arguments
| Name | Description |
|---|---|
filter - ActivityTemplateFilter
|
|
after - String
|
|
before - String
|
|
first - Int
|
|
last - Int
|
Example
Query
query ActivityTemplates(
$filter: ActivityTemplateFilter,
$after: String,
$before: String,
$first: Int,
$last: Int
) {
activityTemplates(
filter: $filter,
after: $after,
before: $before,
first: $first,
last: $last
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...ActivityTemplateFragment
}
cursor
}
nodes {
id
title
description
translations {
...ActivityTemplateTranslationFragment
}
customFormId
customFormVersion
triggers {
...TriggerFragment
}
expiresAfterMinutes
locationIds
version
createdAt
deletedAt
versions {
...VersionedActivityTemplatesConnectionFragment
}
customForm {
...CustomFormFragment
}
tags {
...ActivityTagFragment
}
}
}
}
Variables
{
"filter": ActivityTemplateFilter,
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 987
}
Response
{
"data": {
"activityTemplates": {
"pageInfo": PageInfo,
"edges": [ActivityTemplateEdge],
"nodes": [ActivityTemplate]
}
}
}
andon
Description
Andon is the operator-technician communication maintenance module of Factbird. See the Andon type for more details.
Example
Query
query Andon($companyId: [ID!]) {
andon(companyId: $companyId) {
calls {
id
urgency
requestedSupport
role {
...AndonRoleFragment
}
tags {
...TagFragment
}
lineId
workOrder {
...WorkOrderFragment
}
action {
...ActionMapFragment
}
lastMessage
line {
...LineFragment
}
}
companyId
extensions {
type
service
}
schedule {
events {
...MaintenanceEventFragment
}
}
tags {
id
lineId
value
}
supportTypes {
id
name
}
workOrderKeys {
tagId
key
}
workers {
id
name
email
phoneNumber
userSub
role {
...AndonRoleFragment
}
roles {
...AndonRoleFragment
}
preferredSchedules {
...AndonScheduleFragment
}
}
roles {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
schedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
_schedule {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
}
}
Variables
{"companyId": [4]}
Response
{
"data": {
"andon": [
{
"calls": [Call],
"companyId": 4,
"extensions": [Extension],
"schedule": MaintenanceSchedule,
"tags": [Tag],
"supportTypes": [SupportType],
"workOrderKeys": [WorkOrderKey],
"workers": [Worker],
"roles": [AndonRole],
"schedules": [AndonSchedule],
"_schedule": AndonSchedule
}
]
}
}
apiTokens
Description
Lists API tokens issued for the whole company if permitted to do so.
Response
Returns [APIToken!]!
Arguments
| Name | Description |
|---|---|
userSub - ID
|
Example
Query
query ApiTokens($userSub: ID) {
apiTokens(userSub: $userSub) {
name
description
generatedAt
expiration
isActive
userSub
}
}
Variables
{"userSub": 4}
Response
{
"data": {
"apiTokens": [
{
"name": "abc123",
"description": "abc123",
"generatedAt": "2007-12-03",
"expiration": 987.65,
"isActive": true,
"userSub": 4
}
]
}
}
assistantConversation
Internal use only
Response
Returns an AssistantConversation!
Arguments
| Name | Description |
|---|---|
conversationId - UUID!
|
Example
Query
query AssistantConversation($conversationId: UUID!) {
assistantConversation(conversationId: $conversationId) {
id
messages {
role
messageId
status
content {
... on ConversationContentText {
...ConversationContentTextFragment
}
... on ConversationContentVisualizationOptions {
...ConversationContentVisualizationOptionsFragment
}
}
}
}
}
Variables
{
"conversationId": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
Response
{
"data": {
"assistantConversation": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"messages": [ConversationMessage]
}
}
}
bestPendingGoldenBatch
Internal use only
Description
Get the pending golden batch with the highest score for a product on a line.
Response
Returns a GoldenBatch
Example
Query
query BestPendingGoldenBatch(
$lineId: ID!,
$productId: ID!
) {
bestPendingGoldenBatch(
lineId: $lineId,
productId: $productId
) {
batchId
lineId
productId
oee1
state
acceptedAt
}
}
Variables
{
"lineId": "4",
"productId": "4"
}
Response
{
"data": {
"bestPendingGoldenBatch": {
"batchId": "4",
"lineId": "4",
"productId": "4",
"oee1": 123.45,
"state": "xyz789",
"acceptedAt": "2007-12-03T10:15:30Z"
}
}
}
claims
Response
Returns a Claims!
Example
Query
query Claims {
claims {
index {
name
id
}
resources {
key
claims
}
}
}
Response
{
"data": {
"claims": {
"index": [Claim],
"resources": [Resource]
}
}
}
companies
Response
Returns [Company!]!
Example
Query
query Companies {
companies {
id
name
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
roles {
id
name
type
permissions {
...PermissionFragment
}
}
users {
pagination {
...TokenFragment
}
items {
...UserFragment
}
}
group {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
appClients {
id
name
groups {
...GroupFragment
}
}
trialStatus {
trialStart
trialEnd
}
}
}
Response
{
"data": {
"companies": [
{
"id": 4,
"name": "xyz789",
"groups": [Group],
"roles": [Role],
"users": UserList,
"group": Group,
"appClients": [AppClient],
"trialStatus": TrialStatus
}
]
}
}
company
Response
Returns a Company!
Example
Query
query Company {
company {
id
name
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
roles {
id
name
type
permissions {
...PermissionFragment
}
}
users {
pagination {
...TokenFragment
}
items {
...UserFragment
}
}
group {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
appClients {
id
name
groups {
...GroupFragment
}
}
trialStatus {
trialStart
trialEnd
}
}
}
Response
{
"data": {
"company": {
"id": 4,
"name": "abc123",
"groups": [Group],
"roles": [Role],
"users": UserList,
"group": Group,
"appClients": [AppClient],
"trialStatus": TrialStatus
}
}
}
consolidatedData
Description
Get consolidated/aggregated data and statistics for a list of lines, over a period of time.
Response
Returns a ConsolidatedData!
Example
Query
query ConsolidatedData(
$lineIds: [ID!],
$time: Time!
) {
consolidatedData(
lineIds: $lineIds,
time: $time
) {
timeRange {
from
to
}
oee {
oee1
oee2
oee3
tcu
totalEquipmentTime
mannedTime
operatingTime
productionTime
valuedOperatingTime
scrapLoss
speedLoss
oee1MaxProduced
oee2MaxProduced
oee3MaxProduced
tcuMaxProduced
}
stopsData {
lineId
lineName
stopStats {
...StopStatsFragment
}
}
}
}
Variables
{
"lineIds": ["4"],
"time": Time
}
Response
{
"data": {
"consolidatedData": {
"timeRange": TimeRange,
"oee": OEE,
"stopsData": [LineStopStats]
}
}
}
controlReceipts
Response
Returns a ControlReceiptList!
Arguments
| Name | Description |
|---|---|
userPoolId - ID
|
|
filter - ControlReceiptFilter
|
|
maxItems - Int
|
|
paginationToken - ID
|
Example
Query
query ControlReceipts(
$userPoolId: ID,
$filter: ControlReceiptFilter,
$maxItems: Int,
$paginationToken: ID
) {
controlReceipts(
userPoolId: $userPoolId,
filter: $filter,
maxItems: $maxItems,
paginationToken: $paginationToken
) {
nextToken
items {
controlReceiptId
userPoolId
name
description
entries {
...ControlReceiptEntryFragment
}
deleted
attachedProducts {
...ProductFragment
}
}
}
}
Variables
{
"userPoolId": 4,
"filter": ControlReceiptFilter,
"maxItems": 987,
"paginationToken": 4
}
Response
{
"data": {
"controlReceipts": {
"nextToken": "4",
"items": [ControlReceipt]
}
}
}
customForm
Internal use only
Response
Returns a CustomForm!
Arguments
| Name | Description |
|---|---|
id - CustomFormId!
|
|
version - Int
|
The version of the form to fetch. If not provided, the current version is fetched. |
Example
Query
query CustomForm(
$id: CustomFormId!,
$version: Int
) {
customForm(
id: $id,
version: $version
) {
id
title
description
translations {
title
description
languageCode
}
fields {
id
name
description
translations {
...CustomFormFieldTranslationFragment
}
fieldOptions {
...CustomFormFieldOptionsFragment
}
}
requireInitials
version
createdAt
deletedAt
versions {
pageInfo {
...PageInfoFragment
}
edges {
...VersionedCustomFormEdgeFragment
}
nodes {
...CustomFormFragment
}
}
}
}
Variables
{"id": CustomFormId, "version": 123}
Response
{
"data": {
"customForm": {
"id": CustomFormId,
"title": "abc123",
"description": "abc123",
"translations": [CustomFormTranslation],
"fields": [CustomFormField],
"requireInitials": false,
"version": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedCustomFormsConnection
}
}
}
customForms
Internal use only
Response
Returns a CustomFormConnection!
Example
Query
query CustomForms(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
customForms(
after: $after,
before: $before,
first: $first,
last: $last
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...CustomFormFragment
}
cursor
}
nodes {
id
title
description
translations {
...CustomFormTranslationFragment
}
fields {
...CustomFormFieldFragment
}
requireInitials
version
createdAt
deletedAt
versions {
...VersionedCustomFormsConnectionFragment
}
}
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 987,
"last": 123
}
Response
{
"data": {
"customForms": {
"pageInfo": PageInfo,
"edges": [CustomFormEdge],
"nodes": [CustomForm]
}
}
}
device
Description
Access a device by identifier.
`uuid' is deprecated and used to represent the allocated software identifier.
`id' refers to the hardware identifier of the device.
Example
Query
query Device(
$uuid: ID,
$id: ID
) {
device(
uuid: $uuid,
id: $id
) {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
firmwareVersions {
...FirmwareVersionsFragment
}
hardwareVersion
}
network {
wifi {
...WiFiConfigShadowFragment
}
connection
general {
...GeneralNetworkShadowSettingsFragment
}
}
sensors {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
sensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripherals {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralPhysicalInput {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralPhysicalInputs {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
pendingJobExecutions {
thingName
jobId
executionNumber
lastUpdatedAt
queuedAt
retryAttempt
startedAt
status
describeJobExecution {
...DescribeJobExecutionFragment
}
}
updateAvailable
certificates {
id
isActive
createdAt
validAt
expiresAt
subject
issuer
}
}
}
Variables
{"uuid": "4", "id": 4}
Response
{
"data": {
"device": {
"_id": 4,
"uuid": "4",
"owner": "4",
"type": "xyz789",
"hardwareId": 4,
"name": "abc123",
"numInputPorts": 123,
"status": DeviceStatus,
"network": NetworkConfig,
"sensors": [Sensor],
"sensor": Sensor,
"peripheral": Peripheral,
"peripherals": [Peripheral],
"peripheralPhysicalInput": Peripheral,
"peripheralPhysicalInputs": [Peripheral],
"pendingJobExecutions": [JobExecutionSummary],
"updateAvailable": false,
"certificates": [Certificate]
}
}
}
devices
Response
Returns [Device!]!
Arguments
| Name | Description |
|---|---|
uuids - [ID!]
|
Example
Query
query Devices($uuids: [ID!]) {
devices(uuids: $uuids) {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
firmwareVersions {
...FirmwareVersionsFragment
}
hardwareVersion
}
network {
wifi {
...WiFiConfigShadowFragment
}
connection
general {
...GeneralNetworkShadowSettingsFragment
}
}
sensors {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
sensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripherals {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralPhysicalInput {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralPhysicalInputs {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
pendingJobExecutions {
thingName
jobId
executionNumber
lastUpdatedAt
queuedAt
retryAttempt
startedAt
status
describeJobExecution {
...DescribeJobExecutionFragment
}
}
updateAvailable
certificates {
id
isActive
createdAt
validAt
expiresAt
subject
issuer
}
}
}
Variables
{"uuids": ["4"]}
Response
{
"data": {
"devices": [
{
"_id": 4,
"uuid": 4,
"owner": "4",
"type": "xyz789",
"hardwareId": "4",
"name": "xyz789",
"numInputPorts": 123,
"status": DeviceStatus,
"network": NetworkConfig,
"sensors": [Sensor],
"sensor": Sensor,
"peripheral": Peripheral,
"peripherals": [Peripheral],
"peripheralPhysicalInput": Peripheral,
"peripheralPhysicalInputs": [Peripheral],
"pendingJobExecutions": [JobExecutionSummary],
"updateAvailable": true,
"certificates": [Certificate]
}
]
}
}
devicesPaginated
Internal use only
Response
Returns a DevicesPaginated!
Example
Query
query DevicesPaginated(
$offset: Int!,
$limit: Int!
) {
devicesPaginated(
offset: $offset,
limit: $limit
) {
items {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
nextOffset
total
}
}
Variables
{"offset": 987, "limit": 123}
Response
{
"data": {
"devicesPaginated": {
"items": [Device],
"nextOffset": 123,
"total": 123
}
}
}
escalation
Internal use only
Response
Returns an Escalation!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query Escalation($id: String!) {
escalation(id: $id) {
nodeId
creationDate
createdBySub
assignedToSub
priority
version
plan {
state
title
pdcaState
followUpInterval
followUpState
dueDate
linkedProductionData
version
category {
...ActionPlanCategoryFragment
}
content {
...ActionPlanContentFragment
}
escalations {
...EscalationFragment
}
attachedFiles
tasks {
...ActionPlanTaskFragment
}
id
}
id
assignedTo {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"escalation": {
"nodeId": "xyz789",
"creationDate": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"assignedToSub": "xyz789",
"priority": true,
"version": 123,
"plan": ActionPlan,
"id": "xyz789",
"assignedTo": User,
"createdBy": User,
"node": HierarchyNode
}
}
}
escalationsForNode
Internal use only
Response
Returns an EscalationConnection!
Example
Query
query EscalationsForNode(
$nodeId: String!,
$order: EscalationOrder,
$before: String,
$after: String,
$first: Int,
$last: Int
) {
escalationsForNode(
nodeId: $nodeId,
order: $order,
before: $before,
after: $after,
first: $first,
last: $last
) {
edges {
node {
...EscalationFragment
}
cursor
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
}
}
Variables
{
"nodeId": "abc123",
"order": EscalationOrder,
"before": "xyz789",
"after": "abc123",
"first": 123,
"last": 987
}
Response
{
"data": {
"escalationsForNode": {
"edges": [EscalationEdge],
"pageInfo": PageInfo
}
}
}
features
Use
claims instead Response
Returns a FeatureList!
Example
Query
query Features {
features {
group {
id
feature {
...FeatureValueFragment
}
}
line {
id
feature {
...FeatureValueFragment
}
}
peripheral {
id
feature {
...FeatureValueFragment
}
}
userPool {
id
feature {
...FeatureValueFragment
}
}
}
}
Response
{
"data": {
"features": {
"group": [FeatureItem],
"line": [FeatureItem],
"peripheral": [FeatureItem],
"userPool": [FeatureItem]
}
}
}
getNode
Example
Query
query GetNode(
$treeId: String!,
$nodeId: ID
) {
getNode(
treeId: $treeId,
nodeId: $nodeId
) {
id
breadcrumb {
name
id
}
refId
alarmStatus
children {
id
breadcrumb {
...BreadcrumbFragment
}
refId
alarmStatus
children {
...NodeFragment
}
leafDescendants {
...NodesWithPageTokenFragment
}
line {
...LineFragment
}
peripheral {
...PeripheralFragment
}
}
leafDescendants {
nodes {
...NodeFragment
}
nextPageToken
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
}
}
Variables
{"treeId": "xyz789", "nodeId": 4}
Response
{
"data": {
"getNode": {
"id": "4",
"breadcrumb": [Breadcrumb],
"refId": "4",
"alarmStatus": "Ongoing",
"children": [Node],
"leafDescendants": NodesWithPageToken,
"line": Line,
"peripheral": Peripheral
}
}
}
goldenBatch
Internal use only
Description
Get the current golden batch for a line or for a product on a line.
Response
Returns a GoldenBatch
Example
Query
query GoldenBatch(
$lineId: ID!,
$productId: ID
) {
goldenBatch(
lineId: $lineId,
productId: $productId
) {
batchId
lineId
productId
oee1
state
acceptedAt
}
}
Variables
{"lineId": "4", "productId": 4}
Response
{
"data": {
"goldenBatch": {
"batchId": 4,
"lineId": "4",
"productId": "4",
"oee1": 123.45,
"state": "abc123",
"acceptedAt": "2007-12-03T10:15:30Z"
}
}
}
goldenBatchSettings
Internal use only
Description
Get the golden batch settings for the current user pool.
Response
Returns a GoldenBatchSettings!
Example
Query
query GoldenBatchSettings {
goldenBatchSettings {
timePeriodMonths
}
}
Response
{"data": {"goldenBatchSettings": {"timePeriodMonths": 123}}}
hierarchyNode
Description
Calling this without a node_id will return the root node
Response
Returns a HierarchyNode
Arguments
| Name | Description |
|---|---|
nodeId - NodeId
|
Example
Query
query HierarchyNode($nodeId: NodeId) {
hierarchyNode(nodeId: $nodeId) {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
customForms {
...HierarchyNodeCustomFormAttachmentsFragment
}
}
type
descendants {
pageInfo {
...PageInfoFragment
}
edges {
...HierarchyNodeEdgeFragment
}
nodes {
...HierarchyNodeFragment
}
}
ancestors {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{"nodeId": NodeId}
Response
{
"data": {
"hierarchyNode": {
"id": NodeId,
"version": 987,
"meta": LineNodeMeta,
"attachments": HierarchyNodeAttachments,
"type": "LINE",
"descendants": HierarchyNodeConnection,
"ancestors": [HierarchyNode]
}
}
}
horizontalAnnotations
Response
Returns [HorizontalAnnotation!]!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
Example
Query
query HorizontalAnnotations($peripheralId: ID!) {
horizontalAnnotations(peripheralId: $peripheralId) {
id
label
axisValue
}
}
Variables
{"peripheralId": "4"}
Response
{
"data": {
"horizontalAnnotations": [
{
"id": 4,
"label": "xyz789",
"axisValue": "abc123"
}
]
}
}
learningActivities
Internal use only
Response
Returns a LearningActivityConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
|
before - String
|
|
first - Int
|
|
last - Int
|
|
filter - LearningActivityFilter
|
Example
Query
query LearningActivities(
$after: String,
$before: String,
$first: Int,
$last: Int,
$filter: LearningActivityFilter
) {
learningActivities(
after: $after,
before: $before,
first: $first,
last: $last,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...LearningActivityFragment
}
cursor
}
nodes {
id
version
nodeId
title
description
content
startEndDatesRequired
validityInMonths
createdAt
updatedAt
createdBySub
updatedBySub
node {
...HierarchyNodeFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 987,
"filter": LearningActivityFilter
}
Response
{
"data": {
"learningActivities": {
"pageInfo": PageInfo,
"edges": [LearningActivityEdge],
"nodes": [LearningActivity],
"totalCount": 987
}
}
}
learningActivity
Internal use only
Response
Returns a LearningActivity!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query LearningActivity($id: UUID!) {
learningActivity(id: $id) {
id
version
nodeId
title
description
content
startEndDatesRequired
validityInMonths
createdAt
updatedAt
createdBySub
updatedBySub
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
Response
{
"data": {
"learningActivity": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"version": 987,
"nodeId": "abc123",
"title": "abc123",
"description": "abc123",
"content": "xyz789",
"startEndDatesRequired": true,
"validityInMonths": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"updatedBySub": "abc123",
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
}
}
learningRole
Internal use only
Response
Returns a LearningRole!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query LearningRole($id: UUID!) {
learningRole(id: $id) {
id
title
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
skills {
pageInfo {
...PageInfoFragment
}
edges {
...LearningRoleSkillsEdgeFragment
}
nodes {
...LearningRoleSkillFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
Response
{
"data": {
"learningRole": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"title": "abc123",
"description": "abc123",
"nodeId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "abc123",
"skills": LearningRoleSkillsConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
}
}
learningRoles
Internal use only
Response
Returns a LearningRoleConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
|
before - String
|
|
first - Int
|
|
last - Int
|
|
filter - LearningRoleFilter
|
Example
Query
query LearningRoles(
$after: String,
$before: String,
$first: Int,
$last: Int,
$filter: LearningRoleFilter
) {
learningRoles(
after: $after,
before: $before,
first: $first,
last: $last,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...LearningRoleFragment
}
cursor
}
nodes {
id
title
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
skills {
...LearningRoleSkillsConnectionFragment
}
node {
...HierarchyNodeFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 987,
"last": 123,
"filter": LearningRoleFilter
}
Response
{
"data": {
"learningRoles": {
"pageInfo": PageInfo,
"edges": [LearningRoleEdge],
"nodes": [LearningRole],
"totalCount": 123
}
}
}
line
Description
Get a specific line.
Response
Returns a Line!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
filter - LineFilterInput
|
|
languageCode - String
|
Example
Query
query Line(
$lineId: ID!,
$filter: LineFilterInput,
$languageCode: String
) {
line(
lineId: $lineId,
filter: $filter,
languageCode: $languageCode
) {
id
languageCode
owner
location {
timeZone
}
name
description
mainPeripheralId
nodes {
id
type
peripheralId
sensor {
...SensorFragment
}
}
edges {
from
to
}
settings {
oee {
...LineOEESettingsFragment
}
batch {
...LineBatchSettingsFragment
}
}
goldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
bestPendingGoldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
time {
configs {
...SensorConfigFragment
}
alarmLogs {
...AlarmLogsFragment
}
batches {
...BatchListFragment
}
dataOverrides {
...DataOverrideFragment
}
pendingControls {
...BatchControlListFragment
}
samples {
...SampleFragment
}
scrap {
...SampleFragment
}
shifts {
...ShiftInstanceFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
changeoverStops {
...ChangeoverStopFragment
}
_id
timeRange {
...TimeRangeFragment
}
}
products {
nextToken
items {
...ProductFragment
}
}
packagings {
nextToken
items {
...PackagingFragment
}
}
batches {
count
items {
...BatchFragment
}
nextToken
pages
}
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
schedule {
id
lineId
validFrom {
...ScheduleTimeFragment
}
validTo {
...ScheduleTimeFragment
}
shifts {
...ShiftFragment
}
weeklyTargets {
...TargetsFragment
}
configuration {
...ScheduleConfigurationFragment
}
isExceptionalWeek
isFallbackSchedule
}
mainSensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
andonSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
nextShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
scheduledEnd
previousShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
maintenanceWorkOrders {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceWorkOrderEdgeFragment
}
nodes {
...MaintenanceWorkOrderFragment
}
}
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
}
}
Variables
{
"lineId": 4,
"filter": LineFilterInput,
"languageCode": "xyz789"
}
Response
{
"data": {
"line": {
"id": "4",
"languageCode": "abc123",
"owner": 4,
"location": Location,
"name": "xyz789",
"description": "xyz789",
"mainPeripheralId": 4,
"nodes": [LineNode],
"edges": [LineEdge],
"settings": LineSettings,
"goldenBatch": GoldenBatch,
"bestPendingGoldenBatch": GoldenBatch,
"time": [LineTimeData],
"products": ProductList,
"packagings": PackagingList,
"batches": BatchList,
"batch": Batch,
"schedule": Schedule,
"mainSensor": Sensor,
"scheduledReports": [ScheduledReport],
"andonSchedules": [AndonSchedule],
"nextShift": ShiftInstance,
"scheduledEnd": "2007-12-03",
"previousShift": ShiftInstance,
"maintenanceWorkOrders": MaintenanceWorkOrderConnection,
"groups": [Group]
}
}
}
lineFromPeripheral
Example
Query
query LineFromPeripheral($peripheralId: ID!) {
lineFromPeripheral(peripheralId: $peripheralId) {
id
languageCode
owner
location {
timeZone
}
name
description
mainPeripheralId
nodes {
id
type
peripheralId
sensor {
...SensorFragment
}
}
edges {
from
to
}
settings {
oee {
...LineOEESettingsFragment
}
batch {
...LineBatchSettingsFragment
}
}
goldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
bestPendingGoldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
time {
configs {
...SensorConfigFragment
}
alarmLogs {
...AlarmLogsFragment
}
batches {
...BatchListFragment
}
dataOverrides {
...DataOverrideFragment
}
pendingControls {
...BatchControlListFragment
}
samples {
...SampleFragment
}
scrap {
...SampleFragment
}
shifts {
...ShiftInstanceFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
changeoverStops {
...ChangeoverStopFragment
}
_id
timeRange {
...TimeRangeFragment
}
}
products {
nextToken
items {
...ProductFragment
}
}
packagings {
nextToken
items {
...PackagingFragment
}
}
batches {
count
items {
...BatchFragment
}
nextToken
pages
}
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
schedule {
id
lineId
validFrom {
...ScheduleTimeFragment
}
validTo {
...ScheduleTimeFragment
}
shifts {
...ShiftFragment
}
weeklyTargets {
...TargetsFragment
}
configuration {
...ScheduleConfigurationFragment
}
isExceptionalWeek
isFallbackSchedule
}
mainSensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
andonSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
nextShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
scheduledEnd
previousShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
maintenanceWorkOrders {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceWorkOrderEdgeFragment
}
nodes {
...MaintenanceWorkOrderFragment
}
}
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
}
}
Variables
{"peripheralId": 4}
Response
{
"data": {
"lineFromPeripheral": {
"id": "4",
"languageCode": "abc123",
"owner": "4",
"location": Location,
"name": "xyz789",
"description": "abc123",
"mainPeripheralId": 4,
"nodes": [LineNode],
"edges": [LineEdge],
"settings": LineSettings,
"goldenBatch": GoldenBatch,
"bestPendingGoldenBatch": GoldenBatch,
"time": [LineTimeData],
"products": ProductList,
"packagings": PackagingList,
"batches": BatchList,
"batch": Batch,
"schedule": Schedule,
"mainSensor": Sensor,
"scheduledReports": [ScheduledReport],
"andonSchedules": [AndonSchedule],
"nextShift": ShiftInstance,
"scheduledEnd": "2007-12-03",
"previousShift": ShiftInstance,
"maintenanceWorkOrders": MaintenanceWorkOrderConnection,
"groups": [Group]
}
}
}
lines
Description
Get a list of lines, that the user has access to. Only line filters are functional for this query.
Response
Returns [Line!]!
Arguments
| Name | Description |
|---|---|
companyId - ID
|
|
filter - LineFilterInput
|
|
languageCode - String
|
Example
Query
query Lines(
$companyId: ID,
$filter: LineFilterInput,
$languageCode: String
) {
lines(
companyId: $companyId,
filter: $filter,
languageCode: $languageCode
) {
id
languageCode
owner
location {
timeZone
}
name
description
mainPeripheralId
nodes {
id
type
peripheralId
sensor {
...SensorFragment
}
}
edges {
from
to
}
settings {
oee {
...LineOEESettingsFragment
}
batch {
...LineBatchSettingsFragment
}
}
goldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
bestPendingGoldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
time {
configs {
...SensorConfigFragment
}
alarmLogs {
...AlarmLogsFragment
}
batches {
...BatchListFragment
}
dataOverrides {
...DataOverrideFragment
}
pendingControls {
...BatchControlListFragment
}
samples {
...SampleFragment
}
scrap {
...SampleFragment
}
shifts {
...ShiftInstanceFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
changeoverStops {
...ChangeoverStopFragment
}
_id
timeRange {
...TimeRangeFragment
}
}
products {
nextToken
items {
...ProductFragment
}
}
packagings {
nextToken
items {
...PackagingFragment
}
}
batches {
count
items {
...BatchFragment
}
nextToken
pages
}
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
schedule {
id
lineId
validFrom {
...ScheduleTimeFragment
}
validTo {
...ScheduleTimeFragment
}
shifts {
...ShiftFragment
}
weeklyTargets {
...TargetsFragment
}
configuration {
...ScheduleConfigurationFragment
}
isExceptionalWeek
isFallbackSchedule
}
mainSensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
andonSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
nextShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
scheduledEnd
previousShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
maintenanceWorkOrders {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceWorkOrderEdgeFragment
}
nodes {
...MaintenanceWorkOrderFragment
}
}
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
}
}
Variables
{
"companyId": "4",
"filter": LineFilterInput,
"languageCode": "abc123"
}
Response
{
"data": {
"lines": [
{
"id": "4",
"languageCode": "abc123",
"owner": 4,
"location": Location,
"name": "abc123",
"description": "xyz789",
"mainPeripheralId": "4",
"nodes": [LineNode],
"edges": [LineEdge],
"settings": LineSettings,
"goldenBatch": GoldenBatch,
"bestPendingGoldenBatch": GoldenBatch,
"time": [LineTimeData],
"products": ProductList,
"packagings": PackagingList,
"batches": BatchList,
"batch": Batch,
"schedule": Schedule,
"mainSensor": Sensor,
"scheduledReports": [ScheduledReport],
"andonSchedules": [AndonSchedule],
"nextShift": ShiftInstance,
"scheduledEnd": "2007-12-03",
"previousShift": ShiftInstance,
"maintenanceWorkOrders": MaintenanceWorkOrderConnection,
"groups": [Group]
}
]
}
}
linesPaginated
Internal use only
Description
Get a page of lines. Lines specified as pinned will appear first in the order.
Response
Returns a LinesPaginated!
Example
Query
query LinesPaginated(
$offset: Int!,
$limit: Int!,
$pinnedLineIds: [ID!],
$languageCode: String
) {
linesPaginated(
offset: $offset,
limit: $limit,
pinnedLineIds: $pinnedLineIds,
languageCode: $languageCode
) {
items {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
nextOffset
total
}
}
Variables
{
"offset": 987,
"limit": 123,
"pinnedLineIds": [4],
"languageCode": "abc123"
}
Response
{
"data": {
"linesPaginated": {
"items": [Line],
"nextOffset": 987,
"total": 987
}
}
}
maintenanceLog
Response
Returns a MaintenanceLogEntryConnection!
Arguments
| Name | Description |
|---|---|
before - String
|
|
after - String
|
|
first - Int
|
|
last - Int
|
|
filter - MaintenanceLogFilter
|
Example
Query
query MaintenanceLog(
$before: String,
$after: String,
$first: Int,
$last: Int,
$filter: MaintenanceLogFilter
) {
maintenanceLog(
before: $before,
after: $after,
first: $first,
last: $last,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...MaintenanceLogEntryFragment
}
cursor
}
nodes {
planId
lineId
status
workOrderDueAt
workOrderOverdueAt
timestamp
produced
startFrom
initials
comment
planSnapshot {
...MaintenancePlanSnapshotFragment
}
customData {
...CustomFormDataFragment
}
andonCallId
stopCauseIds
stopCausePeripheralId
assetIds
startOfService
endOfService
startOfStop
endOfStop
version
effectiveDuration
line {
...LineFragment
}
stopCauses {
...StopCauseFragment
}
assets {
...HierarchyNodeFragment
}
}
}
}
Variables
{
"before": "abc123",
"after": "abc123",
"first": 123,
"last": 123,
"filter": MaintenanceLogFilter
}
Response
{
"data": {
"maintenanceLog": {
"pageInfo": PageInfo,
"edges": [MaintenanceLogEntryEdge],
"nodes": [MaintenanceLogEntry]
}
}
}
maintenancePlan
Response
Returns a MaintenancePlan
Arguments
| Name | Description |
|---|---|
planId - MaintenancePlanId!
|
|
lineId - LineId!
|
Example
Query
query MaintenancePlan(
$planId: MaintenancePlanId!,
$lineId: LineId!
) {
maintenancePlan(
planId: $planId,
lineId: $lineId
) {
planId
lineId
title
asset
tagPartNumber
instructions
startFrom
trackBy {
time {
...TrackByTimeFragment
}
production {
...TrackByProductionFragment
}
calendar {
...TrackByCalendarFragment
}
}
repeat
version
role {
id
name
}
log {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceLogEntryEdgeFragment
}
nodes {
...MaintenanceLogEntryFragment
}
}
nextWorkOrder {
plan {
...MaintenancePlanFragment
}
dueAt
overdueAt
produced
latestMaintenance {
...MaintenanceLogEntryFragment
}
peripheral {
...PeripheralFragment
}
line {
...LineFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"planId": MaintenancePlanId,
"lineId": LineId
}
Response
{
"data": {
"maintenancePlan": {
"planId": MaintenancePlanId,
"lineId": LineId,
"title": "abc123",
"asset": "abc123",
"tagPartNumber": "xyz789",
"instructions": "xyz789",
"startFrom": "2007-12-03T10:15:30Z",
"trackBy": TrackByOptions,
"repeat": "YES",
"version": 987,
"role": MaintenanceRole,
"log": MaintenanceLogEntryConnection,
"nextWorkOrder": MaintenanceWorkOrder,
"peripheral": Peripheral,
"line": Line
}
}
}
maintenancePlans
Response
Returns a MaintenancePlanConnection!
Arguments
| Name | Description |
|---|---|
before - String
|
|
after - String
|
|
first - Int
|
|
last - Int
|
|
filter - MaintenancePlanFilter
|
Example
Query
query MaintenancePlans(
$before: String,
$after: String,
$first: Int,
$last: Int,
$filter: MaintenancePlanFilter
) {
maintenancePlans(
before: $before,
after: $after,
first: $first,
last: $last,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...MaintenancePlanFragment
}
cursor
}
nodes {
planId
lineId
title
asset
tagPartNumber
instructions
startFrom
trackBy {
...TrackByOptionsFragment
}
repeat
version
role {
...MaintenanceRoleFragment
}
log {
...MaintenanceLogEntryConnectionFragment
}
nextWorkOrder {
...MaintenanceWorkOrderFragment
}
peripheral {
...PeripheralFragment
}
line {
...LineFragment
}
}
}
}
Variables
{
"before": "xyz789",
"after": "abc123",
"first": 987,
"last": 987,
"filter": MaintenancePlanFilter
}
Response
{
"data": {
"maintenancePlans": {
"pageInfo": PageInfo,
"edges": [MaintenancePlanEdge],
"nodes": [MaintenancePlan]
}
}
}
maintenanceWorkOrders
Description
The work orders are ordered by the overdue_at timestamp
Response
Returns a MaintenanceWorkOrderConnection!
Arguments
| Name | Description |
|---|---|
before - String
|
|
after - String
|
|
first - Int
|
|
last - Int
|
|
filter - MaintenanceFilter
|
Example
Query
query MaintenanceWorkOrders(
$before: String,
$after: String,
$first: Int,
$last: Int,
$filter: MaintenanceFilter
) {
maintenanceWorkOrders(
before: $before,
after: $after,
first: $first,
last: $last,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...MaintenanceWorkOrderFragment
}
cursor
}
nodes {
plan {
...MaintenancePlanFragment
}
dueAt
overdueAt
produced
latestMaintenance {
...MaintenanceLogEntryFragment
}
peripheral {
...PeripheralFragment
}
line {
...LineFragment
}
}
}
}
Variables
{
"before": "xyz789",
"after": "abc123",
"first": 987,
"last": 123,
"filter": MaintenanceFilter
}
Response
{
"data": {
"maintenanceWorkOrders": {
"pageInfo": PageInfo,
"edges": [MaintenanceWorkOrderEdge],
"nodes": [MaintenanceWorkOrder]
}
}
}
pendingActivities
Internal use only
Description
Returns only pending activities ordered by relative importance.
Response
Returns [Activity!]!
Arguments
| Name | Description |
|---|---|
first - Int
|
|
filter - PendingActivityFilter
|
Example
Query
query PendingActivities(
$first: Int,
$filter: PendingActivityFilter
) {
pendingActivities(
first: $first,
filter: $filter
) {
id
status
activityTemplate {
id
title
description
translations {
...ActivityTemplateTranslationFragment
}
customFormId
customFormVersion
triggers {
...TriggerFragment
}
expiresAfterMinutes
locationIds
version
createdAt
deletedAt
versions {
...VersionedActivityTemplatesConnectionFragment
}
customForm {
...CustomFormFragment
}
tags {
...ActivityTagFragment
}
}
trigger {
id
type {
...ActivityTriggerTypeFragment
}
conditions {
...TriggerConditionsFragment
}
}
customFormData {
formId
formVersion
values {
...CustomFieldValueFragment
}
initials
form {
...CustomFormFragment
}
schema
}
stopRegistration {
start
end
comment
initials
stopCause {
...ActivityStopCauseFragment
}
}
createdAt
archivedAt
version
locationId
isPassing
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{"first": 123, "filter": PendingActivityFilter}
Response
{
"data": {
"pendingActivities": [
{
"id": ActivityId,
"status": "PENDING",
"activityTemplate": ActivityTemplate,
"trigger": Trigger,
"customFormData": CustomFormData,
"stopRegistration": ActivityStopRegistration,
"createdAt": "2007-12-03T10:15:30Z",
"archivedAt": "2007-12-03T10:15:30Z",
"version": 123,
"locationId": NodeId,
"isPassing": true,
"batch": Batch,
"line": Line
}
]
}
}
pendingControls
Response
Returns a BatchControlList!
Example
Query
query PendingControls(
$lineId: ID!,
$from: Date!,
$to: Date!,
$maxItems: Int,
$paginationToken: ID
) {
pendingControls(
lineId: $lineId,
from: $from,
to: $to,
maxItems: $maxItems,
paginationToken: $paginationToken
) {
nextToken
items {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
...BatchControlFieldValueFragment
}
followUp {
...FollowUpSettingsFragment
}
history {
...BatchControlHistoryFragment
}
initials
initialsSettings
originalControl {
...OriginalControlDetailsFragment
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
...ControlTriggerFragment
}
}
}
}
Variables
{
"lineId": "4",
"from": "2007-12-03",
"to": "2007-12-03",
"maxItems": 123,
"paginationToken": 4
}
Response
{
"data": {
"pendingControls": {
"nextToken": "4",
"items": [BatchControl]
}
}
}
peripheralByID
Use
device(uuid) { peripheral(index) } instead. Response
Returns a Peripheral
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
Example
Query
query PeripheralByID($peripheralId: ID!) {
peripheralByID(peripheralId: $peripheralId) {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
expiration
lastReceived
}
device {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
hardwareDevice {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
}
}
Variables
{"peripheralId": 4}
Response
{
"data": {
"peripheralByID": {
"_id": "4",
"id": "4",
"name": "xyz789",
"index": "4",
"peripheralId": 4,
"owner": "4",
"hardwareId": 4,
"peripheralType": "CAMERA",
"description": "xyz789",
"offlineStatus": OfflineStatus,
"device": Device,
"hardwareDevice": Device
}
}
}
peripheralByIDs
Use
device(uuid) { peripheral(index) } instead. Response
Returns [Peripheral!]!
Arguments
| Name | Description |
|---|---|
peripheralType - PeripheralType
|
|
peripheralIds - [ID!]!
|
Example
Query
query PeripheralByIDs(
$peripheralType: PeripheralType,
$peripheralIds: [ID!]!
) {
peripheralByIDs(
peripheralType: $peripheralType,
peripheralIds: $peripheralIds
) {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
expiration
lastReceived
}
device {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
hardwareDevice {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
}
}
Variables
{
"peripheralType": "CAMERA",
"peripheralIds": ["4"]
}
Response
{
"data": {
"peripheralByIDs": [
{
"_id": "4",
"id": 4,
"name": "abc123",
"index": 4,
"peripheralId": 4,
"owner": "4",
"hardwareId": 4,
"peripheralType": "CAMERA",
"description": "abc123",
"offlineStatus": OfflineStatus,
"device": Device,
"hardwareDevice": Device
}
]
}
}
peripheralEventActionConfiguration
Response
Returns [EventActionConfiguration]!
Arguments
| Name | Description |
|---|---|
peripheralId - ID
|
Example
Query
query PeripheralEventActionConfiguration($peripheralId: ID) {
peripheralEventActionConfiguration(peripheralId: $peripheralId) {
peripheralId
value
actions {
type
lineId
peripheralId
}
}
}
Variables
{"peripheralId": 4}
Response
{
"data": {
"peripheralEventActionConfiguration": [
{
"peripheralId": "4",
"value": "abc123",
"actions": [Actions]
}
]
}
}
peripheralsPaginated
Internal use only
Response
Returns a PeripheralsPaginated!
Example
Query
query PeripheralsPaginated(
$offset: Int!,
$limit: Int!
) {
peripheralsPaginated(
offset: $offset,
limit: $limit
) {
items {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
nextOffset
total
}
}
Variables
{"offset": 987, "limit": 123}
Response
{
"data": {
"peripheralsPaginated": {
"items": [Peripheral],
"nextOffset": 987,
"total": 987
}
}
}
permissionKeys
Response
Returns [Permission!]!
Example
Query
query PermissionKeys {
permissionKeys {
key
type
description
}
}
Response
{
"data": {
"permissionKeys": [
{
"key": "xyz789",
"type": "QUERY",
"description": "xyz789"
}
]
}
}
sessions
Description
Lists sessions issued for the whole company if permitted to do so.
Response
Returns a SessionConnection!
Arguments
| Name | Description |
|---|---|
filterBy - SessionFilter
|
|
orderBy - SessionOrder
|
|
first - Int
|
|
after - String
|
Example
Query
query Sessions(
$filterBy: SessionFilter,
$orderBy: SessionOrder,
$first: Int,
$after: String
) {
sessions(
filterBy: $filterBy,
orderBy: $orderBy,
first: $first,
after: $after
) {
edges {
node {
...SessionFragment
}
cursor
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
}
}
Variables
{
"filterBy": SessionFilter,
"orderBy": SessionOrder,
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"sessions": {
"edges": [SessionEdge],
"pageInfo": PageInfo
}
}
}
skill
Internal use only
Example
Query
query Skill($id: UUID!) {
skill(id: $id) {
id
title
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...SkillLearningActivitiesEdgeFragment
}
nodes {
...SkillLearningActivityFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
Response
{
"data": {
"skill": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"title": "abc123",
"description": "xyz789",
"nodeId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "abc123",
"learningActivities": SkillLearningActivitiesConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
}
}
skills
Internal use only
Response
Returns a SkillConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
|
before - String
|
|
first - Int
|
|
last - Int
|
|
filter - SkillFilter
|
Example
Query
query Skills(
$after: String,
$before: String,
$first: Int,
$last: Int,
$filter: SkillFilter
) {
skills(
after: $after,
before: $before,
first: $first,
last: $last,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...SkillFragment
}
cursor
}
nodes {
id
title
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
learningActivities {
...SkillLearningActivitiesConnectionFragment
}
node {
...HierarchyNodeFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 987,
"last": 123,
"filter": SkillFilter
}
Response
{
"data": {
"skills": {
"pageInfo": PageInfo,
"edges": [SkillEdge],
"nodes": [Skill],
"totalCount": 123
}
}
}
stopCauseMappings
Response
Returns [StopCauseMapping!]!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
Example
Query
query StopCauseMappings($peripheralId: ID!) {
stopCauseMappings(peripheralId: $peripheralId) {
_id
peripheralIdEvent
peripheralIdTarget
value
stopCauseId
buffer
lookForward
lookBack
userPool
split
regPriority
}
}
Variables
{"peripheralId": "4"}
Response
{
"data": {
"stopCauseMappings": [
{
"_id": "4",
"peripheralIdEvent": "abc123",
"peripheralIdTarget": "abc123",
"value": "xyz789",
"stopCauseId": "4",
"buffer": 987,
"lookForward": 123,
"lookBack": 123,
"userPool": "xyz789",
"split": true,
"regPriority": 123
}
]
}
}
thingEndpoints
Response
Returns [ThingEndpoint!]!
Example
Query
query ThingEndpoints {
thingEndpoints {
id
name
domainName
enabled
authenticationType
applicationProtocol
}
}
Response
{
"data": {
"thingEndpoints": [
{
"id": "4",
"name": "abc123",
"domainName": "abc123",
"enabled": true,
"authenticationType": "xyz789",
"applicationProtocol": "xyz789"
}
]
}
}
user
Example
Query
query User($userSub: ID) {
user(userSub: $userSub) {
company {
id
name
groups {
...GroupFragment
}
roles {
...RoleFragment
}
users {
...UserListFragment
}
group {
...GroupFragment
}
appClients {
...AppClientFragment
}
trialStatus {
...TrialStatusFragment
}
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
devices {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
linesPaginated {
items {
...LineFragment
}
nextOffset
total
}
skills {
pageInfo {
...PageInfoFragment
}
edges {
...UserSkillEdgeFragment
}
nodes {
...UserSkillFragment
}
}
learningRoles {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningRoleEdgeFragment
}
nodes {
...UserLearningRoleFragment
}
}
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningActivityEdgeFragment
}
nodes {
...UserLearningActivityFragment
}
}
sessions {
generatedAt
expiresAt
userSub
}
}
}
Variables
{"userSub": "4"}
Response
{
"data": {
"user": {
"company": Company,
"username": "xyz789",
"enabled": true,
"userStatus": "abc123",
"userCreateDate": "2007-12-03",
"userLastModifiedDate": "2007-12-03",
"sub": "xyz789",
"email": "abc123",
"givenName": "abc123",
"familyName": "xyz789",
"emailVerified": "xyz789",
"groups": [Group],
"devices": [Device],
"lines": [Line],
"linesPaginated": LinesPaginated,
"skills": UserSkillConnection,
"learningRoles": UserLearningRoleConnection,
"learningActivities": UserLearningActivityConnection,
"sessions": [Session]
}
}
}
userLearningActivities
Internal use only
Response
Returns a UserLearningActivityConnection!
Example
Query
query UserLearningActivities(
$userId: ID!,
$after: String,
$before: String,
$first: Int,
$last: Int,
$filter: UserLearningActivityFilter
) {
userLearningActivities(
userId: $userId,
after: $after,
before: $before,
first: $first,
last: $last,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...UserLearningActivityFragment
}
cursor
}
nodes {
id
learningActivityId
version
nodeId
title
status
description
content
startEndDatesRequired
validityInMonths
enrolledAt
startedAt
completedAt
exemptedAt
expiresAt
}
}
}
Variables
{
"userId": "4",
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123,
"filter": UserLearningActivityFilter
}
Response
{
"data": {
"userLearningActivities": {
"pageInfo": PageInfo,
"edges": [UserLearningActivityEdge],
"nodes": [UserLearningActivity]
}
}
}
userLearningRole
Internal use only
Response
Returns a UserLearningRole
Example
Query
query UserLearningRole(
$learningRoleId: UUID!,
$userId: ID!
) {
userLearningRole(
learningRoleId: $learningRoleId,
userId: $userId
) {
id
learningRoleId
userId
title
status
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
expiresAt
completedAt
enrolledBySub
skills {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningRoleSkillsEdgeFragment
}
nodes {
...UserLearningRoleSkillFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
user {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
enrolledBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{
"learningRoleId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"userId": 4
}
Response
{
"data": {
"userLearningRole": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"learningRoleId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"userId": "4",
"title": "xyz789",
"status": "ENROLLED",
"description": "xyz789",
"nodeId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"updatedBySub": "abc123",
"expiresAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"enrolledBySub": "xyz789",
"skills": UserLearningRoleSkillsConnection,
"node": HierarchyNode,
"user": User,
"createdBy": User,
"updatedBy": User,
"enrolledBy": User
}
}
}
userLearningRoles
Internal use only
Response
Returns a UserLearningRoleConnection!
Example
Query
query UserLearningRoles(
$after: String,
$before: String,
$first: Int,
$last: Int,
$userId: ID!,
$filter: UserLearningRoleFilter
) {
userLearningRoles(
after: $after,
before: $before,
first: $first,
last: $last,
userId: $userId,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...UserLearningRoleFragment
}
cursor
}
nodes {
id
learningRoleId
userId
title
status
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
expiresAt
completedAt
enrolledBySub
skills {
...UserLearningRoleSkillsConnectionFragment
}
node {
...HierarchyNodeFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
enrolledBy {
...UserFragment
}
}
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 987,
"last": 123,
"userId": "4",
"filter": UserLearningRoleFilter
}
Response
{
"data": {
"userLearningRoles": {
"pageInfo": PageInfo,
"edges": [UserLearningRoleEdge],
"nodes": [UserLearningRole]
}
}
}
userSkill
Internal use only
Example
Query
query UserSkill(
$skillId: UUID!,
$userId: ID!
) {
userSkill(
skillId: $skillId,
userId: $userId
) {
id
skillId
userId
title
status
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
expiresAt
completedAt
enrolledBySub
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...UserSkillLearningActivitiesEdgeFragment
}
nodes {
...UserSkillLearningActivityFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
enrolledBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{
"skillId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"userId": 4
}
Response
{
"data": {
"userSkill": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"skillId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"userId": 4,
"title": "abc123",
"status": "ENROLLED",
"description": "xyz789",
"nodeId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "xyz789",
"expiresAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"enrolledBySub": "xyz789",
"learningActivities": UserSkillLearningActivitiesConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User,
"enrolledBy": User
}
}
}
userSkills
Internal use only
Response
Returns a UserSkillConnection!
Example
Query
query UserSkills(
$after: String,
$before: String,
$first: Int,
$last: Int,
$userId: ID!,
$filter: UserSkillFilter
) {
userSkills(
after: $after,
before: $before,
first: $first,
last: $last,
userId: $userId,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...UserSkillFragment
}
cursor
}
nodes {
id
skillId
userId
title
status
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
expiresAt
completedAt
enrolledBySub
learningActivities {
...UserSkillLearningActivitiesConnectionFragment
}
node {
...HierarchyNodeFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
enrolledBy {
...UserFragment
}
}
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123,
"userId": 4,
"filter": UserSkillFilter
}
Response
{
"data": {
"userSkills": {
"pageInfo": PageInfo,
"edges": [UserSkillEdge],
"nodes": [UserSkill]
}
}
}
verticalAnnotations
Response
Returns [VerticalAnnotation!]!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
timeRange - InputTimeRange!
|
|
tags - [String!]
|
|
input - VerticalAnnotationsInput
|
Example
Query
query VerticalAnnotations(
$peripheralId: ID!,
$timeRange: InputTimeRange!,
$tags: [String!],
$input: VerticalAnnotationsInput
) {
verticalAnnotations(
peripheralId: $peripheralId,
timeRange: $timeRange,
tags: $tags,
input: $input
) {
id
label
timestamp
timestampEnd
tags
}
}
Variables
{
"peripheralId": "4",
"timeRange": InputTimeRange,
"tags": ["abc123"],
"input": VerticalAnnotationsInput
}
Response
{
"data": {
"verticalAnnotations": [
{
"id": 4,
"label": "xyz789",
"timestamp": "2007-12-03",
"timestampEnd": "2007-12-03",
"tags": ["abc123"]
}
]
}
}
webhook
Internal use only
Description
Fetch a single webhook by its ID.
Example
Query
query Webhook($id: UUID!) {
webhook(id: $id) {
id
url
description
headers
triggerType
createdAt
updatedAt
deletedAt
}
}
Variables
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
Response
{
"data": {
"webhook": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"url": "xyz789",
"description": "abc123",
"headers": {},
"triggerType": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z"
}
}
}
webhookExecution
Internal use only
Description
Fetch a single webhook execution by its ID.
Response
Returns a WebhookExecution!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query WebhookExecution($id: UUID!) {
webhookExecution(id: $id) {
id
webhookId
requestUrl
requestHeaders
requestBody
statusCode
responseHeaders
responseBody
responseError
result
ipAddress
redirectChain {
url
statusCode
}
responseTimeMs
requestAt
responseAt
createdAt
attemptCount
}
}
Variables
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
Response
{
"data": {
"webhookExecution": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"webhookId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"requestUrl": "abc123",
"requestHeaders": {},
"requestBody": "xyz789",
"statusCode": 987,
"responseHeaders": {},
"responseBody": "xyz789",
"responseError": "abc123",
"result": "SUCCESS",
"ipAddress": "xyz789",
"redirectChain": [HttpRedirect],
"responseTimeMs": 987,
"requestAt": "2007-12-03T10:15:30Z",
"responseAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"attemptCount": 123
}
}
}
webhookExecutions
Internal use only
Description
Fetch a list of webhook executions with optional filters.
Response
Returns a WebhookExecutionConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
|
before - String
|
|
first - Int
|
|
last - Int
|
|
filter - WebhookExecutionFilter
|
Example
Query
query WebhookExecutions(
$after: String,
$before: String,
$first: Int,
$last: Int,
$filter: WebhookExecutionFilter
) {
webhookExecutions(
after: $after,
before: $before,
first: $first,
last: $last,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...WebhookExecutionFragment
}
cursor
}
nodes {
id
webhookId
requestUrl
requestHeaders
requestBody
statusCode
responseHeaders
responseBody
responseError
result
ipAddress
redirectChain {
...HttpRedirectFragment
}
responseTimeMs
requestAt
responseAt
createdAt
attemptCount
}
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 987,
"last": 987,
"filter": WebhookExecutionFilter
}
Response
{
"data": {
"webhookExecutions": {
"pageInfo": PageInfo,
"edges": [WebhookExecutionEdge],
"nodes": [WebhookExecution]
}
}
}
webhooks
Internal use only
Description
Fetch all webhooks.
Response
Returns a WebhookConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
|
before - String
|
|
first - Int
|
|
last - Int
|
|
filter - WebhookFilter
|
Example
Query
query Webhooks(
$after: String,
$before: String,
$first: Int,
$last: Int,
$filter: WebhookFilter
) {
webhooks(
after: $after,
before: $before,
first: $first,
last: $last,
filter: $filter
) {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
node {
...WebhookFragment
}
cursor
}
nodes {
id
url
description
headers
triggerType
createdAt
updatedAt
deletedAt
}
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 987,
"filter": WebhookFilter
}
Response
{
"data": {
"webhooks": {
"pageInfo": PageInfo,
"edges": [WebhookEdge],
"nodes": [Webhook]
}
}
}
Mutations
acceptPendingGoldenBatch
Internal use only
Description
Accept a pending golden batch as the current golden batch.
actionPlansPreSignedUrlForAttachment
Internal use only
Response
Returns an ActionPlansPreSignedUrlsForAttachment!
Arguments
| Name | Description |
|---|---|
fileName - String!
|
Example
Query
mutation ActionPlansPreSignedUrlForAttachment($fileName: String!) {
actionPlansPreSignedUrlForAttachment(fileName: $fileName) {
upload
download
}
}
Variables
{"fileName": "xyz789"}
Response
{
"data": {
"actionPlansPreSignedUrlForAttachment": {
"upload": "xyz789",
"download": "abc123"
}
}
}
addAppClientToGroups
Example
Query
mutation AddAppClientToGroups(
$id: ID!,
$groupIds: [ID!]!
) {
addAppClientToGroups(
id: $id,
groupIds: $groupIds
) {
id
name
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
}
}
Variables
{"id": "4", "groupIds": [4]}
Response
{
"data": {
"addAppClientToGroups": {
"id": 4,
"name": "xyz789",
"groups": [Group]
}
}
}
addHorizontalAnnotation
Response
Returns a HorizontalAnnotation!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
horizontalAnnotation - HorizontalAnnotationInput!
|
Example
Query
mutation AddHorizontalAnnotation(
$peripheralId: ID!,
$horizontalAnnotation: HorizontalAnnotationInput!
) {
addHorizontalAnnotation(
peripheralId: $peripheralId,
horizontalAnnotation: $horizontalAnnotation
) {
id
label
axisValue
}
}
Variables
{
"peripheralId": "4",
"horizontalAnnotation": HorizontalAnnotationInput
}
Response
{
"data": {
"addHorizontalAnnotation": {
"id": 4,
"label": "abc123",
"axisValue": "xyz789"
}
}
}
addLineToGroups
Response
Returns an ID
Example
Query
mutation AddLineToGroups(
$companyId: ID!,
$lineId: ID!,
$groupIds: [ID!]!,
$peripheralIds: [ID!]
) {
addLineToGroups(
companyId: $companyId,
lineId: $lineId,
groupIds: $groupIds,
peripheralIds: $peripheralIds
)
}
Variables
{
"companyId": 4,
"lineId": 4,
"groupIds": ["4"],
"peripheralIds": [4]
}
Response
{"data": {"addLineToGroups": 4}}
addPeripheralToGroups
Response
Returns an ID
Example
Query
mutation AddPeripheralToGroups(
$companyId: ID!,
$peripheralId: ID!,
$groupIds: [ID!]!
) {
addPeripheralToGroups(
companyId: $companyId,
peripheralId: $peripheralId,
groupIds: $groupIds
)
}
Variables
{
"companyId": "4",
"peripheralId": "4",
"groupIds": [4]
}
Response
{"data": {"addPeripheralToGroups": 4}}
addUserToGroups
Example
Query
mutation AddUserToGroups(
$companyId: ID!,
$userId: ID!,
$groupIds: [ID!]!
) {
addUserToGroups(
companyId: $companyId,
userId: $userId,
groupIds: $groupIds
) {
company {
id
name
groups {
...GroupFragment
}
roles {
...RoleFragment
}
users {
...UserListFragment
}
group {
...GroupFragment
}
appClients {
...AppClientFragment
}
trialStatus {
...TrialStatusFragment
}
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
devices {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
linesPaginated {
items {
...LineFragment
}
nextOffset
total
}
skills {
pageInfo {
...PageInfoFragment
}
edges {
...UserSkillEdgeFragment
}
nodes {
...UserSkillFragment
}
}
learningRoles {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningRoleEdgeFragment
}
nodes {
...UserLearningRoleFragment
}
}
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningActivityEdgeFragment
}
nodes {
...UserLearningActivityFragment
}
}
sessions {
generatedAt
expiresAt
userSub
}
}
}
Variables
{"companyId": 4, "userId": 4, "groupIds": [4]}
Response
{
"data": {
"addUserToGroups": {
"company": Company,
"username": "xyz789",
"enabled": true,
"userStatus": "xyz789",
"userCreateDate": "2007-12-03",
"userLastModifiedDate": "2007-12-03",
"sub": "xyz789",
"email": "xyz789",
"givenName": "xyz789",
"familyName": "abc123",
"emailVerified": "xyz789",
"groups": [Group],
"devices": [Device],
"lines": [Line],
"linesPaginated": LinesPaginated,
"skills": UserSkillConnection,
"learningRoles": UserLearningRoleConnection,
"learningActivities": UserLearningActivityConnection,
"sessions": [Session]
}
}
}
addVerticalAnnotation
Response
Returns a VerticalAnnotation!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
verticalAnnotation - VerticalAnnotationInput!
|
Example
Query
mutation AddVerticalAnnotation(
$peripheralId: ID!,
$verticalAnnotation: VerticalAnnotationInput!
) {
addVerticalAnnotation(
peripheralId: $peripheralId,
verticalAnnotation: $verticalAnnotation
) {
id
label
timestamp
timestampEnd
tags
}
}
Variables
{
"peripheralId": "4",
"verticalAnnotation": VerticalAnnotationInput
}
Response
{
"data": {
"addVerticalAnnotation": {
"id": "4",
"label": "abc123",
"timestamp": "2007-12-03",
"timestampEnd": "2007-12-03",
"tags": ["xyz789"]
}
}
}
andonAttendanceDowngrade
Response
Returns [AndonShift!]!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
scheduleId - ID!
|
|
shiftId - ID!
|
|
input - AttendanceInput!
|
Example
Query
mutation AndonAttendanceDowngrade(
$companyId: ID!,
$scheduleId: ID!,
$shiftId: ID!,
$input: AttendanceInput!
) {
andonAttendanceDowngrade(
companyId: $companyId,
scheduleId: $scheduleId,
shiftId: $shiftId,
input: $input
) {
id
name
duration
rRuleSet
attendees {
id
name
email
phoneNumber
userSub
role {
...AndonRoleFragment
}
roles {
...AndonRoleFragment
}
preferredSchedules {
...AndonScheduleFragment
}
isPermanent
isExcluded
}
description
}
}
Variables
{
"companyId": 4,
"scheduleId": "4",
"shiftId": "4",
"input": AttendanceInput
}
Response
{
"data": {
"andonAttendanceDowngrade": [
{
"id": "4",
"name": "xyz789",
"duration": 123.45,
"rRuleSet": "xyz789",
"attendees": [AttendingWorker],
"description": "xyz789"
}
]
}
}
andonAttendanceUpgrade
Response
Returns [AndonShift!]!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
scheduleId - ID!
|
|
shiftId - ID!
|
|
input - AttendanceInput!
|
Example
Query
mutation AndonAttendanceUpgrade(
$companyId: ID!,
$scheduleId: ID!,
$shiftId: ID!,
$input: AttendanceInput!
) {
andonAttendanceUpgrade(
companyId: $companyId,
scheduleId: $scheduleId,
shiftId: $shiftId,
input: $input
) {
id
name
duration
rRuleSet
attendees {
id
name
email
phoneNumber
userSub
role {
...AndonRoleFragment
}
roles {
...AndonRoleFragment
}
preferredSchedules {
...AndonScheduleFragment
}
isPermanent
isExcluded
}
description
}
}
Variables
{
"companyId": "4",
"scheduleId": "4",
"shiftId": "4",
"input": AttendanceInput
}
Response
{
"data": {
"andonAttendanceUpgrade": [
{
"id": 4,
"name": "xyz789",
"duration": 987.65,
"rRuleSet": "xyz789",
"attendees": [AttendingWorker],
"description": "xyz789"
}
]
}
}
andonCallCancel
andonCallCreate
Response
Returns a Call!
Example
Query
mutation AndonCallCreate(
$companyId: ID!,
$author: String!,
$details: String!,
$lineId: ID!,
$roleId: ID,
$tags: [ID!]!,
$urgency: Urgency!
) {
andonCallCreate(
companyId: $companyId,
author: $author,
details: $details,
lineId: $lineId,
roleId: $roleId,
tags: $tags,
urgency: $urgency
) {
id
urgency
requestedSupport
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
tags {
id
lineId
value
}
lineId
workOrder {
id
}
action {
make {
...ActionFragment
}
take {
...ActionFragment
}
pending {
...ActionFragment
}
resolve {
...ActionFragment
}
}
lastMessage
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"companyId": 4,
"author": "xyz789",
"details": "xyz789",
"lineId": 4,
"roleId": "4",
"tags": ["4"],
"urgency": "MEDIUM"
}
Response
{
"data": {
"andonCallCreate": {
"id": "4",
"urgency": "MEDIUM",
"requestedSupport": "xyz789",
"role": AndonRole,
"tags": [Tag],
"lineId": 4,
"workOrder": WorkOrder,
"action": ActionMap,
"lastMessage": "2007-12-03",
"line": Line
}
}
}
andonCallRelease
Example
Query
mutation AndonCallRelease(
$companyId: ID!,
$id: ID!
) {
andonCallRelease(
companyId: $companyId,
id: $id
) {
id
urgency
requestedSupport
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
tags {
id
lineId
value
}
lineId
workOrder {
id
}
action {
make {
...ActionFragment
}
take {
...ActionFragment
}
pending {
...ActionFragment
}
resolve {
...ActionFragment
}
}
lastMessage
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{"companyId": 4, "id": "4"}
Response
{
"data": {
"andonCallRelease": {
"id": "4",
"urgency": "MEDIUM",
"requestedSupport": "abc123",
"role": AndonRole,
"tags": [Tag],
"lineId": "4",
"workOrder": WorkOrder,
"action": ActionMap,
"lastMessage": "2007-12-03",
"line": Line
}
}
}
andonCallReopen
Example
Query
mutation AndonCallReopen(
$companyId: ID!,
$id: ID!,
$resolutionTime: Date!
) {
andonCallReopen(
companyId: $companyId,
id: $id,
resolutionTime: $resolutionTime
) {
id
urgency
requestedSupport
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
tags {
id
lineId
value
}
lineId
workOrder {
id
}
action {
make {
...ActionFragment
}
take {
...ActionFragment
}
pending {
...ActionFragment
}
resolve {
...ActionFragment
}
}
lastMessage
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"companyId": 4,
"id": 4,
"resolutionTime": "2007-12-03"
}
Response
{
"data": {
"andonCallReopen": {
"id": 4,
"urgency": "MEDIUM",
"requestedSupport": "abc123",
"role": AndonRole,
"tags": [Tag],
"lineId": 4,
"workOrder": WorkOrder,
"action": ActionMap,
"lastMessage": "2007-12-03",
"line": Line
}
}
}
andonCallResolve
Response
Returns a Call!
Example
Query
mutation AndonCallResolve(
$companyId: ID!,
$id: ID!,
$author: String!,
$details: String!
) {
andonCallResolve(
companyId: $companyId,
id: $id,
author: $author,
details: $details
) {
id
urgency
requestedSupport
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
tags {
id
lineId
value
}
lineId
workOrder {
id
}
action {
make {
...ActionFragment
}
take {
...ActionFragment
}
pending {
...ActionFragment
}
resolve {
...ActionFragment
}
}
lastMessage
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"companyId": "4",
"id": 4,
"author": "xyz789",
"details": "abc123"
}
Response
{
"data": {
"andonCallResolve": {
"id": 4,
"urgency": "MEDIUM",
"requestedSupport": "xyz789",
"role": AndonRole,
"tags": [Tag],
"lineId": "4",
"workOrder": WorkOrder,
"action": ActionMap,
"lastMessage": "2007-12-03",
"line": Line
}
}
}
andonCallTake
Example
Query
mutation AndonCallTake(
$companyId: ID!,
$id: ID!,
$author: String
) {
andonCallTake(
companyId: $companyId,
id: $id,
author: $author
) {
id
urgency
requestedSupport
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
tags {
id
lineId
value
}
lineId
workOrder {
id
}
action {
make {
...ActionFragment
}
take {
...ActionFragment
}
pending {
...ActionFragment
}
resolve {
...ActionFragment
}
}
lastMessage
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"companyId": 4,
"id": "4",
"author": "xyz789"
}
Response
{
"data": {
"andonCallTake": {
"id": "4",
"urgency": "MEDIUM",
"requestedSupport": "xyz789",
"role": AndonRole,
"tags": [Tag],
"lineId": "4",
"workOrder": WorkOrder,
"action": ActionMap,
"lastMessage": "2007-12-03",
"line": Line
}
}
}
andonCallUpdateTags
Example
Query
mutation AndonCallUpdateTags(
$companyId: ID!,
$id: ID!,
$tagIds: [ID!]!
) {
andonCallUpdateTags(
companyId: $companyId,
id: $id,
tagIds: $tagIds
) {
id
urgency
requestedSupport
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
tags {
id
lineId
value
}
lineId
workOrder {
id
}
action {
make {
...ActionFragment
}
take {
...ActionFragment
}
pending {
...ActionFragment
}
resolve {
...ActionFragment
}
}
lastMessage
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"companyId": "4",
"id": 4,
"tagIds": ["4"]
}
Response
{
"data": {
"andonCallUpdateTags": {
"id": "4",
"urgency": "MEDIUM",
"requestedSupport": "xyz789",
"role": AndonRole,
"tags": [Tag],
"lineId": 4,
"workOrder": WorkOrder,
"action": ActionMap,
"lastMessage": "2007-12-03",
"line": Line
}
}
}
andonCallUpgrade
Example
Query
mutation AndonCallUpgrade(
$companyId: ID!,
$id: ID!
) {
andonCallUpgrade(
companyId: $companyId,
id: $id
) {
id
urgency
requestedSupport
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
tags {
id
lineId
value
}
lineId
workOrder {
id
}
action {
make {
...ActionFragment
}
take {
...ActionFragment
}
pending {
...ActionFragment
}
resolve {
...ActionFragment
}
}
lastMessage
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{"companyId": 4, "id": 4}
Response
{
"data": {
"andonCallUpgrade": {
"id": 4,
"urgency": "MEDIUM",
"requestedSupport": "abc123",
"role": AndonRole,
"tags": [Tag],
"lineId": "4",
"workOrder": WorkOrder,
"action": ActionMap,
"lastMessage": "2007-12-03",
"line": Line
}
}
}
andonCallWorkOrderInitiate
Response
Returns a Call!
Example
Query
mutation AndonCallWorkOrderInitiate(
$companyId: ID!,
$callId: ID!,
$tagId: ID!,
$author: String!,
$details: String!
) {
andonCallWorkOrderInitiate(
companyId: $companyId,
callId: $callId,
tagId: $tagId,
author: $author,
details: $details
) {
id
urgency
requestedSupport
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
tags {
id
lineId
value
}
lineId
workOrder {
id
}
action {
make {
...ActionFragment
}
take {
...ActionFragment
}
pending {
...ActionFragment
}
resolve {
...ActionFragment
}
}
lastMessage
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"companyId": 4,
"callId": 4,
"tagId": 4,
"author": "abc123",
"details": "xyz789"
}
Response
{
"data": {
"andonCallWorkOrderInitiate": {
"id": "4",
"urgency": "MEDIUM",
"requestedSupport": "xyz789",
"role": AndonRole,
"tags": [Tag],
"lineId": "4",
"workOrder": WorkOrder,
"action": ActionMap,
"lastMessage": "2007-12-03",
"line": Line
}
}
}
andonRoleCreate
Response
Returns an AndonRole!
Arguments
| Name | Description |
|---|---|
companyId - ID
|
|
input - RoleCreateInput!
|
Example
Query
mutation AndonRoleCreate(
$companyId: ID,
$input: RoleCreateInput!
) {
andonRoleCreate(
companyId: $companyId,
input: $input
) {
id
name
escalationConfiguration {
type
delay
takenDelay
}
}
}
Variables
{
"companyId": "4",
"input": RoleCreateInput
}
Response
{
"data": {
"andonRoleCreate": {
"id": "4",
"name": "abc123",
"escalationConfiguration": [EscalationConfiguration]
}
}
}
andonRoleDelete
Response
Returns [AndonRole!]!
Example
Query
mutation AndonRoleDelete(
$companyId: ID!,
$id: ID!
) {
andonRoleDelete(
companyId: $companyId,
id: $id
) {
id
name
escalationConfiguration {
type
delay
takenDelay
}
}
}
Variables
{
"companyId": "4",
"id": "4"
}
Response
{
"data": {
"andonRoleDelete": [
{
"id": 4,
"name": "xyz789",
"escalationConfiguration": [
EscalationConfiguration
]
}
]
}
}
andonRoleUpdate
Response
Returns an AndonRole!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
id - ID!
|
|
input - RoleUpdateInput!
|
Example
Query
mutation AndonRoleUpdate(
$companyId: ID!,
$id: ID!,
$input: RoleUpdateInput!
) {
andonRoleUpdate(
companyId: $companyId,
id: $id,
input: $input
) {
id
name
escalationConfiguration {
type
delay
takenDelay
}
}
}
Variables
{
"companyId": "4",
"id": 4,
"input": RoleUpdateInput
}
Response
{
"data": {
"andonRoleUpdate": {
"id": "4",
"name": "abc123",
"escalationConfiguration": [EscalationConfiguration]
}
}
}
andonScheduleCreate
Response
Returns an AndonSchedule!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
input - ScheduleCreateInput!
|
Example
Query
mutation AndonScheduleCreate(
$companyId: ID!,
$input: ScheduleCreateInput!
) {
andonScheduleCreate(
companyId: $companyId,
input: $input
) {
id
name
lineIds
shifts {
id
name
duration
rRuleSet
attendees {
...AttendingWorkerFragment
}
description
}
shift {
id
name
duration
rRuleSet
attendees {
...AttendingWorkerFragment
}
description
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{"companyId": 4, "input": ScheduleCreateInput}
Response
{
"data": {
"andonScheduleCreate": {
"id": 4,
"name": "abc123",
"lineIds": [4],
"shifts": [AndonShift],
"shift": [AndonShift],
"lines": [Line]
}
}
}
andonScheduleDelete
andonScheduleEventAttend
Response
Returns a MaintenanceEvent!
Example
Query
mutation AndonScheduleEventAttend(
$companyId: ID!,
$eventId: ID!,
$supportId: ID!,
$email: String,
$phoneNumber: String
) {
andonScheduleEventAttend(
companyId: $companyId,
eventId: $eventId,
supportId: $supportId,
email: $email,
phoneNumber: $phoneNumber
) {
id
lineId
summary
description
duration
rRuleSet
attendees {
id
supportId
email
phoneNumber
userSub
dateExceptions
messages {
...MessageFragment
}
}
}
}
Variables
{
"companyId": "4",
"eventId": "4",
"supportId": 4,
"email": "xyz789",
"phoneNumber": "abc123"
}
Response
{
"data": {
"andonScheduleEventAttend": {
"id": "4",
"lineId": 4,
"summary": "xyz789",
"description": "xyz789",
"duration": 123.45,
"rRuleSet": "abc123",
"attendees": [Attendee]
}
}
}
andonScheduleEventAttendeeAddMessage
Response
Returns [Message!]!
Example
Query
mutation AndonScheduleEventAttendeeAddMessage(
$companyId: ID!,
$eventId: ID!,
$attendeeId: ID!,
$type: SubscriptionType,
$delay: Float,
$takenDelay: Float
) {
andonScheduleEventAttendeeAddMessage(
companyId: $companyId,
eventId: $eventId,
attendeeId: $attendeeId,
type: $type,
delay: $delay,
takenDelay: $takenDelay
) {
id
type
delay
takenDelay
}
}
Variables
{
"companyId": "4",
"eventId": 4,
"attendeeId": 4,
"type": "SMS",
"delay": 987.65,
"takenDelay": 987.65
}
Response
{
"data": {
"andonScheduleEventAttendeeAddMessage": [
{
"id": "4",
"type": "SMS",
"delay": 987.65,
"takenDelay": 987.65
}
]
}
}
andonScheduleEventAttendeeDeleteMessage
Response
Returns [Message!]!
Example
Query
mutation AndonScheduleEventAttendeeDeleteMessage(
$id: ID!,
$companyId: ID!,
$eventId: ID!,
$attendeeId: ID!
) {
andonScheduleEventAttendeeDeleteMessage(
id: $id,
companyId: $companyId,
eventId: $eventId,
attendeeId: $attendeeId
) {
id
type
delay
takenDelay
}
}
Variables
{
"id": 4,
"companyId": "4",
"eventId": 4,
"attendeeId": "4"
}
Response
{
"data": {
"andonScheduleEventAttendeeDeleteMessage": [
{"id": 4, "type": "SMS", "delay": 123.45, "takenDelay": 123.45}
]
}
}
andonScheduleEventCreate
Response
Returns a MaintenanceEvent!
Example
Query
mutation AndonScheduleEventCreate(
$companyId: ID!,
$lineId: ID!,
$summary: String!,
$description: String,
$duration: Float!,
$rRuleSet: String!
) {
andonScheduleEventCreate(
companyId: $companyId,
lineId: $lineId,
summary: $summary,
description: $description,
duration: $duration,
rRuleSet: $rRuleSet
) {
id
lineId
summary
description
duration
rRuleSet
attendees {
id
supportId
email
phoneNumber
userSub
dateExceptions
messages {
...MessageFragment
}
}
}
}
Variables
{
"companyId": 4,
"lineId": 4,
"summary": "abc123",
"description": "abc123",
"duration": 987.65,
"rRuleSet": "xyz789"
}
Response
{
"data": {
"andonScheduleEventCreate": {
"id": 4,
"lineId": "4",
"summary": "abc123",
"description": "abc123",
"duration": 123.45,
"rRuleSet": "xyz789",
"attendees": [Attendee]
}
}
}
andonScheduleEventDelete
Example
Query
mutation AndonScheduleEventDelete(
$companyId: ID!,
$id: ID!
) {
andonScheduleEventDelete(
companyId: $companyId,
id: $id
)
}
Variables
{
"companyId": "4",
"id": "4"
}
Response
{"data": {"andonScheduleEventDelete": false}}
andonScheduleEventUnattend
Response
Returns a MaintenanceEvent!
Example
Query
mutation AndonScheduleEventUnattend(
$companyId: ID!,
$eventId: ID!,
$attendeeId: ID!,
$date: Date
) {
andonScheduleEventUnattend(
companyId: $companyId,
eventId: $eventId,
attendeeId: $attendeeId,
date: $date
) {
id
lineId
summary
description
duration
rRuleSet
attendees {
id
supportId
email
phoneNumber
userSub
dateExceptions
messages {
...MessageFragment
}
}
}
}
Variables
{
"companyId": "4",
"eventId": "4",
"attendeeId": "4",
"date": "2007-12-03"
}
Response
{
"data": {
"andonScheduleEventUnattend": {
"id": "4",
"lineId": "4",
"summary": "xyz789",
"description": "abc123",
"duration": 987.65,
"rRuleSet": "xyz789",
"attendees": [Attendee]
}
}
}
andonScheduleEventUpdate
Response
Returns a MaintenanceEvent!
Example
Query
mutation AndonScheduleEventUpdate(
$companyId: ID!,
$id: ID!,
$lineId: ID,
$summary: String,
$description: String,
$duration: Float,
$rRuleSet: String
) {
andonScheduleEventUpdate(
companyId: $companyId,
id: $id,
lineId: $lineId,
summary: $summary,
description: $description,
duration: $duration,
rRuleSet: $rRuleSet
) {
id
lineId
summary
description
duration
rRuleSet
attendees {
id
supportId
email
phoneNumber
userSub
dateExceptions
messages {
...MessageFragment
}
}
}
}
Variables
{
"companyId": 4,
"id": 4,
"lineId": 4,
"summary": "xyz789",
"description": "abc123",
"duration": 123.45,
"rRuleSet": "abc123"
}
Response
{
"data": {
"andonScheduleEventUpdate": {
"id": "4",
"lineId": 4,
"summary": "xyz789",
"description": "abc123",
"duration": 123.45,
"rRuleSet": "abc123",
"attendees": [Attendee]
}
}
}
andonScheduleUpdate
Response
Returns an AndonSchedule!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
id - ID!
|
|
input - ScheduleUpdateInput!
|
Example
Query
mutation AndonScheduleUpdate(
$companyId: ID!,
$id: ID!,
$input: ScheduleUpdateInput!
) {
andonScheduleUpdate(
companyId: $companyId,
id: $id,
input: $input
) {
id
name
lineIds
shifts {
id
name
duration
rRuleSet
attendees {
...AttendingWorkerFragment
}
description
}
shift {
id
name
duration
rRuleSet
attendees {
...AttendingWorkerFragment
}
description
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{"companyId": 4, "id": 4, "input": ScheduleUpdateInput}
Response
{
"data": {
"andonScheduleUpdate": {
"id": 4,
"name": "xyz789",
"lineIds": [4],
"shifts": [AndonShift],
"shift": [AndonShift],
"lines": [Line]
}
}
}
andonShiftCreate
Response
Returns [AndonShift!]!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
scheduleId - ID!
|
|
input - ShiftCreateInput!
|
Example
Query
mutation AndonShiftCreate(
$companyId: ID!,
$scheduleId: ID!,
$input: ShiftCreateInput!
) {
andonShiftCreate(
companyId: $companyId,
scheduleId: $scheduleId,
input: $input
) {
id
name
duration
rRuleSet
attendees {
id
name
email
phoneNumber
userSub
role {
...AndonRoleFragment
}
roles {
...AndonRoleFragment
}
preferredSchedules {
...AndonScheduleFragment
}
isPermanent
isExcluded
}
description
}
}
Variables
{
"companyId": "4",
"scheduleId": "4",
"input": ShiftCreateInput
}
Response
{
"data": {
"andonShiftCreate": [
{
"id": 4,
"name": "abc123",
"duration": 123.45,
"rRuleSet": "xyz789",
"attendees": [AttendingWorker],
"description": "abc123"
}
]
}
}
andonShiftDelete
Example
Query
mutation AndonShiftDelete(
$companyId: ID!,
$scheduleId: ID!,
$id: ID!
) {
andonShiftDelete(
companyId: $companyId,
scheduleId: $scheduleId,
id: $id
)
}
Variables
{"companyId": 4, "scheduleId": 4, "id": 4}
Response
{"data": {"andonShiftDelete": true}}
andonShiftUpdate
Response
Returns [AndonShift!]!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
scheduleId - ID!
|
|
id - ID!
|
|
input - ShiftUpdateInput!
|
Example
Query
mutation AndonShiftUpdate(
$companyId: ID!,
$scheduleId: ID!,
$id: ID!,
$input: ShiftUpdateInput!
) {
andonShiftUpdate(
companyId: $companyId,
scheduleId: $scheduleId,
id: $id,
input: $input
) {
id
name
duration
rRuleSet
attendees {
id
name
email
phoneNumber
userSub
role {
...AndonRoleFragment
}
roles {
...AndonRoleFragment
}
preferredSchedules {
...AndonScheduleFragment
}
isPermanent
isExcluded
}
description
}
}
Variables
{
"companyId": "4",
"scheduleId": 4,
"id": "4",
"input": ShiftUpdateInput
}
Response
{
"data": {
"andonShiftUpdate": [
{
"id": 4,
"name": "xyz789",
"duration": 123.45,
"rRuleSet": "xyz789",
"attendees": [AttendingWorker],
"description": "abc123"
}
]
}
}
andonSupportCreate
Response
Returns a SupportType!
Example
Query
mutation AndonSupportCreate(
$companyId: ID!,
$name: String!,
$languageCode: String
) {
andonSupportCreate(
companyId: $companyId,
name: $name,
languageCode: $languageCode
) {
id
name
}
}
Variables
{
"companyId": "4",
"name": "xyz789",
"languageCode": "abc123"
}
Response
{
"data": {
"andonSupportCreate": {
"id": "4",
"name": "xyz789"
}
}
}
andonSupportDelete
Response
Returns [SupportType!]!
Example
Query
mutation AndonSupportDelete(
$companyId: ID!,
$id: ID!
) {
andonSupportDelete(
companyId: $companyId,
id: $id
) {
id
name
}
}
Variables
{"companyId": 4, "id": "4"}
Response
{
"data": {
"andonSupportDelete": [
{
"id": "4",
"name": "abc123"
}
]
}
}
andonSupportUpdate
Response
Returns a SupportType!
Example
Query
mutation AndonSupportUpdate(
$companyId: ID!,
$id: ID!,
$name: String!,
$languageCode: String
) {
andonSupportUpdate(
companyId: $companyId,
id: $id,
name: $name,
languageCode: $languageCode
) {
id
name
}
}
Variables
{
"companyId": 4,
"id": "4",
"name": "xyz789",
"languageCode": "xyz789"
}
Response
{
"data": {
"andonSupportUpdate": {
"id": 4,
"name": "xyz789"
}
}
}
andonTagCreate
Example
Query
mutation AndonTagCreate(
$value: String!,
$lineIds: [ID!]!
) {
andonTagCreate(
value: $value,
lineIds: $lineIds
) {
id
lineId
value
}
}
Variables
{
"value": "abc123",
"lineIds": ["4"]
}
Response
{
"data": {
"andonTagCreate": {
"id": "4",
"lineId": 4,
"value": "abc123"
}
}
}
andonTagUpdate
Example
Query
mutation AndonTagUpdate(
$id: ID!,
$value: String,
$lineIds: [ID!]
) {
andonTagUpdate(
id: $id,
value: $value,
lineIds: $lineIds
) {
id
lineId
value
}
}
Variables
{
"id": "4",
"value": "xyz789",
"lineIds": [4]
}
Response
{
"data": {
"andonTagUpdate": {
"id": "4",
"lineId": "4",
"value": "xyz789"
}
}
}
andonWorkerCreate
Response
Returns a Worker!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
input - WorkerCreateInput!
|
Example
Query
mutation AndonWorkerCreate(
$companyId: ID!,
$input: WorkerCreateInput!
) {
andonWorkerCreate(
companyId: $companyId,
input: $input
) {
id
name
email
phoneNumber
userSub
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
roles {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
preferredSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
}
}
Variables
{
"companyId": "4",
"input": WorkerCreateInput
}
Response
{
"data": {
"andonWorkerCreate": {
"id": "4",
"name": "xyz789",
"email": "abc123",
"phoneNumber": "xyz789",
"userSub": "xyz789",
"role": AndonRole,
"roles": [AndonRole],
"preferredSchedules": [AndonSchedule]
}
}
}
andonWorkerDelete
Response
Returns [Worker!]!
Example
Query
mutation AndonWorkerDelete(
$companyId: ID!,
$id: ID!
) {
andonWorkerDelete(
companyId: $companyId,
id: $id
) {
id
name
email
phoneNumber
userSub
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
roles {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
preferredSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
}
}
Variables
{"companyId": "4", "id": 4}
Response
{
"data": {
"andonWorkerDelete": [
{
"id": 4,
"name": "xyz789",
"email": "xyz789",
"phoneNumber": "xyz789",
"userSub": "abc123",
"role": AndonRole,
"roles": [AndonRole],
"preferredSchedules": [AndonSchedule]
}
]
}
}
andonWorkerUpdate
Response
Returns a Worker!
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
id - ID!
|
|
input - WorkerUpdateInput!
|
Example
Query
mutation AndonWorkerUpdate(
$companyId: ID!,
$id: ID!,
$input: WorkerUpdateInput!
) {
andonWorkerUpdate(
companyId: $companyId,
id: $id,
input: $input
) {
id
name
email
phoneNumber
userSub
role {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
roles {
id
name
escalationConfiguration {
...EscalationConfigurationFragment
}
}
preferredSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
}
}
Variables
{
"companyId": "4",
"id": 4,
"input": WorkerUpdateInput
}
Response
{
"data": {
"andonWorkerUpdate": {
"id": 4,
"name": "abc123",
"email": "xyz789",
"phoneNumber": "xyz789",
"userSub": "xyz789",
"role": AndonRole,
"roles": [AndonRole],
"preferredSchedules": [AndonSchedule]
}
}
}
attachCamera
Example
Query
mutation AttachCamera(
$peripheralId: ID!,
$sensorPeripheralId: ID!
) {
attachCamera(
peripheralId: $peripheralId,
sensorPeripheralId: $sensorPeripheralId
) {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
expiration
lastReceived
}
attachedSensors {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
streamURL
device {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
hardwareDevice {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
}
}
Variables
{
"peripheralId": "4",
"sensorPeripheralId": "4"
}
Response
{
"data": {
"attachCamera": {
"_id": "4",
"id": "4",
"name": "xyz789",
"index": 4,
"peripheralId": 4,
"owner": 4,
"hardwareId": "4",
"peripheralType": "CAMERA",
"description": "xyz789",
"offlineStatus": OfflineStatus,
"attachedSensors": [Sensor],
"streamURL": "abc123",
"device": Device,
"hardwareDevice": Device
}
}
}
attachControlReceipt
Response
Returns a Product!
Example
Query
mutation AttachControlReceipt(
$lineId: ID!,
$productId: ID!,
$userPoolId: ID,
$controlReceiptId: ID!
) {
attachControlReceipt(
lineId: $lineId,
productId: $productId,
userPoolId: $userPoolId,
controlReceiptId: $controlReceiptId
) {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
packagingId
packagingNumber
lineId
name
unit
comment
}
overwrittenByBatch
parameters {
key
value
alarm {
...AlarmFragment
}
setpoint {
...SetPointFragment
}
}
attachedControlReceipts {
controlReceiptId
userPoolId
name
description
entries {
...ControlReceiptEntryFragment
}
deleted
attachedProducts {
...ProductFragment
}
}
}
}
Variables
{
"lineId": "4",
"productId": "4",
"userPoolId": 4,
"controlReceiptId": 4
}
Response
{
"data": {
"attachControlReceipt": {
"productId": 4,
"name": "abc123",
"itemNumber": "xyz789",
"validatedLineSpeed": 123.45,
"expectedAverageSpeed": 123.45,
"comment": "xyz789",
"lineId": "4",
"dataMultiplier": 987.65,
"packaging": Packaging,
"overwrittenByBatch": true,
"parameters": [Parameter],
"attachedControlReceipts": [ControlReceipt]
}
}
}
batchSetAlarmEnablement
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
treeId - String!
|
|
input - SetAlarmEnablementInput!
|
Example
Query
mutation BatchSetAlarmEnablement(
$treeId: String!,
$input: SetAlarmEnablementInput!
) {
batchSetAlarmEnablement(
treeId: $treeId,
input: $input
)
}
Variables
{
"treeId": "abc123",
"input": SetAlarmEnablementInput
}
Response
{"data": {"batchSetAlarmEnablement": 4}}
cancelBatchControl
Response
Returns a BatchControl!
Example
Query
mutation CancelBatchControl(
$lineId: ID!,
$batchId: ID!,
$controlId: ID!,
$comment: String,
$initials: String
) {
cancelBatchControl(
lineId: $lineId,
batchId: $batchId,
controlId: $controlId,
comment: $comment,
initials: $initials
) {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
controlReceiptField {
...ControlReceiptEntryFieldFragment
}
value
}
followUp {
enabled
delayMs
}
history {
comment
fieldValues {
...BatchControlFieldValueFragment
}
initials
status
timeControlUpdated
timeControlled
}
initials
initialsSettings
originalControl {
controlId
timeTriggered
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
type
payload {
...TimedTriggerPayloadFragment
}
delayWhenStopped
}
}
}
Variables
{
"lineId": 4,
"batchId": "4",
"controlId": 4,
"comment": "abc123",
"initials": "xyz789"
}
Response
{
"data": {
"cancelBatchControl": {
"batchControlId": 4,
"batchId": 4,
"comment": "abc123",
"controlReceiptId": "4",
"controlReceiptName": "abc123",
"entryId": "4",
"fieldValues": [BatchControlFieldValue],
"followUp": FollowUpSettings,
"history": [BatchControlHistory],
"initials": "xyz789",
"initialsSettings": "REQUIRED_IF_OUTSIDE_LIMITS",
"originalControl": OriginalControlDetails,
"status": "CANCELED",
"timeControlUpdated": "2007-12-03",
"timeControlled": "2007-12-03",
"timeTriggered": "2007-12-03",
"title": "xyz789",
"trigger": ControlTrigger
}
}
}
cancelPendingBatchControl
Use
cancelPendingBatchControls instead. Response
Returns a BatchControl!
Example
Query
mutation CancelPendingBatchControl(
$lineId: ID!,
$batchId: ID!,
$controlId: ID!,
$comment: String,
$initials: String
) {
cancelPendingBatchControl(
lineId: $lineId,
batchId: $batchId,
controlId: $controlId,
comment: $comment,
initials: $initials
) {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
controlReceiptField {
...ControlReceiptEntryFieldFragment
}
value
}
followUp {
enabled
delayMs
}
history {
comment
fieldValues {
...BatchControlFieldValueFragment
}
initials
status
timeControlUpdated
timeControlled
}
initials
initialsSettings
originalControl {
controlId
timeTriggered
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
type
payload {
...TimedTriggerPayloadFragment
}
delayWhenStopped
}
}
}
Variables
{
"lineId": 4,
"batchId": 4,
"controlId": "4",
"comment": "abc123",
"initials": "xyz789"
}
Response
{
"data": {
"cancelPendingBatchControl": {
"batchControlId": "4",
"batchId": "4",
"comment": "xyz789",
"controlReceiptId": 4,
"controlReceiptName": "xyz789",
"entryId": 4,
"fieldValues": [BatchControlFieldValue],
"followUp": FollowUpSettings,
"history": [BatchControlHistory],
"initials": "xyz789",
"initialsSettings": "REQUIRED_IF_OUTSIDE_LIMITS",
"originalControl": OriginalControlDetails,
"status": "CANCELED",
"timeControlUpdated": "2007-12-03",
"timeControlled": "2007-12-03",
"timeTriggered": "2007-12-03",
"title": "abc123",
"trigger": ControlTrigger
}
}
}
cancelPendingBatchControls
Response
Returns [BatchControl!]!
Example
Query
mutation CancelPendingBatchControls(
$lineId: ID!,
$batchId: ID!,
$controlIds: [ID!]!,
$comment: String,
$initials: String
) {
cancelPendingBatchControls(
lineId: $lineId,
batchId: $batchId,
controlIds: $controlIds,
comment: $comment,
initials: $initials
) {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
controlReceiptField {
...ControlReceiptEntryFieldFragment
}
value
}
followUp {
enabled
delayMs
}
history {
comment
fieldValues {
...BatchControlFieldValueFragment
}
initials
status
timeControlUpdated
timeControlled
}
initials
initialsSettings
originalControl {
controlId
timeTriggered
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
type
payload {
...TimedTriggerPayloadFragment
}
delayWhenStopped
}
}
}
Variables
{
"lineId": "4",
"batchId": 4,
"controlIds": ["4"],
"comment": "xyz789",
"initials": "abc123"
}
Response
{
"data": {
"cancelPendingBatchControls": [
{
"batchControlId": 4,
"batchId": 4,
"comment": "xyz789",
"controlReceiptId": 4,
"controlReceiptName": "xyz789",
"entryId": 4,
"fieldValues": [BatchControlFieldValue],
"followUp": FollowUpSettings,
"history": [BatchControlHistory],
"initials": "xyz789",
"initialsSettings": "REQUIRED_IF_OUTSIDE_LIMITS",
"originalControl": OriginalControlDetails,
"status": "CANCELED",
"timeControlUpdated": "2007-12-03",
"timeControlled": "2007-12-03",
"timeTriggered": "2007-12-03",
"title": "xyz789",
"trigger": ControlTrigger
}
]
}
}
claimDevice
Response
Returns a Device!
Arguments
| Name | Description |
|---|---|
input - ClaimDeviceInput!
|
Example
Query
mutation ClaimDevice($input: ClaimDeviceInput!) {
claimDevice(input: $input) {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
firmwareVersions {
...FirmwareVersionsFragment
}
hardwareVersion
}
network {
wifi {
...WiFiConfigShadowFragment
}
connection
general {
...GeneralNetworkShadowSettingsFragment
}
}
sensors {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
sensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripherals {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralPhysicalInput {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralPhysicalInputs {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
pendingJobExecutions {
thingName
jobId
executionNumber
lastUpdatedAt
queuedAt
retryAttempt
startedAt
status
describeJobExecution {
...DescribeJobExecutionFragment
}
}
updateAvailable
certificates {
id
isActive
createdAt
validAt
expiresAt
subject
issuer
}
}
}
Variables
{"input": ClaimDeviceInput}
Response
{
"data": {
"claimDevice": {
"_id": "4",
"uuid": 4,
"owner": "4",
"type": "xyz789",
"hardwareId": 4,
"name": "abc123",
"numInputPorts": 123,
"status": DeviceStatus,
"network": NetworkConfig,
"sensors": [Sensor],
"sensor": Sensor,
"peripheral": Peripheral,
"peripherals": [Peripheral],
"peripheralPhysicalInput": Peripheral,
"peripheralPhysicalInputs": [Peripheral],
"pendingJobExecutions": [JobExecutionSummary],
"updateAvailable": false,
"certificates": [Certificate]
}
}
}
createActionPlan
Response
Returns an ActionPlan!
Arguments
| Name | Description |
|---|---|
nodeId - String!
|
|
input - CreateActionPlanInput!
|
|
sendNotification - Boolean
|
Send a notification to the assignee (if assigned in input), defaults to true |
Example
Query
mutation CreateActionPlan(
$nodeId: String!,
$input: CreateActionPlanInput!,
$sendNotification: Boolean
) {
createActionPlan(
nodeId: $nodeId,
input: $input,
sendNotification: $sendNotification
) {
state
title
pdcaState
followUpInterval
followUpState
dueDate
linkedProductionData
version
category {
id
meta {
...ActionPlanCategoryMetaFragment
}
color
version
nodeId
}
content {
column
content
}
escalations {
nodeId
creationDate
createdBySub
assignedToSub
priority
version
plan {
...ActionPlanFragment
}
id
assignedTo {
...UserFragment
}
createdBy {
...UserFragment
}
node {
...HierarchyNodeFragment
}
}
attachedFiles
tasks {
content
checked
version
plan {
...ActionPlanFragment
}
id
}
id
}
}
Variables
{
"nodeId": "abc123",
"input": CreateActionPlanInput,
"sendNotification": true
}
Response
{
"data": {
"createActionPlan": {
"state": "OPEN",
"title": "abc123",
"pdcaState": "PLAN",
"followUpInterval": "DAILY",
"followUpState": 987,
"dueDate": "2007-12-03T10:15:30Z",
"linkedProductionData": ["abc123"],
"version": 987,
"category": ActionPlanCategory,
"content": [ActionPlanContent],
"escalations": [Escalation],
"attachedFiles": ["abc123"],
"tasks": [ActionPlanTask],
"id": "xyz789"
}
}
}
createActionPlanTask
Response
Returns an ActionPlanTask!
Arguments
| Name | Description |
|---|---|
input - CreateActionPlanTaskInput!
|
Example
Query
mutation CreateActionPlanTask($input: CreateActionPlanTaskInput!) {
createActionPlanTask(input: $input) {
content
checked
version
plan {
state
title
pdcaState
followUpInterval
followUpState
dueDate
linkedProductionData
version
category {
...ActionPlanCategoryFragment
}
content {
...ActionPlanContentFragment
}
escalations {
...EscalationFragment
}
attachedFiles
tasks {
...ActionPlanTaskFragment
}
id
}
id
}
}
Variables
{"input": CreateActionPlanTaskInput}
Response
{
"data": {
"createActionPlanTask": {
"content": "abc123",
"checked": true,
"version": 987,
"plan": ActionPlan,
"id": "abc123"
}
}
}
createActivitiesDocument
Response
Returns a GeneratedExportDocument!
Arguments
| Name | Description |
|---|---|
documentInputHeaders - DocumentInputHeaders!
|
|
documentInputs - DocumentInputActivities!
|
Example
Query
mutation CreateActivitiesDocument(
$documentInputHeaders: DocumentInputHeaders!,
$documentInputs: DocumentInputActivities!
) {
createActivitiesDocument(
documentInputHeaders: $documentInputHeaders,
documentInputs: $documentInputs
) {
url
name
description
generatedAt
}
}
Variables
{
"documentInputHeaders": DocumentInputHeaders,
"documentInputs": DocumentInputActivities
}
Response
{
"data": {
"createActivitiesDocument": {
"url": "xyz789",
"name": "abc123",
"description": "xyz789",
"generatedAt": "2007-12-03"
}
}
}
createActivity
Response
Returns an Activity!
Arguments
| Name | Description |
|---|---|
input - CreateActivityInput!
|
Example
Query
mutation CreateActivity($input: CreateActivityInput!) {
createActivity(input: $input) {
id
status
activityTemplate {
id
title
description
translations {
...ActivityTemplateTranslationFragment
}
customFormId
customFormVersion
triggers {
...TriggerFragment
}
expiresAfterMinutes
locationIds
version
createdAt
deletedAt
versions {
...VersionedActivityTemplatesConnectionFragment
}
customForm {
...CustomFormFragment
}
tags {
...ActivityTagFragment
}
}
trigger {
id
type {
...ActivityTriggerTypeFragment
}
conditions {
...TriggerConditionsFragment
}
}
customFormData {
formId
formVersion
values {
...CustomFieldValueFragment
}
initials
form {
...CustomFormFragment
}
schema
}
stopRegistration {
start
end
comment
initials
stopCause {
...ActivityStopCauseFragment
}
}
createdAt
archivedAt
version
locationId
isPassing
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{"input": CreateActivityInput}
Response
{
"data": {
"createActivity": {
"id": ActivityId,
"status": "PENDING",
"activityTemplate": ActivityTemplate,
"trigger": Trigger,
"customFormData": CustomFormData,
"stopRegistration": ActivityStopRegistration,
"createdAt": "2007-12-03T10:15:30Z",
"archivedAt": "2007-12-03T10:15:30Z",
"version": 987,
"locationId": NodeId,
"isPassing": false,
"batch": Batch,
"line": Line
}
}
}
createActivityTag
Internal use only
Response
Returns an ActivityTag!
Arguments
| Name | Description |
|---|---|
input - ActivityTagInput!
|
Example
Query
mutation CreateActivityTag($input: ActivityTagInput!) {
createActivityTag(input: $input) {
id
name
createdAt
modifiedAt
deletedAt
templateCount
}
}
Variables
{"input": ActivityTagInput}
Response
{
"data": {
"createActivityTag": {
"id": ActivityTagId,
"name": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"modifiedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"templateCount": 123
}
}
}
createActivityTemplate
Internal use only
Response
Returns an ActivityTemplate!
Arguments
| Name | Description |
|---|---|
input - ActivityTemplateInput!
|
Example
Query
mutation CreateActivityTemplate($input: ActivityTemplateInput!) {
createActivityTemplate(input: $input) {
id
title
description
translations {
title
description
languageCode
}
customFormId
customFormVersion
triggers {
id
type {
...ActivityTriggerTypeFragment
}
conditions {
...TriggerConditionsFragment
}
}
expiresAfterMinutes
locationIds
version
createdAt
deletedAt
versions {
pageInfo {
...PageInfoFragment
}
edges {
...VersionedActivityTemplateEdgeFragment
}
nodes {
...ActivityTemplateFragment
}
}
customForm {
id
title
description
translations {
...CustomFormTranslationFragment
}
fields {
...CustomFormFieldFragment
}
requireInitials
version
createdAt
deletedAt
versions {
...VersionedCustomFormsConnectionFragment
}
}
tags {
id
name
createdAt
modifiedAt
deletedAt
templateCount
}
}
}
Variables
{"input": ActivityTemplateInput}
Response
{
"data": {
"createActivityTemplate": {
"id": ActivityTemplateId,
"title": "abc123",
"description": "xyz789",
"translations": [ActivityTemplateTranslation],
"customFormId": CustomFormId,
"customFormVersion": 123,
"triggers": [Trigger],
"expiresAfterMinutes": 123,
"locationIds": [NodeId],
"version": 987,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedActivityTemplatesConnection,
"customForm": CustomForm,
"tags": [ActivityTag]
}
}
}
createAlarm
Response
Returns an Alarm!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
name - String!
|
|
description - String!
|
|
threshold - Int!
|
|
type - AlarmType!
|
|
alarmConfiguration - AlarmConfigurationInput!
|
|
enabled - Boolean
|
|
repeatNotification - Boolean
|
Default = true |
snoozeDuration - Int
|
|
subscribers - [SubscriberInput!]
|
Example
Query
mutation CreateAlarm(
$peripheralId: ID!,
$name: String!,
$description: String!,
$threshold: Int!,
$type: AlarmType!,
$alarmConfiguration: AlarmConfigurationInput!,
$enabled: Boolean,
$repeatNotification: Boolean,
$snoozeDuration: Int,
$subscribers: [SubscriberInput!]
) {
createAlarm(
peripheralId: $peripheralId,
name: $name,
description: $description,
threshold: $threshold,
type: $type,
alarmConfiguration: $alarmConfiguration,
enabled: $enabled,
repeatNotification: $repeatNotification,
snoozeDuration: $snoozeDuration,
subscribers: $subscribers
) {
id
name
description
peripheralId
status
threshold
repeatNotification
enabled
type
alarmConfiguration {
x
t
y
n
stopType
}
languageCode
snoozeDuration
alarmLogs {
lastEvaluatedKey {
...AlarmLogLastEvaluatedKeyFragment
}
entries {
...AlarmLogFragment
}
}
subscribers {
type
languageCode
value
}
timeRange {
from
to
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
}
}
Variables
{
"peripheralId": "4",
"name": "xyz789",
"description": "xyz789",
"threshold": 987,
"type": "AboveX",
"alarmConfiguration": AlarmConfigurationInput,
"enabled": true,
"repeatNotification": true,
"snoozeDuration": 123,
"subscribers": [SubscriberInput]
}
Response
{
"data": {
"createAlarm": {
"id": "4",
"name": "xyz789",
"description": "xyz789",
"peripheralId": "4",
"status": "NORMAL",
"threshold": 123,
"repeatNotification": false,
"enabled": false,
"type": "AboveX",
"alarmConfiguration": AlarmConfiguration,
"languageCode": "abc123",
"snoozeDuration": 987,
"alarmLogs": AlarmLogs,
"subscribers": [SubscriberOutput],
"timeRange": TimeRange,
"peripheral": Peripheral
}
}
}
createAnalyticsDocument
Response
Returns a GeneratedExportDocument!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
documentInputHeaders - DocumentInputHeaders!
|
|
documentInputs - DocumentInputAnalytics!
|
Example
Query
mutation CreateAnalyticsDocument(
$peripheralId: ID!,
$documentInputHeaders: DocumentInputHeaders!,
$documentInputs: DocumentInputAnalytics!
) {
createAnalyticsDocument(
peripheralId: $peripheralId,
documentInputHeaders: $documentInputHeaders,
documentInputs: $documentInputs
) {
url
name
description
generatedAt
}
}
Variables
{
"peripheralId": "4",
"documentInputHeaders": DocumentInputHeaders,
"documentInputs": DocumentInputAnalytics
}
Response
{
"data": {
"createAnalyticsDocument": {
"url": "xyz789",
"name": "xyz789",
"description": "abc123",
"generatedAt": "2007-12-03"
}
}
}
createAppClient
Description
Create an OAuth2 client to be used for a client credentials grant flow to issue a short-lived access token.
Response
Returns a CreateAppClientOutput
Arguments
| Name | Description |
|---|---|
input - CreateAppClientInput!
|
Example
Query
mutation CreateAppClient($input: CreateAppClientInput!) {
createAppClient(input: $input) {
clientSecret
appClient {
id
name
groups {
...GroupFragment
}
}
}
}
Variables
{"input": CreateAppClientInput}
Response
{
"data": {
"createAppClient": {
"clientSecret": "abc123",
"appClient": AppClient
}
}
}
createAssistantConversationAsync
Internal use only
Description
Start a new assistant conversation based on a human message. Use assistant_conversation to get updates on the conversation.
Response
Returns an AssistantConversation!
Arguments
| Name | Description |
|---|---|
text - String!
|
|
messageContext - MessageContext
|
|
timeZone - String
|
Example
Query
mutation CreateAssistantConversationAsync(
$text: String!,
$messageContext: MessageContext,
$timeZone: String
) {
createAssistantConversationAsync(
text: $text,
messageContext: $messageContext,
timeZone: $timeZone
) {
id
messages {
role
messageId
status
content {
... on ConversationContentText {
...ConversationContentTextFragment
}
... on ConversationContentVisualizationOptions {
...ConversationContentVisualizationOptionsFragment
}
}
}
}
}
Variables
{
"text": "xyz789",
"messageContext": MessageContext,
"timeZone": "xyz789"
}
Response
{
"data": {
"createAssistantConversationAsync": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"messages": [ConversationMessage]
}
}
}
createBatch
Response
Returns a Batch!
Example
Query
mutation CreateBatch(
$lineId: ID!,
$batchNumber: String!,
$plannedStart: Date!,
$actualStart: Date,
$actualStop: Date,
$amount: Float!,
$manualScrap: Float,
$comment: String,
$productId: ID!,
$dataMultiplier: Float,
$validatedLineSpeed: Float,
$expectedAverageSpeed: Float,
$forceStop: Boolean
) {
createBatch(
lineId: $lineId,
batchNumber: $batchNumber,
plannedStart: $plannedStart,
actualStart: $actualStart,
actualStop: $actualStop,
amount: $amount,
manualScrap: $manualScrap,
comment: $comment,
productId: $productId,
dataMultiplier: $dataMultiplier,
validatedLineSpeed: $validatedLineSpeed,
expectedAverageSpeed: $expectedAverageSpeed,
forceStop: $forceStop
) {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
...PackagingFragment
}
overwrittenByBatch
parameters {
...ParameterFragment
}
attachedControlReceipts {
...ControlReceiptFragment
}
}
sorting
state
tags
controls {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
...BatchControlFieldValueFragment
}
followUp {
...FollowUpSettingsFragment
}
history {
...BatchControlHistoryFragment
}
initials
initialsSettings
originalControl {
...OriginalControlDetailsFragment
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
...ControlTriggerFragment
}
}
samples {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
stops {
_id
timeRange {
...TimeRangeFragment
}
originalStart
ongoing
duration
stopCause {
...StopCauseFragment
}
comment
initials
registeredTime
isMicroStop
isAutomaticRegistration
standalone {
...StandaloneConfigurationFragment
}
target {
...TargetFragment
}
countermeasure
countermeasureInitials
}
stopStats {
longestNonStop
lastStop {
...StopFragment
}
stopCauseStats {
...StopCauseStatFragment
}
}
stats {
timeRange {
...TimeRangeFragment
}
data {
...DataFragment
}
}
scrap {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
plannedEtc
actualEtc
}
}
Variables
{
"lineId": 4,
"batchNumber": "xyz789",
"plannedStart": "2007-12-03",
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 123.45,
"manualScrap": 987.65,
"comment": "abc123",
"productId": "4",
"dataMultiplier": 123.45,
"validatedLineSpeed": 123.45,
"expectedAverageSpeed": 987.65,
"forceStop": false
}
Response
{
"data": {
"createBatch": {
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 123.45,
"batchId": 4,
"batchNumber": "xyz789",
"comment": "xyz789",
"lineId": 4,
"manualScrap": 987.65,
"plannedStart": "2007-12-03",
"produced": 123.45,
"product": Product,
"sorting": "xyz789",
"state": "COMPLETED",
"tags": ["xyz789"],
"controls": [BatchControl],
"samples": [Sample],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat,
"scrap": [Sample],
"createdBy": User,
"line": Line,
"plannedEtc": "2007-12-03",
"actualEtc": "2007-12-03"
}
}
}
createBatchByItemNumber
Description
Create batch by item number
Response
Returns a Batch!
Arguments
| Name | Description |
|---|---|
input - CreateBatchByItemNumberInput!
|
Example
Query
mutation CreateBatchByItemNumber($input: CreateBatchByItemNumberInput!) {
createBatchByItemNumber(input: $input) {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
...PackagingFragment
}
overwrittenByBatch
parameters {
...ParameterFragment
}
attachedControlReceipts {
...ControlReceiptFragment
}
}
sorting
state
tags
controls {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
...BatchControlFieldValueFragment
}
followUp {
...FollowUpSettingsFragment
}
history {
...BatchControlHistoryFragment
}
initials
initialsSettings
originalControl {
...OriginalControlDetailsFragment
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
...ControlTriggerFragment
}
}
samples {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
stops {
_id
timeRange {
...TimeRangeFragment
}
originalStart
ongoing
duration
stopCause {
...StopCauseFragment
}
comment
initials
registeredTime
isMicroStop
isAutomaticRegistration
standalone {
...StandaloneConfigurationFragment
}
target {
...TargetFragment
}
countermeasure
countermeasureInitials
}
stopStats {
longestNonStop
lastStop {
...StopFragment
}
stopCauseStats {
...StopCauseStatFragment
}
}
stats {
timeRange {
...TimeRangeFragment
}
data {
...DataFragment
}
}
scrap {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
plannedEtc
actualEtc
}
}
Variables
{"input": CreateBatchByItemNumberInput}
Response
{
"data": {
"createBatchByItemNumber": {
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 987.65,
"batchId": 4,
"batchNumber": "abc123",
"comment": "abc123",
"lineId": "4",
"manualScrap": 987.65,
"plannedStart": "2007-12-03",
"produced": 987.65,
"product": Product,
"sorting": "xyz789",
"state": "COMPLETED",
"tags": ["xyz789"],
"controls": [BatchControl],
"samples": [Sample],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat,
"scrap": [Sample],
"createdBy": User,
"line": Line,
"plannedEtc": "2007-12-03",
"actualEtc": "2007-12-03"
}
}
}
createBatchesDocument
Response
Returns a GeneratedExportDocument!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
documentInputHeaders - DocumentInputHeaders!
|
|
documentInputs - DocumentInputBatches!
|
Example
Query
mutation CreateBatchesDocument(
$lineId: ID!,
$documentInputHeaders: DocumentInputHeaders!,
$documentInputs: DocumentInputBatches!
) {
createBatchesDocument(
lineId: $lineId,
documentInputHeaders: $documentInputHeaders,
documentInputs: $documentInputs
) {
url
name
description
generatedAt
}
}
Variables
{
"lineId": "4",
"documentInputHeaders": DocumentInputHeaders,
"documentInputs": DocumentInputBatches
}
Response
{
"data": {
"createBatchesDocument": {
"url": "xyz789",
"name": "xyz789",
"description": "xyz789",
"generatedAt": "2007-12-03"
}
}
}
createControlReceipt
Response
Returns a ControlReceipt!
Arguments
| Name | Description |
|---|---|
userPoolId - ID
|
|
name - String!
|
|
description - String
|
|
entries - [ControlReceiptEntryInput!]!
|
Example
Query
mutation CreateControlReceipt(
$userPoolId: ID,
$name: String!,
$description: String,
$entries: [ControlReceiptEntryInput!]!
) {
createControlReceipt(
userPoolId: $userPoolId,
name: $name,
description: $description,
entries: $entries
) {
controlReceiptId
userPoolId
name
description
entries {
entryId
title
trigger {
...ControlTriggerFragment
}
followUp {
...FollowUpSettingsFragment
}
initialsSettings
fields {
...ControlReceiptEntryFieldFragment
}
}
deleted
attachedProducts {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
...PackagingFragment
}
overwrittenByBatch
parameters {
...ParameterFragment
}
attachedControlReceipts {
...ControlReceiptFragment
}
}
}
}
Variables
{
"userPoolId": 4,
"name": "xyz789",
"description": "abc123",
"entries": [ControlReceiptEntryInput]
}
Response
{
"data": {
"createControlReceipt": {
"controlReceiptId": "4",
"userPoolId": 4,
"name": "xyz789",
"description": "xyz789",
"entries": [ControlReceiptEntry],
"deleted": true,
"attachedProducts": [Product]
}
}
}
createCustomForm
Internal use only
Response
Returns a CustomForm!
Arguments
| Name | Description |
|---|---|
input - CustomFormInput!
|
Example
Query
mutation CreateCustomForm($input: CustomFormInput!) {
createCustomForm(input: $input) {
id
title
description
translations {
title
description
languageCode
}
fields {
id
name
description
translations {
...CustomFormFieldTranslationFragment
}
fieldOptions {
...CustomFormFieldOptionsFragment
}
}
requireInitials
version
createdAt
deletedAt
versions {
pageInfo {
...PageInfoFragment
}
edges {
...VersionedCustomFormEdgeFragment
}
nodes {
...CustomFormFragment
}
}
}
}
Variables
{"input": CustomFormInput}
Response
{
"data": {
"createCustomForm": {
"id": CustomFormId,
"title": "abc123",
"description": "abc123",
"translations": [CustomFormTranslation],
"fields": [CustomFormField],
"requireInitials": false,
"version": 987,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedCustomFormsConnection
}
}
}
createDevice
Description
Creates a new device.
Response
Returns a CreatedDevice!
Arguments
| Name | Description |
|---|---|
input - CreateDeviceInput!
|
Example
Query
mutation CreateDevice($input: CreateDeviceInput!) {
createDevice(input: $input) {
url
device {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
}
}
Variables
{"input": CreateDeviceInput}
Response
{
"data": {
"createDevice": {
"url": "abc123",
"device": Device
}
}
}
createEdge
Description
Create a new edge. @iam(key: "Lines.Line")
Response
Returns a LineEdge!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
edge - LineEdgeInput!
|
Example
Query
mutation CreateEdge(
$lineId: ID!,
$edge: LineEdgeInput!
) {
createEdge(
lineId: $lineId,
edge: $edge
) {
from
to
}
}
Variables
{"lineId": 4, "edge": LineEdgeInput}
Response
{
"data": {
"createEdge": {"from": "4", "to": 4}
}
}
createExportStopsDocument
Response
Returns a GeneratedExportDocument!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
documentInputHeaders - DocumentInputHeaders!
|
Example
Query
mutation CreateExportStopsDocument(
$peripheralId: ID!,
$documentInputHeaders: DocumentInputHeaders!
) {
createExportStopsDocument(
peripheralId: $peripheralId,
documentInputHeaders: $documentInputHeaders
) {
url
name
description
generatedAt
}
}
Variables
{
"peripheralId": "4",
"documentInputHeaders": DocumentInputHeaders
}
Response
{
"data": {
"createExportStopsDocument": {
"url": "abc123",
"name": "abc123",
"description": "xyz789",
"generatedAt": "2007-12-03"
}
}
}
createGroup
Response
Returns a Group
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
attributes - GroupAttributes!
|
Example
Query
mutation CreateGroup(
$companyId: ID!,
$attributes: GroupAttributes!
) {
createGroup(
companyId: $companyId,
attributes: $attributes
) {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
id
name
groups {
...GroupFragment
}
roles {
...RoleFragment
}
users {
...UserListFragment
}
group {
...GroupFragment
}
appClients {
...AppClientFragment
}
trialStatus {
...TrialStatusFragment
}
}
name
description
nodeId
role {
id
name
type
permissions {
...PermissionFragment
}
}
users {
pagination {
...TokenFragment
}
items {
...UserFragment
}
}
sensors {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
peripherals {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralsPaginated {
items {
...PeripheralFragment
}
nextOffset
total
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
}
}
Variables
{
"companyId": "4",
"attributes": GroupAttributes
}
Response
{
"data": {
"createGroup": {
"id": "4",
"defaultGroup": true,
"externalIds": ["abc123"],
"peripheralIds": ["4"],
"lineIds": [4],
"owner": Company,
"name": "abc123",
"description": "abc123",
"nodeId": "4",
"role": Role,
"users": UserList,
"sensors": [Sensor],
"peripherals": [Peripheral],
"peripheralsPaginated": PeripheralsPaginated,
"lines": [Line],
"scheduledReports": [ScheduledReport]
}
}
}
createGroupOEEDocument
Response
Returns a GeneratedExportDocument!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
|
documentInputHeaders - DocumentInputHeaders!
|
|
documentInputs - DocumentInputLinesGroupOEE!
|
Example
Query
mutation CreateGroupOEEDocument(
$groupId: ID!,
$documentInputHeaders: DocumentInputHeaders!,
$documentInputs: DocumentInputLinesGroupOEE!
) {
createGroupOEEDocument(
groupId: $groupId,
documentInputHeaders: $documentInputHeaders,
documentInputs: $documentInputs
) {
url
name
description
generatedAt
}
}
Variables
{
"groupId": 4,
"documentInputHeaders": DocumentInputHeaders,
"documentInputs": DocumentInputLinesGroupOEE
}
Response
{
"data": {
"createGroupOEEDocument": {
"url": "abc123",
"name": "abc123",
"description": "xyz789",
"generatedAt": "2007-12-03"
}
}
}
createHierarchyGroup
Use createGroup instead.
Example
Query
mutation CreateHierarchyGroup(
$roleId: ID!,
$nodeId: ID!
) {
createHierarchyGroup(
roleId: $roleId,
nodeId: $nodeId
) {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
id
name
groups {
...GroupFragment
}
roles {
...RoleFragment
}
users {
...UserListFragment
}
group {
...GroupFragment
}
appClients {
...AppClientFragment
}
trialStatus {
...TrialStatusFragment
}
}
name
description
nodeId
role {
id
name
type
permissions {
...PermissionFragment
}
}
users {
pagination {
...TokenFragment
}
items {
...UserFragment
}
}
sensors {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
peripherals {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralsPaginated {
items {
...PeripheralFragment
}
nextOffset
total
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
}
}
Variables
{"roleId": 4, "nodeId": 4}
Response
{
"data": {
"createHierarchyGroup": {
"id": "4",
"defaultGroup": true,
"externalIds": ["abc123"],
"peripheralIds": [4],
"lineIds": [4],
"owner": Company,
"name": "abc123",
"description": "abc123",
"nodeId": "4",
"role": Role,
"users": UserList,
"sensors": [Sensor],
"peripherals": [Peripheral],
"peripheralsPaginated": PeripheralsPaginated,
"lines": [Line],
"scheduledReports": [ScheduledReport]
}
}
}
createHierarchyNode
Response
Returns a HierarchyNode!
Arguments
| Name | Description |
|---|---|
input - CreateHierarchyNodeInput!
|
Example
Query
mutation CreateHierarchyNode($input: CreateHierarchyNodeInput!) {
createHierarchyNode(input: $input) {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
customForms {
...HierarchyNodeCustomFormAttachmentsFragment
}
}
type
descendants {
pageInfo {
...PageInfoFragment
}
edges {
...HierarchyNodeEdgeFragment
}
nodes {
...HierarchyNodeFragment
}
}
ancestors {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{"input": CreateHierarchyNodeInput}
Response
{
"data": {
"createHierarchyNode": {
"id": NodeId,
"version": 987,
"meta": LineNodeMeta,
"attachments": HierarchyNodeAttachments,
"type": "LINE",
"descendants": HierarchyNodeConnection,
"ancestors": [HierarchyNode]
}
}
}
createIOTJob
Response
Returns a CreateIOTJobResponse!
Example
Query
mutation CreateIOTJob(
$jobType: JobType!,
$deviceHardwareId: String!
) {
createIOTJob(
jobType: $jobType,
deviceHardwareId: $deviceHardwareId
) {
otaUpdateArn
otaUpdateId
otaUpdateStatus
jobId
jobArn
description
}
}
Variables
{
"jobType": "OTA",
"deviceHardwareId": "abc123"
}
Response
{
"data": {
"createIOTJob": {
"otaUpdateArn": "abc123",
"otaUpdateId": "xyz789",
"otaUpdateStatus": "xyz789",
"jobId": "abc123",
"jobArn": "abc123",
"description": "xyz789"
}
}
}
createLearningActivity
Internal use only
Response
Returns a LearningActivity!
Arguments
| Name | Description |
|---|---|
input - CreateLearningActivityInput!
|
Example
Query
mutation CreateLearningActivity($input: CreateLearningActivityInput!) {
createLearningActivity(input: $input) {
id
version
nodeId
title
description
content
startEndDatesRequired
validityInMonths
createdAt
updatedAt
createdBySub
updatedBySub
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{"input": CreateLearningActivityInput}
Response
{
"data": {
"createLearningActivity": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"version": 123,
"nodeId": "xyz789",
"title": "xyz789",
"description": "abc123",
"content": "abc123",
"startEndDatesRequired": false,
"validityInMonths": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"updatedBySub": "xyz789",
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
}
}
createLearningRole
Internal use only
Response
Returns a LearningRole!
Arguments
| Name | Description |
|---|---|
input - CreateLearningRoleInput!
|
Example
Query
mutation CreateLearningRole($input: CreateLearningRoleInput!) {
createLearningRole(input: $input) {
id
title
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
skills {
pageInfo {
...PageInfoFragment
}
edges {
...LearningRoleSkillsEdgeFragment
}
nodes {
...LearningRoleSkillFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{"input": CreateLearningRoleInput}
Response
{
"data": {
"createLearningRole": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"title": "xyz789",
"description": "abc123",
"nodeId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "abc123",
"skills": LearningRoleSkillsConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
}
}
createLineWithTopology
Response
Returns a Line!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
|
name - String!
|
|
description - String
|
|
nodes - [LineNodeInput!]!
|
|
edges - [LineEdgeInput!]!
|
Example
Query
mutation CreateLineWithTopology(
$groupId: ID!,
$name: String!,
$description: String,
$nodes: [LineNodeInput!]!,
$edges: [LineEdgeInput!]!
) {
createLineWithTopology(
groupId: $groupId,
name: $name,
description: $description,
nodes: $nodes,
edges: $edges
) {
id
languageCode
owner
location {
timeZone
}
name
description
mainPeripheralId
nodes {
id
type
peripheralId
sensor {
...SensorFragment
}
}
edges {
from
to
}
settings {
oee {
...LineOEESettingsFragment
}
batch {
...LineBatchSettingsFragment
}
}
goldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
bestPendingGoldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
time {
configs {
...SensorConfigFragment
}
alarmLogs {
...AlarmLogsFragment
}
batches {
...BatchListFragment
}
dataOverrides {
...DataOverrideFragment
}
pendingControls {
...BatchControlListFragment
}
samples {
...SampleFragment
}
scrap {
...SampleFragment
}
shifts {
...ShiftInstanceFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
changeoverStops {
...ChangeoverStopFragment
}
_id
timeRange {
...TimeRangeFragment
}
}
products {
nextToken
items {
...ProductFragment
}
}
packagings {
nextToken
items {
...PackagingFragment
}
}
batches {
count
items {
...BatchFragment
}
nextToken
pages
}
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
schedule {
id
lineId
validFrom {
...ScheduleTimeFragment
}
validTo {
...ScheduleTimeFragment
}
shifts {
...ShiftFragment
}
weeklyTargets {
...TargetsFragment
}
configuration {
...ScheduleConfigurationFragment
}
isExceptionalWeek
isFallbackSchedule
}
mainSensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
andonSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
nextShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
scheduledEnd
previousShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
maintenanceWorkOrders {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceWorkOrderEdgeFragment
}
nodes {
...MaintenanceWorkOrderFragment
}
}
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
}
}
Variables
{
"groupId": "4",
"name": "xyz789",
"description": "xyz789",
"nodes": [LineNodeInput],
"edges": [LineEdgeInput]
}
Response
{
"data": {
"createLineWithTopology": {
"id": "4",
"languageCode": "abc123",
"owner": 4,
"location": Location,
"name": "abc123",
"description": "xyz789",
"mainPeripheralId": "4",
"nodes": [LineNode],
"edges": [LineEdge],
"settings": LineSettings,
"goldenBatch": GoldenBatch,
"bestPendingGoldenBatch": GoldenBatch,
"time": [LineTimeData],
"products": ProductList,
"packagings": PackagingList,
"batches": BatchList,
"batch": Batch,
"schedule": Schedule,
"mainSensor": Sensor,
"scheduledReports": [ScheduledReport],
"andonSchedules": [AndonSchedule],
"nextShift": ShiftInstance,
"scheduledEnd": "2007-12-03",
"previousShift": ShiftInstance,
"maintenanceWorkOrders": MaintenanceWorkOrderConnection,
"groups": [Group]
}
}
}
createLiveDataDocument
Response
Returns a GeneratedExportDocument!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
documentInputHeaders - DocumentInputHeaders!
|
|
documentInputs - DocumentInputLiveData!
|
Example
Query
mutation CreateLiveDataDocument(
$peripheralId: ID!,
$documentInputHeaders: DocumentInputHeaders!,
$documentInputs: DocumentInputLiveData!
) {
createLiveDataDocument(
peripheralId: $peripheralId,
documentInputHeaders: $documentInputHeaders,
documentInputs: $documentInputs
) {
url
name
description
generatedAt
}
}
Variables
{
"peripheralId": "4",
"documentInputHeaders": DocumentInputHeaders,
"documentInputs": DocumentInputLiveData
}
Response
{
"data": {
"createLiveDataDocument": {
"url": "abc123",
"name": "abc123",
"description": "abc123",
"generatedAt": "2007-12-03"
}
}
}
createMaintenanceLogDocument
Response
Returns a GeneratedExportDocument!
Arguments
| Name | Description |
|---|---|
documentInputHeaders - DocumentInputHeaders!
|
|
documentInputs - DocumentInputMaintenanceLog!
|
Example
Query
mutation CreateMaintenanceLogDocument(
$documentInputHeaders: DocumentInputHeaders!,
$documentInputs: DocumentInputMaintenanceLog!
) {
createMaintenanceLogDocument(
documentInputHeaders: $documentInputHeaders,
documentInputs: $documentInputs
) {
url
name
description
generatedAt
}
}
Variables
{
"documentInputHeaders": DocumentInputHeaders,
"documentInputs": DocumentInputMaintenanceLog
}
Response
{
"data": {
"createMaintenanceLogDocument": {
"url": "xyz789",
"name": "xyz789",
"description": "xyz789",
"generatedAt": "2007-12-03"
}
}
}
createMaintenanceLogEntry
Response
Returns a MaintenanceLogEntry!
Arguments
| Name | Description |
|---|---|
input - CreateMaintenanceLogEntryInput!
|
Example
Query
mutation CreateMaintenanceLogEntry($input: CreateMaintenanceLogEntryInput!) {
createMaintenanceLogEntry(input: $input) {
planId
lineId
status
workOrderDueAt
workOrderOverdueAt
timestamp
produced
startFrom
initials
comment
planSnapshot {
title
asset
tagPartNumber
instructions
trackBy {
...TrackByOptionsFragment
}
}
customData {
formId
formVersion
values {
...CustomFieldValueFragment
}
initials
form {
...CustomFormFragment
}
schema
}
andonCallId
stopCauseIds
stopCausePeripheralId
assetIds
startOfService
endOfService
startOfStop
endOfStop
version
effectiveDuration
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
assets {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{"input": CreateMaintenanceLogEntryInput}
Response
{
"data": {
"createMaintenanceLogEntry": {
"planId": MaintenancePlanId,
"lineId": LineId,
"status": "COMPLETED",
"workOrderDueAt": "2007-12-03T10:15:30Z",
"workOrderOverdueAt": "2007-12-03T10:15:30Z",
"timestamp": "2007-12-03T10:15:30Z",
"produced": 987,
"startFrom": "2007-12-03T10:15:30Z",
"initials": "xyz789",
"comment": "abc123",
"planSnapshot": MaintenancePlanSnapshot,
"customData": CustomFormData,
"andonCallId": "xyz789",
"stopCauseIds": ["xyz789"],
"stopCausePeripheralId": PeripheralId,
"assetIds": [NodeId],
"startOfService": "2007-12-03T10:15:30Z",
"endOfService": "2007-12-03T10:15:30Z",
"startOfStop": "2007-12-03T10:15:30Z",
"endOfStop": "2007-12-03T10:15:30Z",
"version": 123,
"effectiveDuration": 987,
"line": Line,
"stopCauses": [StopCause],
"assets": [HierarchyNode]
}
}
}
createMaintenancePlan
Response
Returns a MaintenancePlan!
Arguments
| Name | Description |
|---|---|
input - CreateMaintenancePlanInput!
|
Example
Query
mutation CreateMaintenancePlan($input: CreateMaintenancePlanInput!) {
createMaintenancePlan(input: $input) {
planId
lineId
title
asset
tagPartNumber
instructions
startFrom
trackBy {
time {
...TrackByTimeFragment
}
production {
...TrackByProductionFragment
}
calendar {
...TrackByCalendarFragment
}
}
repeat
version
role {
id
name
}
log {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceLogEntryEdgeFragment
}
nodes {
...MaintenanceLogEntryFragment
}
}
nextWorkOrder {
plan {
...MaintenancePlanFragment
}
dueAt
overdueAt
produced
latestMaintenance {
...MaintenanceLogEntryFragment
}
peripheral {
...PeripheralFragment
}
line {
...LineFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{"input": CreateMaintenancePlanInput}
Response
{
"data": {
"createMaintenancePlan": {
"planId": MaintenancePlanId,
"lineId": LineId,
"title": "abc123",
"asset": "xyz789",
"tagPartNumber": "abc123",
"instructions": "xyz789",
"startFrom": "2007-12-03T10:15:30Z",
"trackBy": TrackByOptions,
"repeat": "YES",
"version": 987,
"role": MaintenanceRole,
"log": MaintenanceLogEntryConnection,
"nextWorkOrder": MaintenanceWorkOrder,
"peripheral": Peripheral,
"line": Line
}
}
}
createMediaPresignedDownloadUrl
Internal use only
Description
Create a presigned URL used to download previously uploaded media files.
Expires in 1 minute.
Response
Returns a MediaPresignedDownloadUrl!
Arguments
| Name | Description |
|---|---|
fileName - String!
|
Example
Query
mutation CreateMediaPresignedDownloadUrl($fileName: String!) {
createMediaPresignedDownloadUrl(fileName: $fileName) {
downloadUrl
}
}
Variables
{"fileName": "abc123"}
Response
{
"data": {
"createMediaPresignedDownloadUrl": {
"downloadUrl": "xyz789"
}
}
}
createMediaPresignedUploadUrl
Internal use only
Description
Create a presigned URL used to upload media files. Stores the files in an AWS S3 bucket.
Expires in 5 minutes.
Response
Returns a MediaPresignedUploadUrl!
Arguments
| Name | Description |
|---|---|
fileName - String!
|
Example
Query
mutation CreateMediaPresignedUploadUrl($fileName: String!) {
createMediaPresignedUploadUrl(fileName: $fileName) {
fileName
uploadUrl
}
}
Variables
{"fileName": "abc123"}
Response
{
"data": {
"createMediaPresignedUploadUrl": {
"fileName": "abc123",
"uploadUrl": "xyz789"
}
}
}
createNode
Description
Create a new node. @iam(key: "Lines.Line")
Response
Returns a LineNode!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
node - LineNodeInput!
|
Example
Query
mutation CreateNode(
$lineId: ID!,
$node: LineNodeInput!
) {
createNode(
lineId: $lineId,
node: $node
) {
id
type
peripheralId
sensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
}
}
Variables
{
"lineId": "4",
"node": LineNodeInput
}
Response
{
"data": {
"createNode": {
"id": "4",
"type": "Main",
"peripheralId": 4,
"sensor": Sensor
}
}
}
createOEEDocument
Response
Returns a GeneratedExportDocument!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
documentInputHeaders - DocumentInputHeaders!
|
|
documentInputs - DocumentInputLineOEE!
|
Example
Query
mutation CreateOEEDocument(
$lineId: ID!,
$documentInputHeaders: DocumentInputHeaders!,
$documentInputs: DocumentInputLineOEE!
) {
createOEEDocument(
lineId: $lineId,
documentInputHeaders: $documentInputHeaders,
documentInputs: $documentInputs
) {
url
name
description
generatedAt
}
}
Variables
{
"lineId": "4",
"documentInputHeaders": DocumentInputHeaders,
"documentInputs": DocumentInputLineOEE
}
Response
{
"data": {
"createOEEDocument": {
"url": "xyz789",
"name": "abc123",
"description": "xyz789",
"generatedAt": "2007-12-03"
}
}
}
createPackaging
Response
Returns a Packaging!
Example
Query
mutation CreatePackaging(
$lineId: ID!,
$name: String!,
$packagingNumber: String!,
$unit: String!,
$comment: String
) {
createPackaging(
lineId: $lineId,
name: $name,
packagingNumber: $packagingNumber,
unit: $unit,
comment: $comment
) {
packagingId
packagingNumber
lineId
name
unit
comment
}
}
Variables
{
"lineId": "4",
"name": "abc123",
"packagingNumber": "xyz789",
"unit": "xyz789",
"comment": "xyz789"
}
Response
{
"data": {
"createPackaging": {
"packagingId": "4",
"packagingNumber": "xyz789",
"lineId": "abc123",
"name": "abc123",
"unit": "xyz789",
"comment": "xyz789"
}
}
}
createPageReport
Response
Returns a GeneratedPageReport!
Example
Query
mutation CreatePageReport(
$pageURL: String!,
$userName: String!
) {
createPageReport(
pageURL: $pageURL,
userName: $userName
) {
url
name
generatedAt
}
}
Variables
{
"pageURL": "xyz789",
"userName": "xyz789"
}
Response
{
"data": {
"createPageReport": {
"url": "abc123",
"name": "abc123",
"generatedAt": "2007-12-03"
}
}
}
createPeripheral
Response
Returns a Peripheral
Arguments
| Name | Description |
|---|---|
softwareId - ID
|
|
hardwareId - ID
|
|
input - CreatePeripheralInput!
|
|
initialGroups - [ID!]
|
Example
Query
mutation CreatePeripheral(
$softwareId: ID,
$hardwareId: ID,
$input: CreatePeripheralInput!,
$initialGroups: [ID!]
) {
createPeripheral(
softwareId: $softwareId,
hardwareId: $hardwareId,
input: $input,
initialGroups: $initialGroups
) {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
expiration
lastReceived
}
device {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
hardwareDevice {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
}
}
Variables
{
"softwareId": "4",
"hardwareId": "4",
"input": CreatePeripheralInput,
"initialGroups": ["4"]
}
Response
{
"data": {
"createPeripheral": {
"_id": 4,
"id": "4",
"name": "abc123",
"index": "4",
"peripheralId": 4,
"owner": 4,
"hardwareId": "4",
"peripheralType": "CAMERA",
"description": "xyz789",
"offlineStatus": OfflineStatus,
"device": Device,
"hardwareDevice": Device
}
}
}
createPreSignedURL
Description
Create a pre-signed URL for uploading documents for import.
Response
Returns an PreSignedURL!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
Example
Query
mutation CreatePreSignedURL($peripheralId: ID!) {
createPreSignedURL(peripheralId: $peripheralId) {
url
objectKey
}
}
Variables
{"peripheralId": "4"}
Response
{
"data": {
"createPreSignedURL": {
"url": "xyz789",
"objectKey": "xyz789"
}
}
}
createProduct
Response
Returns a Product!
Example
Query
mutation CreateProduct(
$lineId: ID!,
$itemNumber: String!,
$name: String!,
$validatedLineSpeed: Float!,
$expectedAverageSpeed: Float!,
$comment: String,
$dataMultiplier: Float!,
$packagingId: ID!,
$parameters: [InputParameter!]
) {
createProduct(
lineId: $lineId,
itemNumber: $itemNumber,
name: $name,
validatedLineSpeed: $validatedLineSpeed,
expectedAverageSpeed: $expectedAverageSpeed,
comment: $comment,
dataMultiplier: $dataMultiplier,
packagingId: $packagingId,
parameters: $parameters
) {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
packagingId
packagingNumber
lineId
name
unit
comment
}
overwrittenByBatch
parameters {
key
value
alarm {
...AlarmFragment
}
setpoint {
...SetPointFragment
}
}
attachedControlReceipts {
controlReceiptId
userPoolId
name
description
entries {
...ControlReceiptEntryFragment
}
deleted
attachedProducts {
...ProductFragment
}
}
}
}
Variables
{
"lineId": 4,
"itemNumber": "abc123",
"name": "xyz789",
"validatedLineSpeed": 987.65,
"expectedAverageSpeed": 123.45,
"comment": "xyz789",
"dataMultiplier": 123.45,
"packagingId": "4",
"parameters": [InputParameter]
}
Response
{
"data": {
"createProduct": {
"productId": 4,
"name": "xyz789",
"itemNumber": "xyz789",
"validatedLineSpeed": 123.45,
"expectedAverageSpeed": 987.65,
"comment": "xyz789",
"lineId": "4",
"dataMultiplier": 123.45,
"packaging": Packaging,
"overwrittenByBatch": false,
"parameters": [Parameter],
"attachedControlReceipts": [ControlReceipt]
}
}
}
createRole
Response
Returns a Role
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
attributes - RoleAttributes!
|
Example
Query
mutation CreateRole(
$companyId: ID!,
$attributes: RoleAttributes!
) {
createRole(
companyId: $companyId,
attributes: $attributes
) {
id
name
type
permissions {
key
type
description
}
}
}
Variables
{"companyId": 4, "attributes": RoleAttributes}
Response
{
"data": {
"createRole": {
"id": "4",
"name": "xyz789",
"type": "SUPER",
"permissions": [Permission]
}
}
}
createScheduledReportForGroup
Response
Returns a ScheduledReport!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
|
type - ReportType!
|
|
name - String!
|
|
description - String!
|
|
trigger - TriggerType!
|
|
triggerParameters - String
|
|
subscribers - [ReportSubscriberInput!]!
|
|
enabled - Boolean!
|
|
timezone - String!
|
|
stopFilter - StopFilterInput
|
Example
Query
mutation CreateScheduledReportForGroup(
$groupId: ID!,
$type: ReportType!,
$name: String!,
$description: String!,
$trigger: TriggerType!,
$triggerParameters: String,
$subscribers: [ReportSubscriberInput!]!,
$enabled: Boolean!,
$timezone: String!,
$stopFilter: StopFilterInput
) {
createScheduledReportForGroup(
groupId: $groupId,
type: $type,
name: $name,
description: $description,
trigger: $trigger,
triggerParameters: $triggerParameters,
subscribers: $subscribers,
enabled: $enabled,
timezone: $timezone,
stopFilter: $stopFilter
) {
id
type
entityId
entityType
name
description
enabled
subscribers {
type
value
languageCode
disabled
}
trigger {
type
parameters
}
nextTriggerDate
timezone
stopFilter {
stopTypes
stopCauseIds
includeMicroStops
}
}
}
Variables
{
"groupId": 4,
"type": "STOPS_LAST_6_DAYS",
"name": "xyz789",
"description": "abc123",
"trigger": "CRON",
"triggerParameters": "abc123",
"subscribers": [ReportSubscriberInput],
"enabled": true,
"timezone": "xyz789",
"stopFilter": StopFilterInput
}
Response
{
"data": {
"createScheduledReportForGroup": {
"id": "4",
"type": "STOPS_LAST_6_DAYS",
"entityId": 4,
"entityType": "LINE",
"name": "xyz789",
"description": "xyz789",
"enabled": false,
"subscribers": [ReportSubscriber],
"trigger": ScheduledReportTrigger,
"nextTriggerDate": "2007-12-03",
"timezone": "xyz789",
"stopFilter": ReportStopFilter
}
}
}
createScheduledReportForLine
Response
Returns a ScheduledReport!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
type - ReportType!
|
|
name - String!
|
|
description - String!
|
|
trigger - TriggerType!
|
|
triggerParameters - String
|
|
subscribers - [ReportSubscriberInput!]!
|
|
enabled - Boolean!
|
|
timezone - String!
|
|
stopFilter - StopFilterInput
|
Example
Query
mutation CreateScheduledReportForLine(
$lineId: ID!,
$type: ReportType!,
$name: String!,
$description: String!,
$trigger: TriggerType!,
$triggerParameters: String,
$subscribers: [ReportSubscriberInput!]!,
$enabled: Boolean!,
$timezone: String!,
$stopFilter: StopFilterInput
) {
createScheduledReportForLine(
lineId: $lineId,
type: $type,
name: $name,
description: $description,
trigger: $trigger,
triggerParameters: $triggerParameters,
subscribers: $subscribers,
enabled: $enabled,
timezone: $timezone,
stopFilter: $stopFilter
) {
id
type
entityId
entityType
name
description
enabled
subscribers {
type
value
languageCode
disabled
}
trigger {
type
parameters
}
nextTriggerDate
timezone
stopFilter {
stopTypes
stopCauseIds
includeMicroStops
}
}
}
Variables
{
"lineId": "4",
"type": "STOPS_LAST_6_DAYS",
"name": "abc123",
"description": "xyz789",
"trigger": "CRON",
"triggerParameters": "abc123",
"subscribers": [ReportSubscriberInput],
"enabled": true,
"timezone": "abc123",
"stopFilter": StopFilterInput
}
Response
{
"data": {
"createScheduledReportForLine": {
"id": "4",
"type": "STOPS_LAST_6_DAYS",
"entityId": 4,
"entityType": "LINE",
"name": "abc123",
"description": "xyz789",
"enabled": true,
"subscribers": [ReportSubscriber],
"trigger": ScheduledReportTrigger,
"nextTriggerDate": "2007-12-03",
"timezone": "abc123",
"stopFilter": ReportStopFilter
}
}
}
createScheduledReportForSensor
Response
Returns a ScheduledReport!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
type - ReportType!
|
|
name - String!
|
|
description - String!
|
|
trigger - TriggerType!
|
|
triggerParameters - String
|
|
subscribers - [ReportSubscriberInput!]!
|
|
enabled - Boolean!
|
|
timezone - String!
|
|
stopFilter - StopFilterInput
|
Example
Query
mutation CreateScheduledReportForSensor(
$peripheralId: ID!,
$type: ReportType!,
$name: String!,
$description: String!,
$trigger: TriggerType!,
$triggerParameters: String,
$subscribers: [ReportSubscriberInput!]!,
$enabled: Boolean!,
$timezone: String!,
$stopFilter: StopFilterInput
) {
createScheduledReportForSensor(
peripheralId: $peripheralId,
type: $type,
name: $name,
description: $description,
trigger: $trigger,
triggerParameters: $triggerParameters,
subscribers: $subscribers,
enabled: $enabled,
timezone: $timezone,
stopFilter: $stopFilter
) {
id
type
entityId
entityType
name
description
enabled
subscribers {
type
value
languageCode
disabled
}
trigger {
type
parameters
}
nextTriggerDate
timezone
stopFilter {
stopTypes
stopCauseIds
includeMicroStops
}
}
}
Variables
{
"peripheralId": "4",
"type": "STOPS_LAST_6_DAYS",
"name": "xyz789",
"description": "xyz789",
"trigger": "CRON",
"triggerParameters": "abc123",
"subscribers": [ReportSubscriberInput],
"enabled": false,
"timezone": "xyz789",
"stopFilter": StopFilterInput
}
Response
{
"data": {
"createScheduledReportForSensor": {
"id": 4,
"type": "STOPS_LAST_6_DAYS",
"entityId": 4,
"entityType": "LINE",
"name": "abc123",
"description": "xyz789",
"enabled": false,
"subscribers": [ReportSubscriber],
"trigger": ScheduledReportTrigger,
"nextTriggerDate": "2007-12-03",
"timezone": "abc123",
"stopFilter": ReportStopFilter
}
}
}
createSkill
Internal use only
Response
Returns a Skill!
Arguments
| Name | Description |
|---|---|
input - CreateSkillInput!
|
Example
Query
mutation CreateSkill($input: CreateSkillInput!) {
createSkill(input: $input) {
id
title
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...SkillLearningActivitiesEdgeFragment
}
nodes {
...SkillLearningActivityFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{"input": CreateSkillInput}
Response
{
"data": {
"createSkill": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"title": "xyz789",
"description": "abc123",
"nodeId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"updatedBySub": "abc123",
"learningActivities": SkillLearningActivitiesConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
}
}
createStopCause
Response
Returns [StopCauseCategory!]
Arguments
| Name | Description |
|---|---|
deviceOwner - ID
|
|
peripheralId - ID
|
|
groupId - ID
|
|
name - String
|
|
description - String
|
|
meta - [StopCauseMetaInput!]
|
|
requireInitials - Boolean
|
|
requireComment - Boolean
|
|
stopType - StopType!
|
|
stopCauseCategoryId - ID!
|
|
legacyStopCauseId - ID
|
|
targetSetup - TargetSetupInput
|
|
enableCountermeasure - Boolean
|
Example
Query
mutation CreateStopCause(
$deviceOwner: ID,
$peripheralId: ID,
$groupId: ID,
$name: String,
$description: String,
$meta: [StopCauseMetaInput!],
$requireInitials: Boolean,
$requireComment: Boolean,
$stopType: StopType!,
$stopCauseCategoryId: ID!,
$legacyStopCauseId: ID,
$targetSetup: TargetSetupInput,
$enableCountermeasure: Boolean
) {
createStopCause(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
groupId: $groupId,
name: $name,
description: $description,
meta: $meta,
requireInitials: $requireInitials,
requireComment: $requireComment,
stopType: $stopType,
stopCauseCategoryId: $stopCauseCategoryId,
legacyStopCauseId: $legacyStopCauseId,
targetSetup: $targetSetup,
enableCountermeasure: $enableCountermeasure
) {
_id
id
ownerType
order
name
meta {
name
languageCode
}
languageCode
deleted
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
legacyCategoryId
}
}
Variables
{
"deviceOwner": "4",
"peripheralId": "4",
"groupId": 4,
"name": "abc123",
"description": "xyz789",
"meta": [StopCauseMetaInput],
"requireInitials": true,
"requireComment": false,
"stopType": "NO_ACT",
"stopCauseCategoryId": 4,
"legacyStopCauseId": "4",
"targetSetup": TargetSetupInput,
"enableCountermeasure": true
}
Response
{
"data": {
"createStopCause": [
{
"_id": "4",
"id": "4",
"ownerType": "SENSOR",
"order": 123,
"name": "xyz789",
"meta": [StopCauseCategoryMeta],
"languageCode": "xyz789",
"deleted": true,
"stopCauses": [StopCause],
"legacyCategoryId": 4
}
]
}
}
createStopCauseCategory
Response
Returns [StopCauseCategory!]
Example
Query
mutation CreateStopCauseCategory(
$deviceOwner: ID,
$peripheralId: ID,
$groupId: ID,
$name: String!,
$legacyCategoryId: ID
) {
createStopCauseCategory(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
groupId: $groupId,
name: $name,
legacyCategoryId: $legacyCategoryId
) {
_id
id
ownerType
order
name
meta {
name
languageCode
}
languageCode
deleted
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
legacyCategoryId
}
}
Variables
{
"deviceOwner": "4",
"peripheralId": 4,
"groupId": 4,
"name": "abc123",
"legacyCategoryId": "4"
}
Response
{
"data": {
"createStopCauseCategory": [
{
"_id": "4",
"id": 4,
"ownerType": "SENSOR",
"order": 987,
"name": "abc123",
"meta": [StopCauseCategoryMeta],
"languageCode": "xyz789",
"deleted": false,
"stopCauses": [StopCause],
"legacyCategoryId": "4"
}
]
}
}
createTreeNode
Response
Returns a Node!
Arguments
| Name | Description |
|---|---|
treeId - String!
|
|
input - CreateNodeInput
|
Example
Query
mutation CreateTreeNode(
$treeId: String!,
$input: CreateNodeInput
) {
createTreeNode(
treeId: $treeId,
input: $input
) {
id
breadcrumb {
name
id
}
refId
alarmStatus
children {
id
breadcrumb {
...BreadcrumbFragment
}
refId
alarmStatus
children {
...NodeFragment
}
leafDescendants {
...NodesWithPageTokenFragment
}
line {
...LineFragment
}
peripheral {
...PeripheralFragment
}
}
leafDescendants {
nodes {
...NodeFragment
}
nextPageToken
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
}
}
Variables
{
"treeId": "abc123",
"input": CreateNodeInput
}
Response
{
"data": {
"createTreeNode": {
"id": "4",
"breadcrumb": [Breadcrumb],
"refId": "4",
"alarmStatus": "Ongoing",
"children": [Node],
"leafDescendants": NodesWithPageToken,
"line": Line,
"peripheral": Peripheral
}
}
}
createUser
Response
Returns a User
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
username - String!
|
|
attributes - UserAttributes!
|
|
groupIds - [ID!]
|
Example
Query
mutation CreateUser(
$companyId: ID!,
$username: String!,
$attributes: UserAttributes!,
$groupIds: [ID!]
) {
createUser(
companyId: $companyId,
username: $username,
attributes: $attributes,
groupIds: $groupIds
) {
company {
id
name
groups {
...GroupFragment
}
roles {
...RoleFragment
}
users {
...UserListFragment
}
group {
...GroupFragment
}
appClients {
...AppClientFragment
}
trialStatus {
...TrialStatusFragment
}
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
devices {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
linesPaginated {
items {
...LineFragment
}
nextOffset
total
}
skills {
pageInfo {
...PageInfoFragment
}
edges {
...UserSkillEdgeFragment
}
nodes {
...UserSkillFragment
}
}
learningRoles {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningRoleEdgeFragment
}
nodes {
...UserLearningRoleFragment
}
}
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningActivityEdgeFragment
}
nodes {
...UserLearningActivityFragment
}
}
sessions {
generatedAt
expiresAt
userSub
}
}
}
Variables
{
"companyId": "4",
"username": "xyz789",
"attributes": UserAttributes,
"groupIds": ["4"]
}
Response
{
"data": {
"createUser": {
"company": Company,
"username": "abc123",
"enabled": false,
"userStatus": "abc123",
"userCreateDate": "2007-12-03",
"userLastModifiedDate": "2007-12-03",
"sub": "xyz789",
"email": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"emailVerified": "abc123",
"groups": [Group],
"devices": [Device],
"lines": [Line],
"linesPaginated": LinesPaginated,
"skills": UserSkillConnection,
"learningRoles": UserLearningRoleConnection,
"learningActivities": UserLearningActivityConnection,
"sessions": [Session]
}
}
}
createWebhook
Description
Create a new webhook.
Response
Returns a Webhook!
Arguments
| Name | Description |
|---|---|
input - CreateWebhookInput!
|
Example
Query
mutation CreateWebhook($input: CreateWebhookInput!) {
createWebhook(input: $input) {
id
url
description
headers
triggerType
createdAt
updatedAt
deletedAt
}
}
Variables
{"input": CreateWebhookInput}
Response
{
"data": {
"createWebhook": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"url": "abc123",
"description": "xyz789",
"headers": {},
"triggerType": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z"
}
}
}
dataOverrideDelete
Response
Returns a DataOverride!
Example
Query
mutation DataOverrideDelete(
$peripheralId: ID!,
$from: Date!
) {
dataOverrideDelete(
peripheralId: $peripheralId,
from: $from
) {
peripheralId
timeRange {
from
to
}
value
author
comment
}
}
Variables
{"peripheralId": 4, "from": "2007-12-03"}
Response
{
"data": {
"dataOverrideDelete": {
"peripheralId": 4,
"timeRange": TimeRange,
"value": 987,
"author": "abc123",
"comment": "xyz789"
}
}
}
dataOverrideUpsert
Response
Returns a DataOverride!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
input - DataOverrideUpsertInput!
|
Example
Query
mutation DataOverrideUpsert(
$peripheralId: ID!,
$input: DataOverrideUpsertInput!
) {
dataOverrideUpsert(
peripheralId: $peripheralId,
input: $input
) {
peripheralId
timeRange {
from
to
}
value
author
comment
}
}
Variables
{"peripheralId": 4, "input": DataOverrideUpsertInput}
Response
{
"data": {
"dataOverrideUpsert": {
"peripheralId": "4",
"timeRange": TimeRange,
"value": 123,
"author": "abc123",
"comment": "abc123"
}
}
}
deleteActionPlanTask
deleteActivityTag
Internal use only
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - ActivityTagId!
|
Example
Query
mutation DeleteActivityTag($id: ActivityTagId!) {
deleteActivityTag(id: $id)
}
Variables
{"id": ActivityTagId}
Response
{"data": {"deleteActivityTag": false}}
deleteActivityTags
Internal use only
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
ids - [ActivityTagId!]!
|
Example
Query
mutation DeleteActivityTags($ids: [ActivityTagId!]!) {
deleteActivityTags(ids: $ids)
}
Variables
{"ids": [ActivityTagId]}
Response
{"data": {"deleteActivityTags": false}}
deleteActivityTemplate
Internal use only
Response
Returns an ActivityTemplate!
Arguments
| Name | Description |
|---|---|
id - ActivityTemplateId!
|
Example
Query
mutation DeleteActivityTemplate($id: ActivityTemplateId!) {
deleteActivityTemplate(id: $id) {
id
title
description
translations {
title
description
languageCode
}
customFormId
customFormVersion
triggers {
id
type {
...ActivityTriggerTypeFragment
}
conditions {
...TriggerConditionsFragment
}
}
expiresAfterMinutes
locationIds
version
createdAt
deletedAt
versions {
pageInfo {
...PageInfoFragment
}
edges {
...VersionedActivityTemplateEdgeFragment
}
nodes {
...ActivityTemplateFragment
}
}
customForm {
id
title
description
translations {
...CustomFormTranslationFragment
}
fields {
...CustomFormFieldFragment
}
requireInitials
version
createdAt
deletedAt
versions {
...VersionedCustomFormsConnectionFragment
}
}
tags {
id
name
createdAt
modifiedAt
deletedAt
templateCount
}
}
}
Variables
{"id": ActivityTemplateId}
Response
{
"data": {
"deleteActivityTemplate": {
"id": ActivityTemplateId,
"title": "abc123",
"description": "xyz789",
"translations": [ActivityTemplateTranslation],
"customFormId": CustomFormId,
"customFormVersion": 123,
"triggers": [Trigger],
"expiresAfterMinutes": 123,
"locationIds": [NodeId],
"version": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedActivityTemplatesConnection,
"customForm": CustomForm,
"tags": [ActivityTag]
}
}
}
deleteAlarm
Example
Query
mutation DeleteAlarm(
$peripheralId: ID!,
$alarmId: ID!
) {
deleteAlarm(
peripheralId: $peripheralId,
alarmId: $alarmId
)
}
Variables
{"peripheralId": 4, "alarmId": 4}
Response
{"data": {"deleteAlarm": 987}}
deleteAppClient
deleteBatch
deleteControlReceipt
Example
Query
mutation DeleteControlReceipt(
$userPoolId: ID,
$controlReceiptId: ID!
) {
deleteControlReceipt(
userPoolId: $userPoolId,
controlReceiptId: $controlReceiptId
)
}
Variables
{
"userPoolId": "4",
"controlReceiptId": "4"
}
Response
{"data": {"deleteControlReceipt": "4"}}
deleteCustomForm
Internal use only
Response
Returns a CustomForm!
Arguments
| Name | Description |
|---|---|
id - CustomFormId!
|
Example
Query
mutation DeleteCustomForm($id: CustomFormId!) {
deleteCustomForm(id: $id) {
id
title
description
translations {
title
description
languageCode
}
fields {
id
name
description
translations {
...CustomFormFieldTranslationFragment
}
fieldOptions {
...CustomFormFieldOptionsFragment
}
}
requireInitials
version
createdAt
deletedAt
versions {
pageInfo {
...PageInfoFragment
}
edges {
...VersionedCustomFormEdgeFragment
}
nodes {
...CustomFormFragment
}
}
}
}
Variables
{"id": CustomFormId}
Response
{
"data": {
"deleteCustomForm": {
"id": CustomFormId,
"title": "xyz789",
"description": "abc123",
"translations": [CustomFormTranslation],
"fields": [CustomFormField],
"requireInitials": false,
"version": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedCustomFormsConnection
}
}
}
deleteDevice
Description
Deletes a device.
`uuid' represents the allocated software identifier.
deleteEdge
Description
Delete an existing edge. @iam(key: "Lines.Line")
Response
Returns [LineEdge!]!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
edge - LineEdgeInput!
|
Example
Query
mutation DeleteEdge(
$lineId: ID!,
$edge: LineEdgeInput!
) {
deleteEdge(
lineId: $lineId,
edge: $edge
) {
from
to
}
}
Variables
{
"lineId": "4",
"edge": LineEdgeInput
}
Response
{
"data": {
"deleteEdge": [
{
"from": "4",
"to": "4"
}
]
}
}
deleteEscalation
Example
Query
mutation DeleteEscalation(
$escalationId: String!,
$actionPlanId: String!
) {
deleteEscalation(
escalationId: $escalationId,
actionPlanId: $actionPlanId
)
}
Variables
{
"escalationId": "abc123",
"actionPlanId": "abc123"
}
Response
{"data": {"deleteEscalation": "xyz789"}}
deleteEventActionConfiguration
Example
Query
mutation DeleteEventActionConfiguration(
$peripheralId: ID!,
$value: String!
) {
deleteEventActionConfiguration(
peripheralId: $peripheralId,
value: $value
)
}
Variables
{
"peripheralId": "4",
"value": "xyz789"
}
Response
{"data": {"deleteEventActionConfiguration": true}}
deleteGroup
deleteHierarchyNode
deleteLearningActivity
Internal use only
Example
Query
mutation DeleteLearningActivity($id: UUID!) {
deleteLearningActivity(id: $id)
}
Variables
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
Response
{
"data": {
"deleteLearningActivity": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
}
deleteLearningRole
Internal use only
deleteLine
Description
Delete an existing line. @iam(key: "Lines.Line.delete")
deleteLineTranslation
Description
Delete an existing line translation (cannot be the main main language). @iam(key: "Lines.Line")
Example
Query
mutation DeleteLineTranslation(
$lineId: ID!,
$languageCode: String!
) {
deleteLineTranslation(
lineId: $lineId,
languageCode: $languageCode
)
}
Variables
{
"lineId": "4",
"languageCode": "xyz789"
}
Response
{"data": {"deleteLineTranslation": true}}
deleteMaintenancePlan
Response
Returns a MaintenancePlan!
Arguments
| Name | Description |
|---|---|
planId - MaintenancePlanId!
|
|
lineId - LineId!
|
Example
Query
mutation DeleteMaintenancePlan(
$planId: MaintenancePlanId!,
$lineId: LineId!
) {
deleteMaintenancePlan(
planId: $planId,
lineId: $lineId
) {
planId
lineId
title
asset
tagPartNumber
instructions
startFrom
trackBy {
time {
...TrackByTimeFragment
}
production {
...TrackByProductionFragment
}
calendar {
...TrackByCalendarFragment
}
}
repeat
version
role {
id
name
}
log {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceLogEntryEdgeFragment
}
nodes {
...MaintenanceLogEntryFragment
}
}
nextWorkOrder {
plan {
...MaintenancePlanFragment
}
dueAt
overdueAt
produced
latestMaintenance {
...MaintenanceLogEntryFragment
}
peripheral {
...PeripheralFragment
}
line {
...LineFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"planId": MaintenancePlanId,
"lineId": LineId
}
Response
{
"data": {
"deleteMaintenancePlan": {
"planId": MaintenancePlanId,
"lineId": LineId,
"title": "abc123",
"asset": "xyz789",
"tagPartNumber": "xyz789",
"instructions": "abc123",
"startFrom": "2007-12-03T10:15:30Z",
"trackBy": TrackByOptions,
"repeat": "YES",
"version": 123,
"role": MaintenanceRole,
"log": MaintenanceLogEntryConnection,
"nextWorkOrder": MaintenanceWorkOrder,
"peripheral": Peripheral,
"line": Line
}
}
}
deleteNode
Description
Delete an existing node and return the line with the node and its edges removed. @iam(key: "Lines.Line")
Response
Returns [LineNode!]!
Example
Query
mutation DeleteNode(
$lineId: ID!,
$nodeId: ID!
) {
deleteNode(
lineId: $lineId,
nodeId: $nodeId
) {
id
type
peripheralId
sensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
}
}
Variables
{"lineId": 4, "nodeId": "4"}
Response
{
"data": {
"deleteNode": [
{
"id": "4",
"type": "Main",
"peripheralId": "4",
"sensor": Sensor
}
]
}
}
deletePackaging
Example
Query
mutation DeletePackaging(
$lineId: ID!,
$packagingId: ID!
) {
deletePackaging(
lineId: $lineId,
packagingId: $packagingId
)
}
Variables
{
"lineId": "4",
"packagingId": "4"
}
Response
{"data": {"deletePackaging": "4"}}
deletePeripheral
deleteProduct
deleteRole
deleteSchedule
Response
Returns a Boolean!
Example
Query
mutation DeleteSchedule(
$lineId: ID!,
$scheduleId: ID!,
$isExceptionalWeek: Boolean
) {
deleteSchedule(
lineId: $lineId,
scheduleId: $scheduleId,
isExceptionalWeek: $isExceptionalWeek
)
}
Variables
{
"lineId": "4",
"scheduleId": "4",
"isExceptionalWeek": false
}
Response
{"data": {"deleteSchedule": true}}
deleteScheduledReportForGroup
Example
Query
mutation DeleteScheduledReportForGroup(
$groupId: ID!,
$id: ID!
) {
deleteScheduledReportForGroup(
groupId: $groupId,
id: $id
)
}
Variables
{
"groupId": "4",
"id": "4"
}
Response
{"data": {"deleteScheduledReportForGroup": 987}}
deleteScheduledReportForLine
Example
Query
mutation DeleteScheduledReportForLine(
$lineId: ID!,
$id: ID!
) {
deleteScheduledReportForLine(
lineId: $lineId,
id: $id
)
}
Variables
{
"lineId": "4",
"id": "4"
}
Response
{"data": {"deleteScheduledReportForLine": 987}}
deleteScheduledReportForSensor
Example
Query
mutation DeleteScheduledReportForSensor(
$peripheralId: ID!,
$id: ID!
) {
deleteScheduledReportForSensor(
peripheralId: $peripheralId,
id: $id
)
}
Variables
{
"peripheralId": "4",
"id": "4"
}
Response
{"data": {"deleteScheduledReportForSensor": 987}}
deleteSkill
Internal use only
deleteStopCause
Response
Returns [StopCauseCategory]
Example
Query
mutation DeleteStopCause(
$deviceOwner: ID,
$peripheralId: ID,
$groupId: ID,
$stopCauseId: ID!
) {
deleteStopCause(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
groupId: $groupId,
stopCauseId: $stopCauseId
) {
_id
id
ownerType
order
name
meta {
name
languageCode
}
languageCode
deleted
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
legacyCategoryId
}
}
Variables
{
"deviceOwner": 4,
"peripheralId": 4,
"groupId": 4,
"stopCauseId": "4"
}
Response
{
"data": {
"deleteStopCause": [
{
"_id": "4",
"id": "4",
"ownerType": "SENSOR",
"order": 987,
"name": "xyz789",
"meta": [StopCauseCategoryMeta],
"languageCode": "xyz789",
"deleted": true,
"stopCauses": [StopCause],
"legacyCategoryId": "4"
}
]
}
}
deleteStopCauseCategory
Response
Returns [StopCauseCategory!]
Example
Query
mutation DeleteStopCauseCategory(
$deviceOwner: ID,
$peripheralId: ID,
$groupId: ID,
$stopCauseCategoryId: ID!
) {
deleteStopCauseCategory(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
groupId: $groupId,
stopCauseCategoryId: $stopCauseCategoryId
) {
_id
id
ownerType
order
name
meta {
name
languageCode
}
languageCode
deleted
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
legacyCategoryId
}
}
Variables
{
"deviceOwner": 4,
"peripheralId": 4,
"groupId": 4,
"stopCauseCategoryId": "4"
}
Response
{
"data": {
"deleteStopCauseCategory": [
{
"_id": 4,
"id": 4,
"ownerType": "SENSOR",
"order": 123,
"name": "xyz789",
"meta": [StopCauseCategoryMeta],
"languageCode": "xyz789",
"deleted": true,
"stopCauses": [StopCause],
"legacyCategoryId": 4
}
]
}
}
deleteTarget
deleteUser
Example
Query
mutation DeleteUser(
$companyId: ID!,
$username: String!
) {
deleteUser(
companyId: $companyId,
username: $username
) {
company {
id
name
groups {
...GroupFragment
}
roles {
...RoleFragment
}
users {
...UserListFragment
}
group {
...GroupFragment
}
appClients {
...AppClientFragment
}
trialStatus {
...TrialStatusFragment
}
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
devices {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
linesPaginated {
items {
...LineFragment
}
nextOffset
total
}
skills {
pageInfo {
...PageInfoFragment
}
edges {
...UserSkillEdgeFragment
}
nodes {
...UserSkillFragment
}
}
learningRoles {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningRoleEdgeFragment
}
nodes {
...UserLearningRoleFragment
}
}
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningActivityEdgeFragment
}
nodes {
...UserLearningActivityFragment
}
}
sessions {
generatedAt
expiresAt
userSub
}
}
}
Variables
{
"companyId": "4",
"username": "xyz789"
}
Response
{
"data": {
"deleteUser": {
"company": Company,
"username": "xyz789",
"enabled": false,
"userStatus": "abc123",
"userCreateDate": "2007-12-03",
"userLastModifiedDate": "2007-12-03",
"sub": "abc123",
"email": "xyz789",
"givenName": "abc123",
"familyName": "xyz789",
"emailVerified": "abc123",
"groups": [Group],
"devices": [Device],
"lines": [Line],
"linesPaginated": LinesPaginated,
"skills": UserSkillConnection,
"learningRoles": UserLearningRoleConnection,
"learningActivities": UserLearningActivityConnection,
"sessions": [Session]
}
}
}
deleteWebhook
Description
Delete a webhook by its ID.
detachCamera
Example
Query
mutation DetachCamera(
$peripheralId: ID!,
$sensorPeripheralId: ID!
) {
detachCamera(
peripheralId: $peripheralId,
sensorPeripheralId: $sensorPeripheralId
) {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
expiration
lastReceived
}
attachedSensors {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
streamURL
device {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
hardwareDevice {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
}
}
Variables
{
"peripheralId": 4,
"sensorPeripheralId": "4"
}
Response
{
"data": {
"detachCamera": {
"_id": 4,
"id": "4",
"name": "abc123",
"index": "4",
"peripheralId": "4",
"owner": "4",
"hardwareId": "4",
"peripheralType": "CAMERA",
"description": "abc123",
"offlineStatus": OfflineStatus,
"attachedSensors": [Sensor],
"streamURL": "xyz789",
"device": Device,
"hardwareDevice": Device
}
}
}
detachControlReceipt
Response
Returns a Product!
Example
Query
mutation DetachControlReceipt(
$lineId: ID!,
$productId: ID!,
$userPoolId: ID,
$controlReceiptId: ID!
) {
detachControlReceipt(
lineId: $lineId,
productId: $productId,
userPoolId: $userPoolId,
controlReceiptId: $controlReceiptId
) {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
packagingId
packagingNumber
lineId
name
unit
comment
}
overwrittenByBatch
parameters {
key
value
alarm {
...AlarmFragment
}
setpoint {
...SetPointFragment
}
}
attachedControlReceipts {
controlReceiptId
userPoolId
name
description
entries {
...ControlReceiptEntryFragment
}
deleted
attachedProducts {
...ProductFragment
}
}
}
}
Variables
{
"lineId": "4",
"productId": "4",
"userPoolId": 4,
"controlReceiptId": 4
}
Response
{
"data": {
"detachControlReceipt": {
"productId": "4",
"name": "abc123",
"itemNumber": "xyz789",
"validatedLineSpeed": 123.45,
"expectedAverageSpeed": 987.65,
"comment": "abc123",
"lineId": "4",
"dataMultiplier": 987.65,
"packaging": Packaging,
"overwrittenByBatch": false,
"parameters": [Parameter],
"attachedControlReceipts": [ControlReceipt]
}
}
}
disableUser
Example
Query
mutation DisableUser(
$companyId: ID!,
$username: String!
) {
disableUser(
companyId: $companyId,
username: $username
) {
sub
username
}
}
Variables
{
"companyId": "4",
"username": "abc123"
}
Response
{
"data": {
"disableUser": {
"sub": "xyz789",
"username": "abc123"
}
}
}
downloadVideoClip
Response
Returns a DownloadVideoClip!
Example
Query
mutation DownloadVideoClip(
$uuid: ID!,
$startTime: Date!,
$endTime: Date
) {
downloadVideoClip(
uuid: $uuid,
startTime: $startTime,
endTime: $endTime
) {
videoClipUrl
}
}
Variables
{
"uuid": 4,
"startTime": "2007-12-03",
"endTime": "2007-12-03"
}
Response
{
"data": {
"downloadVideoClip": {
"videoClipUrl": "xyz789"
}
}
}
editHierarchyDirectory
Use editHierarchyNode instead
Response
Returns a HierarchyNode!
Arguments
| Name | Description |
|---|---|
input - EditHierarchyDirectoryInput!
|
Example
Query
mutation EditHierarchyDirectory($input: EditHierarchyDirectoryInput!) {
editHierarchyDirectory(input: $input) {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
customForms {
...HierarchyNodeCustomFormAttachmentsFragment
}
}
type
descendants {
pageInfo {
...PageInfoFragment
}
edges {
...HierarchyNodeEdgeFragment
}
nodes {
...HierarchyNodeFragment
}
}
ancestors {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{"input": EditHierarchyDirectoryInput}
Response
{
"data": {
"editHierarchyDirectory": {
"id": NodeId,
"version": 123,
"meta": LineNodeMeta,
"attachments": HierarchyNodeAttachments,
"type": "LINE",
"descendants": HierarchyNodeConnection,
"ancestors": [HierarchyNode]
}
}
}
editHierarchyNode
Response
Returns a HierarchyNode!
Arguments
| Name | Description |
|---|---|
input - EditHierarchyNodeInput!
|
Example
Query
mutation EditHierarchyNode($input: EditHierarchyNodeInput!) {
editHierarchyNode(input: $input) {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
customForms {
...HierarchyNodeCustomFormAttachmentsFragment
}
}
type
descendants {
pageInfo {
...PageInfoFragment
}
edges {
...HierarchyNodeEdgeFragment
}
nodes {
...HierarchyNodeFragment
}
}
ancestors {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{"input": EditHierarchyNodeInput}
Response
{
"data": {
"editHierarchyNode": {
"id": NodeId,
"version": 123,
"meta": LineNodeMeta,
"attachments": HierarchyNodeAttachments,
"type": "LINE",
"descendants": HierarchyNodeConnection,
"ancestors": [HierarchyNode]
}
}
}
enableBatchImportKey
Response
Returns an ID!
Example
Query
mutation EnableBatchImportKey {
enableBatchImportKey
}
Response
{"data": {"enableBatchImportKey": 4}}
enableUser
Example
Query
mutation EnableUser(
$companyId: ID!,
$username: String!
) {
enableUser(
companyId: $companyId,
username: $username
) {
sub
username
}
}
Variables
{
"companyId": "4",
"username": "xyz789"
}
Response
{
"data": {
"enableUser": {
"sub": "abc123",
"username": "xyz789"
}
}
}
enrollUserInLearningRole
Internal use only
Response
Returns a UserLearningRole!
Arguments
| Name | Description |
|---|---|
input - EnrollUserInLearningRoleInput!
|
Example
Query
mutation EnrollUserInLearningRole($input: EnrollUserInLearningRoleInput!) {
enrollUserInLearningRole(input: $input) {
id
learningRoleId
userId
title
status
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
expiresAt
completedAt
enrolledBySub
skills {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningRoleSkillsEdgeFragment
}
nodes {
...UserLearningRoleSkillFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
user {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
enrolledBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{"input": EnrollUserInLearningRoleInput}
Response
{
"data": {
"enrollUserInLearningRole": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"learningRoleId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"userId": "4",
"title": "xyz789",
"status": "ENROLLED",
"description": "xyz789",
"nodeId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "xyz789",
"expiresAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"enrolledBySub": "xyz789",
"skills": UserLearningRoleSkillsConnection,
"node": HierarchyNode,
"user": User,
"createdBy": User,
"updatedBy": User,
"enrolledBy": User
}
}
}
enrollUserInSkill
Internal use only
Response
Returns a UserSkill!
Arguments
| Name | Description |
|---|---|
input - EnrollUserInSkillInput!
|
Example
Query
mutation EnrollUserInSkill($input: EnrollUserInSkillInput!) {
enrollUserInSkill(input: $input) {
id
skillId
userId
title
status
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
expiresAt
completedAt
enrolledBySub
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...UserSkillLearningActivitiesEdgeFragment
}
nodes {
...UserSkillLearningActivityFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
enrolledBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{"input": EnrollUserInSkillInput}
Response
{
"data": {
"enrollUserInSkill": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"skillId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"userId": "4",
"title": "xyz789",
"status": "ENROLLED",
"description": "abc123",
"nodeId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "xyz789",
"expiresAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"enrolledBySub": "abc123",
"learningActivities": UserSkillLearningActivitiesConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User,
"enrolledBy": User
}
}
}
escalateActionPlan
Response
Returns an Escalation!
Example
Query
mutation EscalateActionPlan(
$id: String!,
$toNode: String!,
$assignedSub: String,
$sendNotification: Boolean
) {
escalateActionPlan(
id: $id,
toNode: $toNode,
assignedSub: $assignedSub,
sendNotification: $sendNotification
) {
nodeId
creationDate
createdBySub
assignedToSub
priority
version
plan {
state
title
pdcaState
followUpInterval
followUpState
dueDate
linkedProductionData
version
category {
...ActionPlanCategoryFragment
}
content {
...ActionPlanContentFragment
}
escalations {
...EscalationFragment
}
attachedFiles
tasks {
...ActionPlanTaskFragment
}
id
}
id
assignedTo {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{
"id": "abc123",
"toNode": "abc123",
"assignedSub": "xyz789",
"sendNotification": false
}
Response
{
"data": {
"escalateActionPlan": {
"nodeId": "abc123",
"creationDate": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"assignedToSub": "abc123",
"priority": true,
"version": 123,
"plan": ActionPlan,
"id": "abc123",
"assignedTo": User,
"createdBy": User,
"node": HierarchyNode
}
}
}
forgetWiFi
Description
Forget a WiFi configuration of the specified device.
`uuid' is deprecated and used to represent the allocated software identifier.
`id' refers to the hardware identifier of the device.
generateAPIToken
Description
Generate an API token for the user as specified from the input.
Response
Returns a GeneratedAPIToken!
Arguments
| Name | Description |
|---|---|
input - GenerateAPITokenInput!
|
Example
Query
mutation GenerateAPIToken($input: GenerateAPITokenInput!) {
generateAPIToken(input: $input) {
token
name
description
generatedAt
expiration
isActive
userSub
}
}
Variables
{"input": GenerateAPITokenInput}
Response
{
"data": {
"generateAPIToken": {
"token": "abc123",
"name": "abc123",
"description": "abc123",
"generatedAt": "2007-12-03",
"expiration": 123.45,
"isActive": false,
"userSub": "4"
}
}
}
ignorePendingGoldenBatch
Internal use only
Description
Ignore a pending golden batch. The batch will not be proposed as a golden batch again.
importStopCauseCategories
Example
Query
mutation ImportStopCauseCategories(
$peripheralId: ID!,
$objectKey: String
) {
importStopCauseCategories(
peripheralId: $peripheralId,
objectKey: $objectKey
)
}
Variables
{"peripheralId": 4, "objectKey": "xyz789"}
Response
{"data": {"importStopCauseCategories": false}}
initializeHierarchy
Response
Returns a HierarchyNode!
Arguments
| Name | Description |
|---|---|
input - InitializeHierarchyInput!
|
Example
Query
mutation InitializeHierarchy($input: InitializeHierarchyInput!) {
initializeHierarchy(input: $input) {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
customForms {
...HierarchyNodeCustomFormAttachmentsFragment
}
}
type
descendants {
pageInfo {
...PageInfoFragment
}
edges {
...HierarchyNodeEdgeFragment
}
nodes {
...HierarchyNodeFragment
}
}
ancestors {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{"input": InitializeHierarchyInput}
Response
{
"data": {
"initializeHierarchy": {
"id": NodeId,
"version": 987,
"meta": LineNodeMeta,
"attachments": HierarchyNodeAttachments,
"type": "LINE",
"descendants": HierarchyNodeConnection,
"ancestors": [HierarchyNode]
}
}
}
invalidateSession
Description
Invalidates a session.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - InvalidateSessionInput!
|
Example
Query
mutation InvalidateSession($input: InvalidateSessionInput!) {
invalidateSession(input: $input)
}
Variables
{"input": InvalidateSessionInput}
Response
{"data": {"invalidateSession": true}}
invalidateUserSession
Description
Invalidates a session of a specific user.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - InvalidateUserSessionInput!
|
Example
Query
mutation InvalidateUserSession($input: InvalidateUserSessionInput!) {
invalidateUserSession(input: $input)
}
Variables
{"input": InvalidateUserSessionInput}
Response
{"data": {"invalidateUserSession": false}}
issueCertificate
Response
Returns an IssuedCertificate!
Arguments
| Name | Description |
|---|---|
input - IssueCertificateInput!
|
Example
Query
mutation IssueCertificate($input: IssueCertificateInput!) {
issueCertificate(input: $input) {
url
certificate {
id
isActive
createdAt
validAt
expiresAt
subject
issuer
}
}
}
Variables
{"input": IssueCertificateInput}
Response
{
"data": {
"issueCertificate": {
"url": "xyz789",
"certificate": Certificate
}
}
}
manuallyTriggerBatchControl
Response
Returns a BatchControl!
Example
Query
mutation ManuallyTriggerBatchControl(
$lineId: ID!,
$batchId: ID!,
$controlId: ID!,
$controlReceiptId: ID!
) {
manuallyTriggerBatchControl(
lineId: $lineId,
batchId: $batchId,
controlId: $controlId,
controlReceiptId: $controlReceiptId
) {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
controlReceiptField {
...ControlReceiptEntryFieldFragment
}
value
}
followUp {
enabled
delayMs
}
history {
comment
fieldValues {
...BatchControlFieldValueFragment
}
initials
status
timeControlUpdated
timeControlled
}
initials
initialsSettings
originalControl {
controlId
timeTriggered
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
type
payload {
...TimedTriggerPayloadFragment
}
delayWhenStopped
}
}
}
Variables
{
"lineId": "4",
"batchId": "4",
"controlId": 4,
"controlReceiptId": "4"
}
Response
{
"data": {
"manuallyTriggerBatchControl": {
"batchControlId": "4",
"batchId": 4,
"comment": "abc123",
"controlReceiptId": 4,
"controlReceiptName": "xyz789",
"entryId": "4",
"fieldValues": [BatchControlFieldValue],
"followUp": FollowUpSettings,
"history": [BatchControlHistory],
"initials": "xyz789",
"initialsSettings": "REQUIRED_IF_OUTSIDE_LIMITS",
"originalControl": OriginalControlDetails,
"status": "CANCELED",
"timeControlUpdated": "2007-12-03",
"timeControlled": "2007-12-03",
"timeTriggered": "2007-12-03",
"title": "xyz789",
"trigger": ControlTrigger
}
}
}
modifyStopCause
Response
Returns [StopCauseCategory!]
Arguments
| Name | Description |
|---|---|
deviceOwner - ID
|
|
peripheralId - ID
|
|
groupId - ID
|
|
stopCauseId - ID!
|
|
languageCode - String
|
|
newName - String
|
|
newDescription - String
|
|
newMeta - [StopCauseMetaInput!]
|
|
newRequireInitials - Boolean
|
|
newRequireComment - Boolean
|
|
newStopType - StopType
|
|
newStopCauseCategory - NewStopCauseCategory
|
|
newTargetSetup - TargetSetupInput
|
|
newEnableCountermeasure - Boolean
|
Example
Query
mutation ModifyStopCause(
$deviceOwner: ID,
$peripheralId: ID,
$groupId: ID,
$stopCauseId: ID!,
$languageCode: String,
$newName: String,
$newDescription: String,
$newMeta: [StopCauseMetaInput!],
$newRequireInitials: Boolean,
$newRequireComment: Boolean,
$newStopType: StopType,
$newStopCauseCategory: NewStopCauseCategory,
$newTargetSetup: TargetSetupInput,
$newEnableCountermeasure: Boolean
) {
modifyStopCause(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
groupId: $groupId,
stopCauseId: $stopCauseId,
languageCode: $languageCode,
newName: $newName,
newDescription: $newDescription,
newMeta: $newMeta,
newRequireInitials: $newRequireInitials,
newRequireComment: $newRequireComment,
newStopType: $newStopType,
newStopCauseCategory: $newStopCauseCategory,
newTargetSetup: $newTargetSetup,
newEnableCountermeasure: $newEnableCountermeasure
) {
_id
id
ownerType
order
name
meta {
name
languageCode
}
languageCode
deleted
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
legacyCategoryId
}
}
Variables
{
"deviceOwner": 4,
"peripheralId": "4",
"groupId": "4",
"stopCauseId": "4",
"languageCode": "abc123",
"newName": "abc123",
"newDescription": "xyz789",
"newMeta": [StopCauseMetaInput],
"newRequireInitials": true,
"newRequireComment": false,
"newStopType": "NO_ACT",
"newStopCauseCategory": NewStopCauseCategory,
"newTargetSetup": TargetSetupInput,
"newEnableCountermeasure": true
}
Response
{
"data": {
"modifyStopCause": [
{
"_id": 4,
"id": "4",
"ownerType": "SENSOR",
"order": 123,
"name": "abc123",
"meta": [StopCauseCategoryMeta],
"languageCode": "abc123",
"deleted": true,
"stopCauses": [StopCause],
"legacyCategoryId": "4"
}
]
}
}
modifyStopCauseCategory
Response
Returns [StopCauseCategory!]
Example
Query
mutation ModifyStopCauseCategory(
$deviceOwner: ID,
$peripheralId: ID,
$groupId: ID,
$stopCauseCategoryId: ID!,
$languageCode: String,
$newName: String,
$newMeta: [StopCauseCategoryMetaInput!]
) {
modifyStopCauseCategory(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
groupId: $groupId,
stopCauseCategoryId: $stopCauseCategoryId,
languageCode: $languageCode,
newName: $newName,
newMeta: $newMeta
) {
_id
id
ownerType
order
name
meta {
name
languageCode
}
languageCode
deleted
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
legacyCategoryId
}
}
Variables
{
"deviceOwner": 4,
"peripheralId": "4",
"groupId": "4",
"stopCauseCategoryId": "4",
"languageCode": "abc123",
"newName": "xyz789",
"newMeta": [StopCauseCategoryMetaInput]
}
Response
{
"data": {
"modifyStopCauseCategory": [
{
"_id": 4,
"id": 4,
"ownerType": "SENSOR",
"order": 123,
"name": "abc123",
"meta": [StopCauseCategoryMeta],
"languageCode": "xyz789",
"deleted": false,
"stopCauses": [StopCause],
"legacyCategoryId": 4
}
]
}
}
moveHierarchyNode
Response
Returns a HierarchyNode!
Example
Query
mutation MoveHierarchyNode(
$nodeId: NodeId!,
$newParentId: NodeId!
) {
moveHierarchyNode(
nodeId: $nodeId,
newParentId: $newParentId
) {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
customForms {
...HierarchyNodeCustomFormAttachmentsFragment
}
}
type
descendants {
pageInfo {
...PageInfoFragment
}
edges {
...HierarchyNodeEdgeFragment
}
nodes {
...HierarchyNodeFragment
}
}
ancestors {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{
"nodeId": NodeId,
"newParentId": NodeId
}
Response
{
"data": {
"moveHierarchyNode": {
"id": NodeId,
"version": 987,
"meta": LineNodeMeta,
"attachments": HierarchyNodeAttachments,
"type": "LINE",
"descendants": HierarchyNodeConnection,
"ancestors": [HierarchyNode]
}
}
}
processCompletedBatch
Internal use only
Description
Process a completed batch, saving it as a pending golden batch if 1) there is no current golden batch, or 2) it scores higher than the current golden batch. Returns the completed batch if it was saved.
Response
Returns a GoldenBatch
Example
Query
mutation ProcessCompletedBatch(
$lineId: ID!,
$productId: ID!,
$completedBatchId: ID!
) {
processCompletedBatch(
lineId: $lineId,
productId: $productId,
completedBatchId: $completedBatchId
) {
batchId
lineId
productId
oee1
state
acceptedAt
}
}
Variables
{
"lineId": "4",
"productId": 4,
"completedBatchId": 4
}
Response
{
"data": {
"processCompletedBatch": {
"batchId": 4,
"lineId": "4",
"productId": "4",
"oee1": 987.65,
"state": "xyz789",
"acceptedAt": "2007-12-03T10:15:30Z"
}
}
}
promoteNodeToMain
Description
Promote an existing node to be the main. If oldMainType is not specified, it will default to 'Counter'. @iam(key: "Lines.Line")
Response
Returns [LineNode!]!
Example
Query
mutation PromoteNodeToMain(
$lineId: ID!,
$nodeId: ID!,
$oldMainType: NodeType
) {
promoteNodeToMain(
lineId: $lineId,
nodeId: $nodeId,
oldMainType: $oldMainType
) {
id
type
peripheralId
sensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
}
}
Variables
{
"lineId": 4,
"nodeId": "4",
"oldMainType": "Main"
}
Response
{
"data": {
"promoteNodeToMain": [
{
"id": "4",
"type": "Main",
"peripheralId": 4,
"sensor": Sensor
}
]
}
}
publishData
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - PublishDataInput!
|
Example
Query
mutation PublishData($input: PublishDataInput!) {
publishData(input: $input)
}
Variables
{"input": PublishDataInput}
Response
{"data": {"publishData": false}}
registerStop
Response
Returns [Stop!]!
Arguments
| Name | Description |
|---|---|
deviceOwner - ID
|
|
peripheralId - ID!
|
|
time - [Time!]!
|
|
stopCauseId - ID
|
|
comment - String
|
|
initials - String
|
|
target - TargetInput
|
|
standalone - StandaloneConfigurationInput
|
|
countermeasure - String
|
|
countermeasureInitials - String
|
Example
Query
mutation RegisterStop(
$deviceOwner: ID,
$peripheralId: ID!,
$time: [Time!]!,
$stopCauseId: ID,
$comment: String,
$initials: String,
$target: TargetInput,
$standalone: StandaloneConfigurationInput,
$countermeasure: String,
$countermeasureInitials: String
) {
registerStop(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
time: $time,
stopCauseId: $stopCauseId,
comment: $comment,
initials: $initials,
target: $target,
standalone: $standalone,
countermeasure: $countermeasure,
countermeasureInitials: $countermeasureInitials
) {
_id
timeRange {
from
to
}
originalStart
ongoing
duration
stopCause {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
comment
initials
registeredTime
isMicroStop
isAutomaticRegistration
standalone {
excludeProduction
}
target {
previousBatch
nextBatch
currentShift
target
}
countermeasure
countermeasureInitials
}
}
Variables
{
"deviceOwner": 4,
"peripheralId": "4",
"time": [Time],
"stopCauseId": "4",
"comment": "abc123",
"initials": "abc123",
"target": TargetInput,
"standalone": StandaloneConfigurationInput,
"countermeasure": "abc123",
"countermeasureInitials": "abc123"
}
Response
{
"data": {
"registerStop": [
{
"_id": 4,
"timeRange": TimeRange,
"originalStart": "2007-12-03",
"ongoing": true,
"duration": 987.65,
"stopCause": StopCause,
"comment": "xyz789",
"initials": "abc123",
"registeredTime": "2007-12-03",
"isMicroStop": false,
"isAutomaticRegistration": true,
"standalone": StandaloneConfiguration,
"target": Target,
"countermeasure": "abc123",
"countermeasureInitials": "xyz789"
}
]
}
}
removeAppClientFromGroups
Example
Query
mutation RemoveAppClientFromGroups(
$id: ID!,
$groupIds: [ID!]!
) {
removeAppClientFromGroups(
id: $id,
groupIds: $groupIds
) {
id
name
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
}
}
Variables
{
"id": "4",
"groupIds": ["4"]
}
Response
{
"data": {
"removeAppClientFromGroups": {
"id": 4,
"name": "abc123",
"groups": [Group]
}
}
}
removeHorizontalAnnotation
Response
Returns a Boolean!
Example
Query
mutation RemoveHorizontalAnnotation(
$peripheralId: ID!,
$horizontalAnnotationId: ID!
) {
removeHorizontalAnnotation(
peripheralId: $peripheralId,
horizontalAnnotationId: $horizontalAnnotationId
)
}
Variables
{"peripheralId": 4, "horizontalAnnotationId": 4}
Response
{"data": {"removeHorizontalAnnotation": false}}
removeLineFromGroups
Example
Query
mutation RemoveLineFromGroups(
$companyId: ID!,
$lineId: ID!,
$groupIds: [ID!]!
) {
removeLineFromGroups(
companyId: $companyId,
lineId: $lineId,
groupIds: $groupIds
)
}
Variables
{
"companyId": "4",
"lineId": 4,
"groupIds": ["4"]
}
Response
{"data": {"removeLineFromGroups": "4"}}
removePeripheralFromGroups
Response
Returns an ID
Example
Query
mutation RemovePeripheralFromGroups(
$companyId: ID!,
$peripheralId: ID!,
$groupIds: [ID!]!
) {
removePeripheralFromGroups(
companyId: $companyId,
peripheralId: $peripheralId,
groupIds: $groupIds
)
}
Variables
{
"companyId": "4",
"peripheralId": 4,
"groupIds": ["4"]
}
Response
{
"data": {
"removePeripheralFromGroups": "4"
}
}
removeUserFromGroups
Example
Query
mutation RemoveUserFromGroups(
$companyId: ID!,
$userId: ID!,
$groupIds: [ID!]!
) {
removeUserFromGroups(
companyId: $companyId,
userId: $userId,
groupIds: $groupIds
) {
company {
id
name
groups {
...GroupFragment
}
roles {
...RoleFragment
}
users {
...UserListFragment
}
group {
...GroupFragment
}
appClients {
...AppClientFragment
}
trialStatus {
...TrialStatusFragment
}
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
devices {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
linesPaginated {
items {
...LineFragment
}
nextOffset
total
}
skills {
pageInfo {
...PageInfoFragment
}
edges {
...UserSkillEdgeFragment
}
nodes {
...UserSkillFragment
}
}
learningRoles {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningRoleEdgeFragment
}
nodes {
...UserLearningRoleFragment
}
}
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningActivityEdgeFragment
}
nodes {
...UserLearningActivityFragment
}
}
sessions {
generatedAt
expiresAt
userSub
}
}
}
Variables
{
"companyId": "4",
"userId": "4",
"groupIds": ["4"]
}
Response
{
"data": {
"removeUserFromGroups": {
"company": Company,
"username": "abc123",
"enabled": false,
"userStatus": "abc123",
"userCreateDate": "2007-12-03",
"userLastModifiedDate": "2007-12-03",
"sub": "xyz789",
"email": "abc123",
"givenName": "abc123",
"familyName": "xyz789",
"emailVerified": "xyz789",
"groups": [Group],
"devices": [Device],
"lines": [Line],
"linesPaginated": LinesPaginated,
"skills": UserSkillConnection,
"learningRoles": UserLearningRoleConnection,
"learningActivities": UserLearningActivityConnection,
"sessions": [Session]
}
}
}
removeVerticalAnnotation
Response
Returns a Boolean!
Example
Query
mutation RemoveVerticalAnnotation(
$peripheralId: ID!,
$timestamp: Date,
$verticalAnnotationId: ID!
) {
removeVerticalAnnotation(
peripheralId: $peripheralId,
timestamp: $timestamp,
verticalAnnotationId: $verticalAnnotationId
)
}
Variables
{
"peripheralId": "4",
"timestamp": "2007-12-03",
"verticalAnnotationId": "4"
}
Response
{"data": {"removeVerticalAnnotation": true}}
replaceDevice
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - ReplaceDeviceInput!
|
Example
Query
mutation ReplaceDevice($input: ReplaceDeviceInput!) {
replaceDevice(input: $input)
}
Variables
{"input": ReplaceDeviceInput}
Response
{"data": {"replaceDevice": false}}
replacePeripherals
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - ReplacePeripheralsInput!
|
Example
Query
mutation ReplacePeripherals($input: ReplacePeripheralsInput!) {
replacePeripherals(input: $input)
}
Variables
{"input": ReplacePeripheralsInput}
Response
{"data": {"replacePeripherals": true}}
resetUserPassword
Example
Query
mutation ResetUserPassword(
$companyId: ID!,
$username: String!
) {
resetUserPassword(
companyId: $companyId,
username: $username
) {
sub
username
}
}
Variables
{"companyId": 4, "username": "abc123"}
Response
{
"data": {
"resetUserPassword": {
"sub": "xyz789",
"username": "xyz789"
}
}
}
respondAssistantConversationAsync
Internal use only
Description
Add a human response to an AI assistant conversation Use assistant_conversation to get updates on the conversation.
Response
Returns an AssistantConversation!
Arguments
| Name | Description |
|---|---|
conversationId - UUID!
|
|
text - String!
|
|
messageContext - MessageContext
|
|
timeZone - String
|
Example
Query
mutation RespondAssistantConversationAsync(
$conversationId: UUID!,
$text: String!,
$messageContext: MessageContext,
$timeZone: String
) {
respondAssistantConversationAsync(
conversationId: $conversationId,
text: $text,
messageContext: $messageContext,
timeZone: $timeZone
) {
id
messages {
role
messageId
status
content {
... on ConversationContentText {
...ConversationContentTextFragment
}
... on ConversationContentVisualizationOptions {
...ConversationContentVisualizationOptionsFragment
}
}
}
}
}
Variables
{
"conversationId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"text": "xyz789",
"messageContext": MessageContext,
"timeZone": "abc123"
}
Response
{
"data": {
"respondAssistantConversationAsync": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"messages": [ConversationMessage]
}
}
}
revokeAPIToken
Description
Revoke a specific API token if permitted to do so.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - RevokeAPITokenInput!
|
Example
Query
mutation RevokeAPIToken($input: RevokeAPITokenInput!) {
revokeAPIToken(input: $input)
}
Variables
{"input": RevokeAPITokenInput}
Response
{"data": {"revokeAPIToken": true}}
sendActionPlansReminder
Response
Returns an ActionPlansSentReminderResponse!
Arguments
| Name | Description |
|---|---|
escalationId - String!
|
Example
Query
mutation SendActionPlansReminder($escalationId: String!) {
sendActionPlansReminder(escalationId: $escalationId) {
email
}
}
Variables
{"escalationId": "abc123"}
Response
{
"data": {
"sendActionPlansReminder": {
"email": "abc123"
}
}
}
setStopCauseCategoryOrder
Response
Returns [StopCauseCategory!]
Example
Query
mutation SetStopCauseCategoryOrder(
$deviceOwner: ID,
$peripheralId: ID,
$groupId: ID,
$stopCauseCategoryIdsInOrder: [ID!]!
) {
setStopCauseCategoryOrder(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
groupId: $groupId,
stopCauseCategoryIdsInOrder: $stopCauseCategoryIdsInOrder
) {
_id
id
ownerType
order
name
meta {
name
languageCode
}
languageCode
deleted
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
legacyCategoryId
}
}
Variables
{
"deviceOwner": "4",
"peripheralId": 4,
"groupId": 4,
"stopCauseCategoryIdsInOrder": [4]
}
Response
{
"data": {
"setStopCauseCategoryOrder": [
{
"_id": 4,
"id": "4",
"ownerType": "SENSOR",
"order": 987,
"name": "xyz789",
"meta": [StopCauseCategoryMeta],
"languageCode": "abc123",
"deleted": true,
"stopCauses": [StopCause],
"legacyCategoryId": "4"
}
]
}
}
setStopCauseOrder
Response
Returns [StopCauseCategory!]
Example
Query
mutation SetStopCauseOrder(
$deviceOwner: ID,
$peripheralId: ID,
$groupId: ID,
$stopCauseCategoryId: ID!,
$stopCauseIdsInOrder: [ID!]!
) {
setStopCauseOrder(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
groupId: $groupId,
stopCauseCategoryId: $stopCauseCategoryId,
stopCauseIdsInOrder: $stopCauseIdsInOrder
) {
_id
id
ownerType
order
name
meta {
name
languageCode
}
languageCode
deleted
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
legacyCategoryId
}
}
Variables
{
"deviceOwner": "4",
"peripheralId": "4",
"groupId": "4",
"stopCauseCategoryId": 4,
"stopCauseIdsInOrder": ["4"]
}
Response
{
"data": {
"setStopCauseOrder": [
{
"_id": 4,
"id": "4",
"ownerType": "SENSOR",
"order": 987,
"name": "abc123",
"meta": [StopCauseCategoryMeta],
"languageCode": "abc123",
"deleted": false,
"stopCauses": [StopCause],
"legacyCategoryId": 4
}
]
}
}
skipAllPendingActivities
Internal use only
snoozeAlarm
Example
Query
mutation SnoozeAlarm(
$peripheralId: ID!,
$alarmId: ID!
) {
snoozeAlarm(
peripheralId: $peripheralId,
alarmId: $alarmId
)
}
Variables
{"peripheralId": 4, "alarmId": 4}
Response
{"data": {"snoozeAlarm": 123}}
startBatchByBatchNumber
Description
Start a batch by its batch number and optionally set the time and forcefully stop a batch if one is running already.
Response
Returns a Batch!
Arguments
| Name | Description |
|---|---|
input - StartBatchByBatchNumberInput!
|
Example
Query
mutation StartBatchByBatchNumber($input: StartBatchByBatchNumberInput!) {
startBatchByBatchNumber(input: $input) {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
...PackagingFragment
}
overwrittenByBatch
parameters {
...ParameterFragment
}
attachedControlReceipts {
...ControlReceiptFragment
}
}
sorting
state
tags
controls {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
...BatchControlFieldValueFragment
}
followUp {
...FollowUpSettingsFragment
}
history {
...BatchControlHistoryFragment
}
initials
initialsSettings
originalControl {
...OriginalControlDetailsFragment
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
...ControlTriggerFragment
}
}
samples {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
stops {
_id
timeRange {
...TimeRangeFragment
}
originalStart
ongoing
duration
stopCause {
...StopCauseFragment
}
comment
initials
registeredTime
isMicroStop
isAutomaticRegistration
standalone {
...StandaloneConfigurationFragment
}
target {
...TargetFragment
}
countermeasure
countermeasureInitials
}
stopStats {
longestNonStop
lastStop {
...StopFragment
}
stopCauseStats {
...StopCauseStatFragment
}
}
stats {
timeRange {
...TimeRangeFragment
}
data {
...DataFragment
}
}
scrap {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
plannedEtc
actualEtc
}
}
Variables
{"input": StartBatchByBatchNumberInput}
Response
{
"data": {
"startBatchByBatchNumber": {
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 123.45,
"batchId": 4,
"batchNumber": "xyz789",
"comment": "xyz789",
"lineId": 4,
"manualScrap": 123.45,
"plannedStart": "2007-12-03",
"produced": 987.65,
"product": Product,
"sorting": "abc123",
"state": "COMPLETED",
"tags": ["abc123"],
"controls": [BatchControl],
"samples": [Sample],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat,
"scrap": [Sample],
"createdBy": User,
"line": Line,
"plannedEtc": "2007-12-03",
"actualEtc": "2007-12-03"
}
}
}
stopBatchByBatchNumber
Description
Stop a batch by its batch number
Response
Returns a Batch!
Arguments
| Name | Description |
|---|---|
input - StopBatchByBatchNumberInput!
|
Example
Query
mutation StopBatchByBatchNumber($input: StopBatchByBatchNumberInput!) {
stopBatchByBatchNumber(input: $input) {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
...PackagingFragment
}
overwrittenByBatch
parameters {
...ParameterFragment
}
attachedControlReceipts {
...ControlReceiptFragment
}
}
sorting
state
tags
controls {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
...BatchControlFieldValueFragment
}
followUp {
...FollowUpSettingsFragment
}
history {
...BatchControlHistoryFragment
}
initials
initialsSettings
originalControl {
...OriginalControlDetailsFragment
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
...ControlTriggerFragment
}
}
samples {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
stops {
_id
timeRange {
...TimeRangeFragment
}
originalStart
ongoing
duration
stopCause {
...StopCauseFragment
}
comment
initials
registeredTime
isMicroStop
isAutomaticRegistration
standalone {
...StandaloneConfigurationFragment
}
target {
...TargetFragment
}
countermeasure
countermeasureInitials
}
stopStats {
longestNonStop
lastStop {
...StopFragment
}
stopCauseStats {
...StopCauseStatFragment
}
}
stats {
timeRange {
...TimeRangeFragment
}
data {
...DataFragment
}
}
scrap {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
plannedEtc
actualEtc
}
}
Variables
{"input": StopBatchByBatchNumberInput}
Response
{
"data": {
"stopBatchByBatchNumber": {
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 123.45,
"batchId": 4,
"batchNumber": "xyz789",
"comment": "abc123",
"lineId": 4,
"manualScrap": 987.65,
"plannedStart": "2007-12-03",
"produced": 987.65,
"product": Product,
"sorting": "xyz789",
"state": "COMPLETED",
"tags": ["xyz789"],
"controls": [BatchControl],
"samples": [Sample],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat,
"scrap": [Sample],
"createdBy": User,
"line": Line,
"plannedEtc": "2007-12-03",
"actualEtc": "2007-12-03"
}
}
}
subscribeToWebPush
Description
Subscribes the current user to web push notifications
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
subscription - WebPushSubscription!
|
Example
Query
mutation SubscribeToWebPush($subscription: WebPushSubscription!) {
subscribeToWebPush(subscription: $subscription)
}
Variables
{"subscription": WebPushSubscription}
Response
{"data": {"subscribeToWebPush": true}}
swapPeripherals
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - SwapPeripheralsInput!
|
Example
Query
mutation SwapPeripherals($input: SwapPeripheralsInput!) {
swapPeripherals(input: $input)
}
Variables
{"input": SwapPeripheralsInput}
Response
{"data": {"swapPeripherals": true}}
translateAlarm
Response
Returns an Alarm!
Example
Query
mutation TranslateAlarm(
$peripheralId: ID!,
$alarmId: ID!,
$name: String!,
$description: String!,
$languageCode: String!
) {
translateAlarm(
peripheralId: $peripheralId,
alarmId: $alarmId,
name: $name,
description: $description,
languageCode: $languageCode
) {
id
name
description
peripheralId
status
threshold
repeatNotification
enabled
type
alarmConfiguration {
x
t
y
n
stopType
}
languageCode
snoozeDuration
alarmLogs {
lastEvaluatedKey {
...AlarmLogLastEvaluatedKeyFragment
}
entries {
...AlarmLogFragment
}
}
subscribers {
type
languageCode
value
}
timeRange {
from
to
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
}
}
Variables
{
"peripheralId": "4",
"alarmId": "4",
"name": "xyz789",
"description": "xyz789",
"languageCode": "xyz789"
}
Response
{
"data": {
"translateAlarm": {
"id": 4,
"name": "abc123",
"description": "xyz789",
"peripheralId": 4,
"status": "NORMAL",
"threshold": 123,
"repeatNotification": true,
"enabled": false,
"type": "AboveX",
"alarmConfiguration": AlarmConfiguration,
"languageCode": "xyz789",
"snoozeDuration": 123,
"alarmLogs": AlarmLogs,
"subscribers": [SubscriberOutput],
"timeRange": TimeRange,
"peripheral": Peripheral
}
}
}
translateLine
Description
Translate an existing line to a new language. @iam(key: "Lines.Line")
Response
Returns a Line!
Example
Query
mutation TranslateLine(
$lineId: ID!,
$name: String!,
$description: String!,
$languageCode: String!
) {
translateLine(
lineId: $lineId,
name: $name,
description: $description,
languageCode: $languageCode
) {
id
languageCode
owner
location {
timeZone
}
name
description
mainPeripheralId
nodes {
id
type
peripheralId
sensor {
...SensorFragment
}
}
edges {
from
to
}
settings {
oee {
...LineOEESettingsFragment
}
batch {
...LineBatchSettingsFragment
}
}
goldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
bestPendingGoldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
time {
configs {
...SensorConfigFragment
}
alarmLogs {
...AlarmLogsFragment
}
batches {
...BatchListFragment
}
dataOverrides {
...DataOverrideFragment
}
pendingControls {
...BatchControlListFragment
}
samples {
...SampleFragment
}
scrap {
...SampleFragment
}
shifts {
...ShiftInstanceFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
changeoverStops {
...ChangeoverStopFragment
}
_id
timeRange {
...TimeRangeFragment
}
}
products {
nextToken
items {
...ProductFragment
}
}
packagings {
nextToken
items {
...PackagingFragment
}
}
batches {
count
items {
...BatchFragment
}
nextToken
pages
}
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
schedule {
id
lineId
validFrom {
...ScheduleTimeFragment
}
validTo {
...ScheduleTimeFragment
}
shifts {
...ShiftFragment
}
weeklyTargets {
...TargetsFragment
}
configuration {
...ScheduleConfigurationFragment
}
isExceptionalWeek
isFallbackSchedule
}
mainSensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
andonSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
nextShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
scheduledEnd
previousShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
maintenanceWorkOrders {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceWorkOrderEdgeFragment
}
nodes {
...MaintenanceWorkOrderFragment
}
}
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
}
}
Variables
{
"lineId": 4,
"name": "xyz789",
"description": "abc123",
"languageCode": "abc123"
}
Response
{
"data": {
"translateLine": {
"id": 4,
"languageCode": "abc123",
"owner": 4,
"location": Location,
"name": "xyz789",
"description": "abc123",
"mainPeripheralId": "4",
"nodes": [LineNode],
"edges": [LineEdge],
"settings": LineSettings,
"goldenBatch": GoldenBatch,
"bestPendingGoldenBatch": GoldenBatch,
"time": [LineTimeData],
"products": ProductList,
"packagings": PackagingList,
"batches": BatchList,
"batch": Batch,
"schedule": Schedule,
"mainSensor": Sensor,
"scheduledReports": [ScheduledReport],
"andonSchedules": [AndonSchedule],
"nextShift": ShiftInstance,
"scheduledEnd": "2007-12-03",
"previousShift": ShiftInstance,
"maintenanceWorkOrders": MaintenanceWorkOrderConnection,
"groups": [Group]
}
}
}
updateActionPlan
Response
Returns an ActionPlan!
Arguments
| Name | Description |
|---|---|
input - UpdateActionPlanInput!
|
Example
Query
mutation UpdateActionPlan($input: UpdateActionPlanInput!) {
updateActionPlan(input: $input) {
state
title
pdcaState
followUpInterval
followUpState
dueDate
linkedProductionData
version
category {
id
meta {
...ActionPlanCategoryMetaFragment
}
color
version
nodeId
}
content {
column
content
}
escalations {
nodeId
creationDate
createdBySub
assignedToSub
priority
version
plan {
...ActionPlanFragment
}
id
assignedTo {
...UserFragment
}
createdBy {
...UserFragment
}
node {
...HierarchyNodeFragment
}
}
attachedFiles
tasks {
content
checked
version
plan {
...ActionPlanFragment
}
id
}
id
}
}
Variables
{"input": UpdateActionPlanInput}
Response
{
"data": {
"updateActionPlan": {
"state": "OPEN",
"title": "xyz789",
"pdcaState": "PLAN",
"followUpInterval": "DAILY",
"followUpState": 987,
"dueDate": "2007-12-03T10:15:30Z",
"linkedProductionData": ["abc123"],
"version": 987,
"category": ActionPlanCategory,
"content": [ActionPlanContent],
"escalations": [Escalation],
"attachedFiles": ["abc123"],
"tasks": [ActionPlanTask],
"id": "abc123"
}
}
}
updateActionPlanTask
Response
Returns an ActionPlanTask!
Arguments
| Name | Description |
|---|---|
input - UpdateActionPlanTaskInput!
|
Example
Query
mutation UpdateActionPlanTask($input: UpdateActionPlanTaskInput!) {
updateActionPlanTask(input: $input) {
content
checked
version
plan {
state
title
pdcaState
followUpInterval
followUpState
dueDate
linkedProductionData
version
category {
...ActionPlanCategoryFragment
}
content {
...ActionPlanContentFragment
}
escalations {
...EscalationFragment
}
attachedFiles
tasks {
...ActionPlanTaskFragment
}
id
}
id
}
}
Variables
{"input": UpdateActionPlanTaskInput}
Response
{
"data": {
"updateActionPlanTask": {
"content": "abc123",
"checked": true,
"version": 987,
"plan": ActionPlan,
"id": "xyz789"
}
}
}
updateActivity
Internal use only
Response
Returns an Activity!
Arguments
| Name | Description |
|---|---|
id - ActivityId!
|
|
input - UpdateActivityInput!
|
|
version - Int!
|
Example
Query
mutation UpdateActivity(
$id: ActivityId!,
$input: UpdateActivityInput!,
$version: Int!
) {
updateActivity(
id: $id,
input: $input,
version: $version
) {
id
status
activityTemplate {
id
title
description
translations {
...ActivityTemplateTranslationFragment
}
customFormId
customFormVersion
triggers {
...TriggerFragment
}
expiresAfterMinutes
locationIds
version
createdAt
deletedAt
versions {
...VersionedActivityTemplatesConnectionFragment
}
customForm {
...CustomFormFragment
}
tags {
...ActivityTagFragment
}
}
trigger {
id
type {
...ActivityTriggerTypeFragment
}
conditions {
...TriggerConditionsFragment
}
}
customFormData {
formId
formVersion
values {
...CustomFieldValueFragment
}
initials
form {
...CustomFormFragment
}
schema
}
stopRegistration {
start
end
comment
initials
stopCause {
...ActivityStopCauseFragment
}
}
createdAt
archivedAt
version
locationId
isPassing
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"id": ActivityId,
"input": UpdateActivityInput,
"version": 987
}
Response
{
"data": {
"updateActivity": {
"id": ActivityId,
"status": "PENDING",
"activityTemplate": ActivityTemplate,
"trigger": Trigger,
"customFormData": CustomFormData,
"stopRegistration": ActivityStopRegistration,
"createdAt": "2007-12-03T10:15:30Z",
"archivedAt": "2007-12-03T10:15:30Z",
"version": 987,
"locationId": NodeId,
"isPassing": true,
"batch": Batch,
"line": Line
}
}
}
updateActivityTag
Internal use only
Response
Returns an ActivityTag!
Arguments
| Name | Description |
|---|---|
id - ActivityTagId!
|
|
input - ActivityTagInput!
|
Example
Query
mutation UpdateActivityTag(
$id: ActivityTagId!,
$input: ActivityTagInput!
) {
updateActivityTag(
id: $id,
input: $input
) {
id
name
createdAt
modifiedAt
deletedAt
templateCount
}
}
Variables
{
"id": ActivityTagId,
"input": ActivityTagInput
}
Response
{
"data": {
"updateActivityTag": {
"id": ActivityTagId,
"name": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"modifiedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"templateCount": 123
}
}
}
updateActivityTemplate
Internal use only
Response
Returns an ActivityTemplate!
Arguments
| Name | Description |
|---|---|
id - ActivityTemplateId!
|
|
input - ActivityTemplateInput!
|
|
version - Int!
|
Example
Query
mutation UpdateActivityTemplate(
$id: ActivityTemplateId!,
$input: ActivityTemplateInput!,
$version: Int!
) {
updateActivityTemplate(
id: $id,
input: $input,
version: $version
) {
id
title
description
translations {
title
description
languageCode
}
customFormId
customFormVersion
triggers {
id
type {
...ActivityTriggerTypeFragment
}
conditions {
...TriggerConditionsFragment
}
}
expiresAfterMinutes
locationIds
version
createdAt
deletedAt
versions {
pageInfo {
...PageInfoFragment
}
edges {
...VersionedActivityTemplateEdgeFragment
}
nodes {
...ActivityTemplateFragment
}
}
customForm {
id
title
description
translations {
...CustomFormTranslationFragment
}
fields {
...CustomFormFieldFragment
}
requireInitials
version
createdAt
deletedAt
versions {
...VersionedCustomFormsConnectionFragment
}
}
tags {
id
name
createdAt
modifiedAt
deletedAt
templateCount
}
}
}
Variables
{
"id": ActivityTemplateId,
"input": ActivityTemplateInput,
"version": 987
}
Response
{
"data": {
"updateActivityTemplate": {
"id": ActivityTemplateId,
"title": "abc123",
"description": "xyz789",
"translations": [ActivityTemplateTranslation],
"customFormId": CustomFormId,
"customFormVersion": 987,
"triggers": [Trigger],
"expiresAfterMinutes": 987,
"locationIds": [NodeId],
"version": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedActivityTemplatesConnection,
"customForm": CustomForm,
"tags": [ActivityTag]
}
}
}
updateAlarm
Response
Returns an Alarm!
Example
Query
mutation UpdateAlarm(
$peripheralId: ID!,
$alarmId: ID!,
$enabled: Boolean,
$name: String,
$description: String,
$threshold: Int,
$repeatNotification: Boolean,
$type: AlarmType,
$alarmConfiguration: AlarmConfigurationInput,
$languageCode: String,
$snoozeDuration: Int,
$subscribers: [SubscriberInput!]
) {
updateAlarm(
peripheralId: $peripheralId,
alarmId: $alarmId,
enabled: $enabled,
name: $name,
description: $description,
threshold: $threshold,
repeatNotification: $repeatNotification,
type: $type,
alarmConfiguration: $alarmConfiguration,
languageCode: $languageCode,
snoozeDuration: $snoozeDuration,
subscribers: $subscribers
) {
id
name
description
peripheralId
status
threshold
repeatNotification
enabled
type
alarmConfiguration {
x
t
y
n
stopType
}
languageCode
snoozeDuration
alarmLogs {
lastEvaluatedKey {
...AlarmLogLastEvaluatedKeyFragment
}
entries {
...AlarmLogFragment
}
}
subscribers {
type
languageCode
value
}
timeRange {
from
to
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
}
}
Variables
{
"peripheralId": 4,
"alarmId": "4",
"enabled": true,
"name": "xyz789",
"description": "xyz789",
"threshold": 987,
"repeatNotification": false,
"type": "AboveX",
"alarmConfiguration": AlarmConfigurationInput,
"languageCode": "abc123",
"snoozeDuration": 123,
"subscribers": [SubscriberInput]
}
Response
{
"data": {
"updateAlarm": {
"id": 4,
"name": "abc123",
"description": "xyz789",
"peripheralId": 4,
"status": "NORMAL",
"threshold": 987,
"repeatNotification": false,
"enabled": true,
"type": "AboveX",
"alarmConfiguration": AlarmConfiguration,
"languageCode": "abc123",
"snoozeDuration": 123,
"alarmLogs": AlarmLogs,
"subscribers": [SubscriberOutput],
"timeRange": TimeRange,
"peripheral": Peripheral
}
}
}
updateBatch
Response
Returns a Batch!
Example
Query
mutation UpdateBatch(
$lineId: ID!,
$batchId: ID!,
$batchNumber: String,
$plannedStart: Date,
$actualStart: Date,
$actualStop: Date,
$amount: Float,
$manualScrap: Float,
$comment: String,
$productId: ID,
$dataMultiplier: Float,
$validatedLineSpeed: Float,
$expectedAverageSpeed: Float,
$forceStop: Boolean
) {
updateBatch(
lineId: $lineId,
batchId: $batchId,
batchNumber: $batchNumber,
plannedStart: $plannedStart,
actualStart: $actualStart,
actualStop: $actualStop,
amount: $amount,
manualScrap: $manualScrap,
comment: $comment,
productId: $productId,
dataMultiplier: $dataMultiplier,
validatedLineSpeed: $validatedLineSpeed,
expectedAverageSpeed: $expectedAverageSpeed,
forceStop: $forceStop
) {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
...PackagingFragment
}
overwrittenByBatch
parameters {
...ParameterFragment
}
attachedControlReceipts {
...ControlReceiptFragment
}
}
sorting
state
tags
controls {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
...BatchControlFieldValueFragment
}
followUp {
...FollowUpSettingsFragment
}
history {
...BatchControlHistoryFragment
}
initials
initialsSettings
originalControl {
...OriginalControlDetailsFragment
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
...ControlTriggerFragment
}
}
samples {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
stops {
_id
timeRange {
...TimeRangeFragment
}
originalStart
ongoing
duration
stopCause {
...StopCauseFragment
}
comment
initials
registeredTime
isMicroStop
isAutomaticRegistration
standalone {
...StandaloneConfigurationFragment
}
target {
...TargetFragment
}
countermeasure
countermeasureInitials
}
stopStats {
longestNonStop
lastStop {
...StopFragment
}
stopCauseStats {
...StopCauseStatFragment
}
}
stats {
timeRange {
...TimeRangeFragment
}
data {
...DataFragment
}
}
scrap {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
plannedEtc
actualEtc
}
}
Variables
{
"lineId": 4,
"batchId": "4",
"batchNumber": "xyz789",
"plannedStart": "2007-12-03",
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 123.45,
"manualScrap": 123.45,
"comment": "xyz789",
"productId": "4",
"dataMultiplier": 123.45,
"validatedLineSpeed": 123.45,
"expectedAverageSpeed": 987.65,
"forceStop": true
}
Response
{
"data": {
"updateBatch": {
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 123.45,
"batchId": "4",
"batchNumber": "xyz789",
"comment": "abc123",
"lineId": "4",
"manualScrap": 987.65,
"plannedStart": "2007-12-03",
"produced": 123.45,
"product": Product,
"sorting": "abc123",
"state": "COMPLETED",
"tags": ["abc123"],
"controls": [BatchControl],
"samples": [Sample],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat,
"scrap": [Sample],
"createdBy": User,
"line": Line,
"plannedEtc": "2007-12-03",
"actualEtc": "2007-12-03"
}
}
}
updateBatchByBatchNumber
Description
Update a batch by its batch number
Response
Returns a Batch!
Arguments
| Name | Description |
|---|---|
input - UpdateBatchByBatchNumberInput!
|
Example
Query
mutation UpdateBatchByBatchNumber($input: UpdateBatchByBatchNumberInput!) {
updateBatchByBatchNumber(input: $input) {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
...PackagingFragment
}
overwrittenByBatch
parameters {
...ParameterFragment
}
attachedControlReceipts {
...ControlReceiptFragment
}
}
sorting
state
tags
controls {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
...BatchControlFieldValueFragment
}
followUp {
...FollowUpSettingsFragment
}
history {
...BatchControlHistoryFragment
}
initials
initialsSettings
originalControl {
...OriginalControlDetailsFragment
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
...ControlTriggerFragment
}
}
samples {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
stops {
_id
timeRange {
...TimeRangeFragment
}
originalStart
ongoing
duration
stopCause {
...StopCauseFragment
}
comment
initials
registeredTime
isMicroStop
isAutomaticRegistration
standalone {
...StandaloneConfigurationFragment
}
target {
...TargetFragment
}
countermeasure
countermeasureInitials
}
stopStats {
longestNonStop
lastStop {
...StopFragment
}
stopCauseStats {
...StopCauseStatFragment
}
}
stats {
timeRange {
...TimeRangeFragment
}
data {
...DataFragment
}
}
scrap {
data {
...SampleDataFragment
}
timeRange {
...TimeRangeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
plannedEtc
actualEtc
}
}
Variables
{"input": UpdateBatchByBatchNumberInput}
Response
{
"data": {
"updateBatchByBatchNumber": {
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 123.45,
"batchId": "4",
"batchNumber": "xyz789",
"comment": "abc123",
"lineId": 4,
"manualScrap": 987.65,
"plannedStart": "2007-12-03",
"produced": 123.45,
"product": Product,
"sorting": "xyz789",
"state": "COMPLETED",
"tags": ["xyz789"],
"controls": [BatchControl],
"samples": [Sample],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat,
"scrap": [Sample],
"createdBy": User,
"line": Line,
"plannedEtc": "2007-12-03",
"actualEtc": "2007-12-03"
}
}
}
updateBatchControl
Response
Returns a BatchControl!
Example
Query
mutation UpdateBatchControl(
$lineId: ID!,
$batchId: ID!,
$controlId: ID!,
$fields: [BatchControlFieldInput!],
$comment: String,
$initials: String
) {
updateBatchControl(
lineId: $lineId,
batchId: $batchId,
controlId: $controlId,
fields: $fields,
comment: $comment,
initials: $initials
) {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
controlReceiptField {
...ControlReceiptEntryFieldFragment
}
value
}
followUp {
enabled
delayMs
}
history {
comment
fieldValues {
...BatchControlFieldValueFragment
}
initials
status
timeControlUpdated
timeControlled
}
initials
initialsSettings
originalControl {
controlId
timeTriggered
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
type
payload {
...TimedTriggerPayloadFragment
}
delayWhenStopped
}
}
}
Variables
{
"lineId": "4",
"batchId": 4,
"controlId": "4",
"fields": [BatchControlFieldInput],
"comment": "abc123",
"initials": "abc123"
}
Response
{
"data": {
"updateBatchControl": {
"batchControlId": 4,
"batchId": "4",
"comment": "xyz789",
"controlReceiptId": "4",
"controlReceiptName": "abc123",
"entryId": "4",
"fieldValues": [BatchControlFieldValue],
"followUp": FollowUpSettings,
"history": [BatchControlHistory],
"initials": "xyz789",
"initialsSettings": "REQUIRED_IF_OUTSIDE_LIMITS",
"originalControl": OriginalControlDetails,
"status": "CANCELED",
"timeControlUpdated": "2007-12-03",
"timeControlled": "2007-12-03",
"timeTriggered": "2007-12-03",
"title": "abc123",
"trigger": ControlTrigger
}
}
}
updateControlReceipt
Response
Returns a ControlReceipt!
Example
Query
mutation UpdateControlReceipt(
$userPoolId: ID,
$controlReceiptId: ID!,
$name: String,
$description: String,
$entries: [ControlReceiptEntryInput!],
$updateRecipeAndPendingBatches: Boolean
) {
updateControlReceipt(
userPoolId: $userPoolId,
controlReceiptId: $controlReceiptId,
name: $name,
description: $description,
entries: $entries,
updateRecipeAndPendingBatches: $updateRecipeAndPendingBatches
) {
controlReceiptId
userPoolId
name
description
entries {
entryId
title
trigger {
...ControlTriggerFragment
}
followUp {
...FollowUpSettingsFragment
}
initialsSettings
fields {
...ControlReceiptEntryFieldFragment
}
}
deleted
attachedProducts {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
...PackagingFragment
}
overwrittenByBatch
parameters {
...ParameterFragment
}
attachedControlReceipts {
...ControlReceiptFragment
}
}
}
}
Variables
{
"userPoolId": 4,
"controlReceiptId": "4",
"name": "xyz789",
"description": "xyz789",
"entries": [ControlReceiptEntryInput],
"updateRecipeAndPendingBatches": true
}
Response
{
"data": {
"updateControlReceipt": {
"controlReceiptId": "4",
"userPoolId": 4,
"name": "abc123",
"description": "abc123",
"entries": [ControlReceiptEntry],
"deleted": false,
"attachedProducts": [Product]
}
}
}
updateCustomForm
Internal use only
Response
Returns a CustomForm!
Arguments
| Name | Description |
|---|---|
id - CustomFormId!
|
|
input - CustomFormInput!
|
|
version - Int!
|
Example
Query
mutation UpdateCustomForm(
$id: CustomFormId!,
$input: CustomFormInput!,
$version: Int!
) {
updateCustomForm(
id: $id,
input: $input,
version: $version
) {
id
title
description
translations {
title
description
languageCode
}
fields {
id
name
description
translations {
...CustomFormFieldTranslationFragment
}
fieldOptions {
...CustomFormFieldOptionsFragment
}
}
requireInitials
version
createdAt
deletedAt
versions {
pageInfo {
...PageInfoFragment
}
edges {
...VersionedCustomFormEdgeFragment
}
nodes {
...CustomFormFragment
}
}
}
}
Variables
{
"id": CustomFormId,
"input": CustomFormInput,
"version": 123
}
Response
{
"data": {
"updateCustomForm": {
"id": CustomFormId,
"title": "xyz789",
"description": "xyz789",
"translations": [CustomFormTranslation],
"fields": [CustomFormField],
"requireInitials": false,
"version": 987,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedCustomFormsConnection
}
}
}
updateDevice
Response
Returns a Device!
Arguments
| Name | Description |
|---|---|
uuid - ID
|
|
id - ID
|
|
meta - DeviceMetaInput
|
Example
Query
mutation UpdateDevice(
$uuid: ID,
$id: ID,
$meta: DeviceMetaInput
) {
updateDevice(
uuid: $uuid,
id: $id,
meta: $meta
) {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
firmwareVersions {
...FirmwareVersionsFragment
}
hardwareVersion
}
network {
wifi {
...WiFiConfigShadowFragment
}
connection
general {
...GeneralNetworkShadowSettingsFragment
}
}
sensors {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
sensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripherals {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralPhysicalInput {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralPhysicalInputs {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
pendingJobExecutions {
thingName
jobId
executionNumber
lastUpdatedAt
queuedAt
retryAttempt
startedAt
status
describeJobExecution {
...DescribeJobExecutionFragment
}
}
updateAvailable
certificates {
id
isActive
createdAt
validAt
expiresAt
subject
issuer
}
}
}
Variables
{
"uuid": "4",
"id": "4",
"meta": DeviceMetaInput
}
Response
{
"data": {
"updateDevice": {
"_id": "4",
"uuid": 4,
"owner": "4",
"type": "xyz789",
"hardwareId": "4",
"name": "xyz789",
"numInputPorts": 987,
"status": DeviceStatus,
"network": NetworkConfig,
"sensors": [Sensor],
"sensor": Sensor,
"peripheral": Peripheral,
"peripherals": [Peripheral],
"peripheralPhysicalInput": Peripheral,
"peripheralPhysicalInputs": [Peripheral],
"pendingJobExecutions": [JobExecutionSummary],
"updateAvailable": true,
"certificates": [Certificate]
}
}
}
updateDeviceNetworkSettings
Description
Update the device network settings.
`uuid' is deprecated and used to represent the allocated software identifier.
`id' refers to the hardware identifier of the device.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
uuid - ID
|
|
id - ID
|
|
input - GeneralNetworkSettingsInput!
|
Example
Query
mutation UpdateDeviceNetworkSettings(
$uuid: ID,
$id: ID,
$input: GeneralNetworkSettingsInput!
) {
updateDeviceNetworkSettings(
uuid: $uuid,
id: $id,
input: $input
)
}
Variables
{"uuid": 4, "id": 4, "input": GeneralNetworkSettingsInput}
Response
{"data": {"updateDeviceNetworkSettings": true}}
updateEdge
Description
Update an existing edge. @iam(key: "Lines.Line")
Response
Returns [LineEdge!]!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
originalEdge - LineEdgeInput!
|
|
edge - LineEdgeInput!
|
Example
Query
mutation UpdateEdge(
$lineId: ID!,
$originalEdge: LineEdgeInput!,
$edge: LineEdgeInput!
) {
updateEdge(
lineId: $lineId,
originalEdge: $originalEdge,
edge: $edge
) {
from
to
}
}
Variables
{
"lineId": "4",
"originalEdge": LineEdgeInput,
"edge": LineEdgeInput
}
Response
{
"data": {
"updateEdge": [{"from": "4", "to": 4}]
}
}
updateEscalation
Response
Returns an Escalation!
Arguments
| Name | Description |
|---|---|
input - UpdateEscalation!
|
Example
Query
mutation UpdateEscalation($input: UpdateEscalation!) {
updateEscalation(input: $input) {
nodeId
creationDate
createdBySub
assignedToSub
priority
version
plan {
state
title
pdcaState
followUpInterval
followUpState
dueDate
linkedProductionData
version
category {
...ActionPlanCategoryFragment
}
content {
...ActionPlanContentFragment
}
escalations {
...EscalationFragment
}
attachedFiles
tasks {
...ActionPlanTaskFragment
}
id
}
id
assignedTo {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{"input": UpdateEscalation}
Response
{
"data": {
"updateEscalation": {
"nodeId": "xyz789",
"creationDate": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"assignedToSub": "xyz789",
"priority": true,
"version": 123,
"plan": ActionPlan,
"id": "abc123",
"assignedTo": User,
"createdBy": User,
"node": HierarchyNode
}
}
}
updateGoldenBatchSettings
Internal use only
Description
Update the golden batch settings for the current user pool.
Response
Returns a GoldenBatchSettings!
Arguments
| Name | Description |
|---|---|
input - UpdateGoldenBatchSettingsInput!
|
Example
Query
mutation UpdateGoldenBatchSettings($input: UpdateGoldenBatchSettingsInput!) {
updateGoldenBatchSettings(input: $input) {
timePeriodMonths
}
}
Variables
{"input": UpdateGoldenBatchSettingsInput}
Response
{"data": {"updateGoldenBatchSettings": {"timePeriodMonths": 987}}}
updateGroup
Response
Returns a Group
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
id - ID!
|
|
attributes - GroupAttributes!
|
Example
Query
mutation UpdateGroup(
$companyId: ID!,
$id: ID!,
$attributes: GroupAttributes!
) {
updateGroup(
companyId: $companyId,
id: $id,
attributes: $attributes
) {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
id
name
groups {
...GroupFragment
}
roles {
...RoleFragment
}
users {
...UserListFragment
}
group {
...GroupFragment
}
appClients {
...AppClientFragment
}
trialStatus {
...TrialStatusFragment
}
}
name
description
nodeId
role {
id
name
type
permissions {
...PermissionFragment
}
}
users {
pagination {
...TokenFragment
}
items {
...UserFragment
}
}
sensors {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
peripherals {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
peripheralsPaginated {
items {
...PeripheralFragment
}
nextOffset
total
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
}
}
Variables
{
"companyId": 4,
"id": "4",
"attributes": GroupAttributes
}
Response
{
"data": {
"updateGroup": {
"id": 4,
"defaultGroup": false,
"externalIds": ["abc123"],
"peripheralIds": ["4"],
"lineIds": ["4"],
"owner": Company,
"name": "xyz789",
"description": "abc123",
"nodeId": 4,
"role": Role,
"users": UserList,
"sensors": [Sensor],
"peripherals": [Peripheral],
"peripheralsPaginated": PeripheralsPaginated,
"lines": [Line],
"scheduledReports": [ScheduledReport]
}
}
}
updateLearningActivity
Internal use only
Response
Returns a LearningActivity!
Arguments
| Name | Description |
|---|---|
input - UpdateLearningActivityInput!
|
Example
Query
mutation UpdateLearningActivity($input: UpdateLearningActivityInput!) {
updateLearningActivity(input: $input) {
id
version
nodeId
title
description
content
startEndDatesRequired
validityInMonths
createdAt
updatedAt
createdBySub
updatedBySub
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{"input": UpdateLearningActivityInput}
Response
{
"data": {
"updateLearningActivity": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"version": 987,
"nodeId": "abc123",
"title": "abc123",
"description": "xyz789",
"content": "abc123",
"startEndDatesRequired": true,
"validityInMonths": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"updatedBySub": "xyz789",
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
}
}
updateLearningRole
Internal use only
Response
Returns a LearningRole!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateLearningRoleInput!
|
Example
Query
mutation UpdateLearningRole(
$id: UUID!,
$input: UpdateLearningRoleInput!
) {
updateLearningRole(
id: $id,
input: $input
) {
id
title
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
skills {
pageInfo {
...PageInfoFragment
}
edges {
...LearningRoleSkillsEdgeFragment
}
nodes {
...LearningRoleSkillFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"input": UpdateLearningRoleInput
}
Response
{
"data": {
"updateLearningRole": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"title": "xyz789",
"description": "abc123",
"nodeId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "abc123",
"skills": LearningRoleSkillsConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
}
}
updateLine
Description
Update an existing line and its nodes, in an existing language. @iam(key: "Lines.Line")
Response
Returns a Line!
Example
Query
mutation UpdateLine(
$lineId: ID!,
$name: String!,
$description: String,
$languageCode: String!
) {
updateLine(
lineId: $lineId,
name: $name,
description: $description,
languageCode: $languageCode
) {
id
languageCode
owner
location {
timeZone
}
name
description
mainPeripheralId
nodes {
id
type
peripheralId
sensor {
...SensorFragment
}
}
edges {
from
to
}
settings {
oee {
...LineOEESettingsFragment
}
batch {
...LineBatchSettingsFragment
}
}
goldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
bestPendingGoldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
time {
configs {
...SensorConfigFragment
}
alarmLogs {
...AlarmLogsFragment
}
batches {
...BatchListFragment
}
dataOverrides {
...DataOverrideFragment
}
pendingControls {
...BatchControlListFragment
}
samples {
...SampleFragment
}
scrap {
...SampleFragment
}
shifts {
...ShiftInstanceFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
changeoverStops {
...ChangeoverStopFragment
}
_id
timeRange {
...TimeRangeFragment
}
}
products {
nextToken
items {
...ProductFragment
}
}
packagings {
nextToken
items {
...PackagingFragment
}
}
batches {
count
items {
...BatchFragment
}
nextToken
pages
}
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
schedule {
id
lineId
validFrom {
...ScheduleTimeFragment
}
validTo {
...ScheduleTimeFragment
}
shifts {
...ShiftFragment
}
weeklyTargets {
...TargetsFragment
}
configuration {
...ScheduleConfigurationFragment
}
isExceptionalWeek
isFallbackSchedule
}
mainSensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
andonSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
nextShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
scheduledEnd
previousShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
maintenanceWorkOrders {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceWorkOrderEdgeFragment
}
nodes {
...MaintenanceWorkOrderFragment
}
}
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
}
}
Variables
{
"lineId": 4,
"name": "abc123",
"description": "xyz789",
"languageCode": "xyz789"
}
Response
{
"data": {
"updateLine": {
"id": 4,
"languageCode": "xyz789",
"owner": "4",
"location": Location,
"name": "xyz789",
"description": "xyz789",
"mainPeripheralId": "4",
"nodes": [LineNode],
"edges": [LineEdge],
"settings": LineSettings,
"goldenBatch": GoldenBatch,
"bestPendingGoldenBatch": GoldenBatch,
"time": [LineTimeData],
"products": ProductList,
"packagings": PackagingList,
"batches": BatchList,
"batch": Batch,
"schedule": Schedule,
"mainSensor": Sensor,
"scheduledReports": [ScheduledReport],
"andonSchedules": [AndonSchedule],
"nextShift": ShiftInstance,
"scheduledEnd": "2007-12-03",
"previousShift": ShiftInstance,
"maintenanceWorkOrders": MaintenanceWorkOrderConnection,
"groups": [Group]
}
}
}
updateLineWithTopology
Description
Update a line with the provided nodes and edges. @iam(key: "Lines.Line")
Response
Returns a Line!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
name - String!
|
|
description - String!
|
|
nodes - [LineNodeInput!]!
|
|
edges - [LineEdgeInput!]!
|
|
languageCode - String!
|
|
settings - LineSettingsInput
|
Example
Query
mutation UpdateLineWithTopology(
$lineId: ID!,
$name: String!,
$description: String!,
$nodes: [LineNodeInput!]!,
$edges: [LineEdgeInput!]!,
$languageCode: String!,
$settings: LineSettingsInput
) {
updateLineWithTopology(
lineId: $lineId,
name: $name,
description: $description,
nodes: $nodes,
edges: $edges,
languageCode: $languageCode,
settings: $settings
) {
id
languageCode
owner
location {
timeZone
}
name
description
mainPeripheralId
nodes {
id
type
peripheralId
sensor {
...SensorFragment
}
}
edges {
from
to
}
settings {
oee {
...LineOEESettingsFragment
}
batch {
...LineBatchSettingsFragment
}
}
goldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
bestPendingGoldenBatch {
batchId
lineId
productId
oee1
state
acceptedAt
}
time {
configs {
...SensorConfigFragment
}
alarmLogs {
...AlarmLogsFragment
}
batches {
...BatchListFragment
}
dataOverrides {
...DataOverrideFragment
}
pendingControls {
...BatchControlListFragment
}
samples {
...SampleFragment
}
scrap {
...SampleFragment
}
shifts {
...ShiftInstanceFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
changeoverStops {
...ChangeoverStopFragment
}
_id
timeRange {
...TimeRangeFragment
}
}
products {
nextToken
items {
...ProductFragment
}
}
packagings {
nextToken
items {
...PackagingFragment
}
}
batches {
count
items {
...BatchFragment
}
nextToken
pages
}
batch {
actualStart
actualStop
amount
batchId
batchNumber
comment
lineId
manualScrap
plannedStart
produced
product {
...ProductFragment
}
sorting
state
tags
controls {
...BatchControlFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
scrap {
...SampleFragment
}
createdBy {
...UserFragment
}
line {
...LineFragment
}
plannedEtc
actualEtc
}
schedule {
id
lineId
validFrom {
...ScheduleTimeFragment
}
validTo {
...ScheduleTimeFragment
}
shifts {
...ShiftFragment
}
weeklyTargets {
...TargetsFragment
}
configuration {
...ScheduleConfigurationFragment
}
isExceptionalWeek
isFallbackSchedule
}
mainSensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
andonSchedules {
id
name
lineIds
shifts {
...AndonShiftFragment
}
shift {
...AndonShiftFragment
}
lines {
...LineFragment
}
}
nextShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
scheduledEnd
previousShift {
id
from
to
name
description
shiftId
batches {
...BatchListFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
}
maintenanceWorkOrders {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceWorkOrderEdgeFragment
}
nodes {
...MaintenanceWorkOrderFragment
}
}
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
}
}
Variables
{
"lineId": 4,
"name": "abc123",
"description": "abc123",
"nodes": [LineNodeInput],
"edges": [LineEdgeInput],
"languageCode": "xyz789",
"settings": LineSettingsInput
}
Response
{
"data": {
"updateLineWithTopology": {
"id": 4,
"languageCode": "xyz789",
"owner": "4",
"location": Location,
"name": "abc123",
"description": "abc123",
"mainPeripheralId": 4,
"nodes": [LineNode],
"edges": [LineEdge],
"settings": LineSettings,
"goldenBatch": GoldenBatch,
"bestPendingGoldenBatch": GoldenBatch,
"time": [LineTimeData],
"products": ProductList,
"packagings": PackagingList,
"batches": BatchList,
"batch": Batch,
"schedule": Schedule,
"mainSensor": Sensor,
"scheduledReports": [ScheduledReport],
"andonSchedules": [AndonSchedule],
"nextShift": ShiftInstance,
"scheduledEnd": "2007-12-03",
"previousShift": ShiftInstance,
"maintenanceWorkOrders": MaintenanceWorkOrderConnection,
"groups": [Group]
}
}
}
updateMaintenanceLogEntry
Response
Returns a MaintenanceLogEntry!
Arguments
| Name | Description |
|---|---|
lineId - LineId!
|
|
planId - MaintenancePlanId
|
|
timestamp - DateTime!
|
|
version - Int!
|
|
toUpdate - UpdateMaintenanceLogEntryInput!
|
Example
Query
mutation UpdateMaintenanceLogEntry(
$lineId: LineId!,
$planId: MaintenancePlanId,
$timestamp: DateTime!,
$version: Int!,
$toUpdate: UpdateMaintenanceLogEntryInput!
) {
updateMaintenanceLogEntry(
lineId: $lineId,
planId: $planId,
timestamp: $timestamp,
version: $version,
toUpdate: $toUpdate
) {
planId
lineId
status
workOrderDueAt
workOrderOverdueAt
timestamp
produced
startFrom
initials
comment
planSnapshot {
title
asset
tagPartNumber
instructions
trackBy {
...TrackByOptionsFragment
}
}
customData {
formId
formVersion
values {
...CustomFieldValueFragment
}
initials
form {
...CustomFormFragment
}
schema
}
andonCallId
stopCauseIds
stopCausePeripheralId
assetIds
startOfService
endOfService
startOfStop
endOfStop
version
effectiveDuration
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
stopCauses {
_id
id
stopType
categoryId
categoryName
name
description
meta {
...StopCauseMetaFragment
}
order
requireInitials
requireComment
deleted
languageCode
legacyStopCauseId
targetSetup {
...TargetSetupFragment
}
enableCountermeasure
}
assets {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
}
}
Variables
{
"lineId": LineId,
"planId": MaintenancePlanId,
"timestamp": "2007-12-03T10:15:30Z",
"version": 987,
"toUpdate": UpdateMaintenanceLogEntryInput
}
Response
{
"data": {
"updateMaintenanceLogEntry": {
"planId": MaintenancePlanId,
"lineId": LineId,
"status": "COMPLETED",
"workOrderDueAt": "2007-12-03T10:15:30Z",
"workOrderOverdueAt": "2007-12-03T10:15:30Z",
"timestamp": "2007-12-03T10:15:30Z",
"produced": 987,
"startFrom": "2007-12-03T10:15:30Z",
"initials": "xyz789",
"comment": "abc123",
"planSnapshot": MaintenancePlanSnapshot,
"customData": CustomFormData,
"andonCallId": "abc123",
"stopCauseIds": ["abc123"],
"stopCausePeripheralId": PeripheralId,
"assetIds": [NodeId],
"startOfService": "2007-12-03T10:15:30Z",
"endOfService": "2007-12-03T10:15:30Z",
"startOfStop": "2007-12-03T10:15:30Z",
"endOfStop": "2007-12-03T10:15:30Z",
"version": 123,
"effectiveDuration": 987,
"line": Line,
"stopCauses": [StopCause],
"assets": [HierarchyNode]
}
}
}
updateMaintenancePlan
Response
Returns a MaintenancePlan!
Arguments
| Name | Description |
|---|---|
planId - MaintenancePlanId!
|
|
lineId - LineId!
|
|
version - Int!
|
|
toUpdate - UpdateMaintenancePlanInput!
|
Example
Query
mutation UpdateMaintenancePlan(
$planId: MaintenancePlanId!,
$lineId: LineId!,
$version: Int!,
$toUpdate: UpdateMaintenancePlanInput!
) {
updateMaintenancePlan(
planId: $planId,
lineId: $lineId,
version: $version,
toUpdate: $toUpdate
) {
planId
lineId
title
asset
tagPartNumber
instructions
startFrom
trackBy {
time {
...TrackByTimeFragment
}
production {
...TrackByProductionFragment
}
calendar {
...TrackByCalendarFragment
}
}
repeat
version
role {
id
name
}
log {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceLogEntryEdgeFragment
}
nodes {
...MaintenanceLogEntryFragment
}
}
nextWorkOrder {
plan {
...MaintenancePlanFragment
}
dueAt
overdueAt
produced
latestMaintenance {
...MaintenanceLogEntryFragment
}
peripheral {
...PeripheralFragment
}
line {
...LineFragment
}
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
line {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
}
}
Variables
{
"planId": MaintenancePlanId,
"lineId": LineId,
"version": 987,
"toUpdate": UpdateMaintenancePlanInput
}
Response
{
"data": {
"updateMaintenancePlan": {
"planId": MaintenancePlanId,
"lineId": LineId,
"title": "abc123",
"asset": "xyz789",
"tagPartNumber": "abc123",
"instructions": "abc123",
"startFrom": "2007-12-03T10:15:30Z",
"trackBy": TrackByOptions,
"repeat": "YES",
"version": 123,
"role": MaintenanceRole,
"log": MaintenanceLogEntryConnection,
"nextWorkOrder": MaintenanceWorkOrder,
"peripheral": Peripheral,
"line": Line
}
}
}
updateNode
Description
Update an existing node. @iam(key: "Lines.Line")
Response
Returns a LineNode!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
node - LineNodeInput!
|
Example
Query
mutation UpdateNode(
$lineId: ID!,
$node: LineNodeInput!
) {
updateNode(
lineId: $lineId,
node: $node
) {
id
type
peripheralId
sensor {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
...SensorConfigFragment
}
description
offlineStatus {
...OfflineStatusFragment
}
cameras {
...CameraFragment
}
customKPIs {
...CustomKPIFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
peripheralInformation {
...PeripheralInformationFragment
}
alarms {
...AlarmFragment
}
alarm {
...AlarmFragment
}
stopCauseCategories {
...StopCauseCategoryFragment
}
stopCauseMappings {
...StopCauseMappingFragment
}
time {
...SensorTimeDataFragment
}
groups {
...GroupFragment
}
horizontalAnnotations {
...HorizontalAnnotationFragment
}
verticalAnnotations {
...VerticalAnnotationFragment
}
scheduledReports {
...ScheduledReportFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
}
}
}
Variables
{
"lineId": "4",
"node": LineNodeInput
}
Response
{
"data": {
"updateNode": {
"id": "4",
"type": "Main",
"peripheralId": "4",
"sensor": Sensor
}
}
}
updatePackaging
Response
Returns a Packaging!
Example
Query
mutation UpdatePackaging(
$packagingId: ID!,
$lineId: ID!,
$name: String,
$packagingNumber: String,
$unit: String,
$comment: String
) {
updatePackaging(
packagingId: $packagingId,
lineId: $lineId,
name: $name,
packagingNumber: $packagingNumber,
unit: $unit,
comment: $comment
) {
packagingId
packagingNumber
lineId
name
unit
comment
}
}
Variables
{
"packagingId": "4",
"lineId": 4,
"name": "xyz789",
"packagingNumber": "xyz789",
"unit": "xyz789",
"comment": "abc123"
}
Response
{
"data": {
"updatePackaging": {
"packagingId": "4",
"packagingNumber": "abc123",
"lineId": "xyz789",
"name": "abc123",
"unit": "xyz789",
"comment": "abc123"
}
}
}
updatePendingBatchControl
Response
Returns a BatchControl!
Example
Query
mutation UpdatePendingBatchControl(
$lineId: ID!,
$batchId: ID!,
$controlId: ID!,
$fields: [BatchControlFieldInput!],
$comment: String,
$initials: String
) {
updatePendingBatchControl(
lineId: $lineId,
batchId: $batchId,
controlId: $controlId,
fields: $fields,
comment: $comment,
initials: $initials
) {
batchControlId
batchId
comment
controlReceiptId
controlReceiptName
entryId
fieldValues {
controlReceiptField {
...ControlReceiptEntryFieldFragment
}
value
}
followUp {
enabled
delayMs
}
history {
comment
fieldValues {
...BatchControlFieldValueFragment
}
initials
status
timeControlUpdated
timeControlled
}
initials
initialsSettings
originalControl {
controlId
timeTriggered
}
status
timeControlUpdated
timeControlled
timeTriggered
title
trigger {
type
payload {
...TimedTriggerPayloadFragment
}
delayWhenStopped
}
}
}
Variables
{
"lineId": 4,
"batchId": 4,
"controlId": 4,
"fields": [BatchControlFieldInput],
"comment": "xyz789",
"initials": "abc123"
}
Response
{
"data": {
"updatePendingBatchControl": {
"batchControlId": 4,
"batchId": 4,
"comment": "abc123",
"controlReceiptId": 4,
"controlReceiptName": "xyz789",
"entryId": 4,
"fieldValues": [BatchControlFieldValue],
"followUp": FollowUpSettings,
"history": [BatchControlHistory],
"initials": "xyz789",
"initialsSettings": "REQUIRED_IF_OUTSIDE_LIMITS",
"originalControl": OriginalControlDetails,
"status": "CANCELED",
"timeControlUpdated": "2007-12-03",
"timeControlled": "2007-12-03",
"timeTriggered": "2007-12-03",
"title": "xyz789",
"trigger": ControlTrigger
}
}
}
updatePeripheral
Response
Returns a Peripheral
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
meta - PeripheralMetaInput
|
|
config - UpdateConfigInput
|
Example
Query
mutation UpdatePeripheral(
$peripheralId: ID!,
$meta: PeripheralMetaInput,
$config: UpdateConfigInput
) {
updatePeripheral(
peripheralId: $peripheralId,
meta: $meta,
config: $config
) {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
expiration
lastReceived
}
device {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
hardwareDevice {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
}
}
Variables
{
"peripheralId": "4",
"meta": PeripheralMetaInput,
"config": UpdateConfigInput
}
Response
{
"data": {
"updatePeripheral": {
"_id": 4,
"id": 4,
"name": "xyz789",
"index": "4",
"peripheralId": "4",
"owner": 4,
"hardwareId": 4,
"peripheralType": "CAMERA",
"description": "abc123",
"offlineStatus": OfflineStatus,
"device": Device,
"hardwareDevice": Device
}
}
}
updateProduct
Response
Returns a Product!
Example
Query
mutation UpdateProduct(
$productId: ID!,
$lineId: ID!,
$itemNumber: String,
$name: String,
$validatedLineSpeed: Float,
$expectedAverageSpeed: Float,
$comment: String,
$dataMultiplier: Float,
$packagingId: ID,
$parameters: [InputParameter!],
$updateBatches: Boolean
) {
updateProduct(
productId: $productId,
lineId: $lineId,
itemNumber: $itemNumber,
name: $name,
validatedLineSpeed: $validatedLineSpeed,
expectedAverageSpeed: $expectedAverageSpeed,
comment: $comment,
dataMultiplier: $dataMultiplier,
packagingId: $packagingId,
parameters: $parameters,
updateBatches: $updateBatches
) {
productId
name
itemNumber
validatedLineSpeed
expectedAverageSpeed
comment
lineId
dataMultiplier
packaging {
packagingId
packagingNumber
lineId
name
unit
comment
}
overwrittenByBatch
parameters {
key
value
alarm {
...AlarmFragment
}
setpoint {
...SetPointFragment
}
}
attachedControlReceipts {
controlReceiptId
userPoolId
name
description
entries {
...ControlReceiptEntryFragment
}
deleted
attachedProducts {
...ProductFragment
}
}
}
}
Variables
{
"productId": "4",
"lineId": "4",
"itemNumber": "xyz789",
"name": "xyz789",
"validatedLineSpeed": 987.65,
"expectedAverageSpeed": 123.45,
"comment": "xyz789",
"dataMultiplier": 987.65,
"packagingId": 4,
"parameters": [InputParameter],
"updateBatches": false
}
Response
{
"data": {
"updateProduct": {
"productId": 4,
"name": "abc123",
"itemNumber": "abc123",
"validatedLineSpeed": 987.65,
"expectedAverageSpeed": 123.45,
"comment": "xyz789",
"lineId": 4,
"dataMultiplier": 987.65,
"packaging": Packaging,
"overwrittenByBatch": false,
"parameters": [Parameter],
"attachedControlReceipts": [ControlReceipt]
}
}
}
updateRole
Response
Returns a Role
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
id - ID!
|
|
attributes - RoleAttributes!
|
Example
Query
mutation UpdateRole(
$companyId: ID!,
$id: ID!,
$attributes: RoleAttributes!
) {
updateRole(
companyId: $companyId,
id: $id,
attributes: $attributes
) {
id
name
type
permissions {
key
type
description
}
}
}
Variables
{"companyId": 4, "id": 4, "attributes": RoleAttributes}
Response
{
"data": {
"updateRole": {
"id": 4,
"name": "xyz789",
"type": "SUPER",
"permissions": [Permission]
}
}
}
updateSchedule
Response
Returns a Schedule!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
scheduleId - ID!
|
|
shifts - [ShiftInput!]
|
|
weeklyTargets - TargetsInput
|
|
configuration - ScheduleConfigurationInput
|
Example
Query
mutation UpdateSchedule(
$lineId: ID!,
$scheduleId: ID!,
$shifts: [ShiftInput!],
$weeklyTargets: TargetsInput,
$configuration: ScheduleConfigurationInput
) {
updateSchedule(
lineId: $lineId,
scheduleId: $scheduleId,
shifts: $shifts,
weeklyTargets: $weeklyTargets,
configuration: $configuration
) {
id
lineId
validFrom {
year
week
}
validTo {
year
week
}
shifts {
id
name
description
timeRange {
...ShiftTimeRangeFragment
}
targets {
...TargetsFragment
}
}
weeklyTargets {
lineId
validFrom {
...ScheduleTimeFragment
}
id
oee
oee2
oee3
tcu
produced
numberOfBatches
mainOeeType
}
configuration {
lineId
disableLostConnectionAlarmOutsideWorkingHours
automaticStopRegistration {
...AutomaticStopRegistrationFragment
}
startDayOfWeek
timezone
}
isExceptionalWeek
isFallbackSchedule
}
}
Variables
{
"lineId": 4,
"scheduleId": "4",
"shifts": [ShiftInput],
"weeklyTargets": TargetsInput,
"configuration": ScheduleConfigurationInput
}
Response
{
"data": {
"updateSchedule": {
"id": "4",
"lineId": 4,
"validFrom": ScheduleTime,
"validTo": ScheduleTime,
"shifts": [Shift],
"weeklyTargets": Targets,
"configuration": ScheduleConfiguration,
"isExceptionalWeek": false,
"isFallbackSchedule": true
}
}
}
updateScheduledReportForGroup
Response
Returns a ScheduledReport!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
|
id - ID!
|
|
type - ReportType
|
|
name - String
|
|
description - String
|
|
trigger - TriggerType
|
|
triggerParameters - String
|
|
subscribers - [ReportSubscriberInput!]
|
|
enabled - Boolean
|
|
timezone - String
|
|
stopFilter - StopFilterInput
|
Example
Query
mutation UpdateScheduledReportForGroup(
$groupId: ID!,
$id: ID!,
$type: ReportType,
$name: String,
$description: String,
$trigger: TriggerType,
$triggerParameters: String,
$subscribers: [ReportSubscriberInput!],
$enabled: Boolean,
$timezone: String,
$stopFilter: StopFilterInput
) {
updateScheduledReportForGroup(
groupId: $groupId,
id: $id,
type: $type,
name: $name,
description: $description,
trigger: $trigger,
triggerParameters: $triggerParameters,
subscribers: $subscribers,
enabled: $enabled,
timezone: $timezone,
stopFilter: $stopFilter
) {
id
type
entityId
entityType
name
description
enabled
subscribers {
type
value
languageCode
disabled
}
trigger {
type
parameters
}
nextTriggerDate
timezone
stopFilter {
stopTypes
stopCauseIds
includeMicroStops
}
}
}
Variables
{
"groupId": "4",
"id": "4",
"type": "STOPS_LAST_6_DAYS",
"name": "xyz789",
"description": "xyz789",
"trigger": "CRON",
"triggerParameters": "xyz789",
"subscribers": [ReportSubscriberInput],
"enabled": false,
"timezone": "xyz789",
"stopFilter": StopFilterInput
}
Response
{
"data": {
"updateScheduledReportForGroup": {
"id": 4,
"type": "STOPS_LAST_6_DAYS",
"entityId": 4,
"entityType": "LINE",
"name": "xyz789",
"description": "abc123",
"enabled": false,
"subscribers": [ReportSubscriber],
"trigger": ScheduledReportTrigger,
"nextTriggerDate": "2007-12-03",
"timezone": "xyz789",
"stopFilter": ReportStopFilter
}
}
}
updateScheduledReportForLine
Response
Returns a ScheduledReport!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
id - ID!
|
|
type - ReportType
|
|
name - String
|
|
description - String
|
|
trigger - TriggerType
|
|
triggerParameters - String
|
|
subscribers - [ReportSubscriberInput!]
|
|
enabled - Boolean
|
|
timezone - String
|
|
stopFilter - StopFilterInput
|
Example
Query
mutation UpdateScheduledReportForLine(
$lineId: ID!,
$id: ID!,
$type: ReportType,
$name: String,
$description: String,
$trigger: TriggerType,
$triggerParameters: String,
$subscribers: [ReportSubscriberInput!],
$enabled: Boolean,
$timezone: String,
$stopFilter: StopFilterInput
) {
updateScheduledReportForLine(
lineId: $lineId,
id: $id,
type: $type,
name: $name,
description: $description,
trigger: $trigger,
triggerParameters: $triggerParameters,
subscribers: $subscribers,
enabled: $enabled,
timezone: $timezone,
stopFilter: $stopFilter
) {
id
type
entityId
entityType
name
description
enabled
subscribers {
type
value
languageCode
disabled
}
trigger {
type
parameters
}
nextTriggerDate
timezone
stopFilter {
stopTypes
stopCauseIds
includeMicroStops
}
}
}
Variables
{
"lineId": 4,
"id": "4",
"type": "STOPS_LAST_6_DAYS",
"name": "xyz789",
"description": "abc123",
"trigger": "CRON",
"triggerParameters": "abc123",
"subscribers": [ReportSubscriberInput],
"enabled": false,
"timezone": "abc123",
"stopFilter": StopFilterInput
}
Response
{
"data": {
"updateScheduledReportForLine": {
"id": 4,
"type": "STOPS_LAST_6_DAYS",
"entityId": 4,
"entityType": "LINE",
"name": "xyz789",
"description": "abc123",
"enabled": true,
"subscribers": [ReportSubscriber],
"trigger": ScheduledReportTrigger,
"nextTriggerDate": "2007-12-03",
"timezone": "xyz789",
"stopFilter": ReportStopFilter
}
}
}
updateScheduledReportForSensor
Response
Returns a ScheduledReport!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
id - ID!
|
|
type - ReportType
|
|
name - String
|
|
description - String
|
|
trigger - TriggerType
|
|
triggerParameters - String
|
|
subscribers - [ReportSubscriberInput!]
|
|
enabled - Boolean
|
|
timezone - String
|
|
stopFilter - StopFilterInput
|
Example
Query
mutation UpdateScheduledReportForSensor(
$peripheralId: ID!,
$id: ID!,
$type: ReportType,
$name: String,
$description: String,
$trigger: TriggerType,
$triggerParameters: String,
$subscribers: [ReportSubscriberInput!],
$enabled: Boolean,
$timezone: String,
$stopFilter: StopFilterInput
) {
updateScheduledReportForSensor(
peripheralId: $peripheralId,
id: $id,
type: $type,
name: $name,
description: $description,
trigger: $trigger,
triggerParameters: $triggerParameters,
subscribers: $subscribers,
enabled: $enabled,
timezone: $timezone,
stopFilter: $stopFilter
) {
id
type
entityId
entityType
name
description
enabled
subscribers {
type
value
languageCode
disabled
}
trigger {
type
parameters
}
nextTriggerDate
timezone
stopFilter {
stopTypes
stopCauseIds
includeMicroStops
}
}
}
Variables
{
"peripheralId": 4,
"id": "4",
"type": "STOPS_LAST_6_DAYS",
"name": "abc123",
"description": "abc123",
"trigger": "CRON",
"triggerParameters": "xyz789",
"subscribers": [ReportSubscriberInput],
"enabled": false,
"timezone": "abc123",
"stopFilter": StopFilterInput
}
Response
{
"data": {
"updateScheduledReportForSensor": {
"id": "4",
"type": "STOPS_LAST_6_DAYS",
"entityId": "4",
"entityType": "LINE",
"name": "abc123",
"description": "xyz789",
"enabled": false,
"subscribers": [ReportSubscriber],
"trigger": ScheduledReportTrigger,
"nextTriggerDate": "2007-12-03",
"timezone": "xyz789",
"stopFilter": ReportStopFilter
}
}
}
updateSensor
Use
updatePeripheral instead. Response
Returns a Sensor
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
newName - String
|
|
newDescription - String
|
|
newSensorConfig - SensorConfigInput
|
Example
Query
mutation UpdateSensor(
$peripheralId: ID!,
$newName: String,
$newDescription: String,
$newSensorConfig: SensorConfigInput
) {
updateSensor(
peripheralId: $peripheralId,
newName: $newName,
newDescription: $newDescription,
newSensorConfig: $newSensorConfig
) {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
config {
validFrom
type
energyMeter
wiring {
...SensorWiringStateFragment
}
inputMode {
...InputModeStateFragment
}
debounce {
...DebounceStateFragment
}
stopThreshold
stopRegisterThreshold
stopValueThreshold
dataMultiplier
validatedSpeed
expectedSpeed
analogOffset
analogInputRange
sensorUnit {
...SensorUnitFragment
}
chartTimeScale
accumulatorConfig {
...AccumulatorConfigFragment
}
discreteConfig {
...DiscreteConfigFragment
}
manualConfig {
...ManualConfigFragment
}
publishRate
sampleRate
triggerIndex
dataAlarm {
...DataAlarmFragment
}
findStops
chart {
...ChartConfigurationFragment
}
kpiConfig {
...KPIConfigurationFragment
}
subtractCycleTime
extraMultiplierForFrontend
}
description
offlineStatus {
expiration
lastReceived
}
cameras {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
attachedSensors {
...SensorFragment
}
streamURL
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
customKPIs {
id
peripheralId
name
description
unit
decimals
type
templateParameters {
...KPIParameterFragment
}
kpiParameters {
...KPIParameterFragment
}
}
device {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
hardwareDevice {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
peripheralInformation {
line {
...LineFragment
}
node {
...LineNodeFragment
}
}
alarms {
id
name
description
peripheralId
status
threshold
repeatNotification
enabled
type
alarmConfiguration {
...AlarmConfigurationFragment
}
languageCode
snoozeDuration
alarmLogs {
...AlarmLogsFragment
}
subscribers {
...SubscriberOutputFragment
}
timeRange {
...TimeRangeFragment
}
peripheral {
...PeripheralFragment
}
}
alarm {
id
name
description
peripheralId
status
threshold
repeatNotification
enabled
type
alarmConfiguration {
...AlarmConfigurationFragment
}
languageCode
snoozeDuration
alarmLogs {
...AlarmLogsFragment
}
subscribers {
...SubscriberOutputFragment
}
timeRange {
...TimeRangeFragment
}
peripheral {
...PeripheralFragment
}
}
stopCauseCategories {
_id
id
ownerType
order
name
meta {
...StopCauseCategoryMetaFragment
}
languageCode
deleted
stopCauses {
...StopCauseFragment
}
legacyCategoryId
}
stopCauseMappings {
_id
peripheralIdEvent
peripheralIdTarget
value
stopCauseId
buffer
lookForward
lookBack
userPool
split
regPriority
}
time {
configs {
...SensorConfigFragment
}
alarmLogs {
...AlarmLogsFragment
}
batches {
...BatchListFragment
}
dataOverrides {
...DataOverrideFragment
}
samples {
...SampleFragment
}
stops {
...StopFragment
}
stopStats {
...StopStatsFragment
}
stats {
...StatFragment
}
_id
timeRange {
...TimeRangeFragment
}
}
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
horizontalAnnotations {
id
label
axisValue
}
verticalAnnotations {
id
label
timestamp
timestampEnd
tags
}
scheduledReports {
id
type
entityId
entityType
name
description
enabled
subscribers {
...ReportSubscriberFragment
}
trigger {
...ScheduledReportTriggerFragment
}
nextTriggerDate
timezone
stopFilter {
...ReportStopFilterFragment
}
}
maintenanceWorkOrders {
pageInfo {
...PageInfoFragment
}
edges {
...MaintenanceWorkOrderEdgeFragment
}
nodes {
...MaintenanceWorkOrderFragment
}
}
}
}
Variables
{
"peripheralId": 4,
"newName": "xyz789",
"newDescription": "abc123",
"newSensorConfig": SensorConfigInput
}
Response
{
"data": {
"updateSensor": {
"_id": "4",
"id": "4",
"name": "xyz789",
"index": 4,
"peripheralId": 4,
"owner": "4",
"hardwareId": 4,
"peripheralType": "CAMERA",
"config": SensorConfig,
"description": "xyz789",
"offlineStatus": OfflineStatus,
"cameras": [Camera],
"customKPIs": [CustomKPI],
"device": Device,
"hardwareDevice": Device,
"peripheralInformation": PeripheralInformation,
"alarms": [Alarm],
"alarm": Alarm,
"stopCauseCategories": [StopCauseCategory],
"stopCauseMappings": [StopCauseMapping],
"time": [SensorTimeData],
"groups": [Group],
"horizontalAnnotations": [HorizontalAnnotation],
"verticalAnnotations": [VerticalAnnotation],
"scheduledReports": [ScheduledReport],
"maintenanceWorkOrders": MaintenanceWorkOrderConnection
}
}
}
updateSkill
Internal use only
Response
Returns a Skill!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateSkillInput!
|
Example
Query
mutation UpdateSkill(
$id: UUID!,
$input: UpdateSkillInput!
) {
updateSkill(
id: $id,
input: $input
) {
id
title
description
nodeId
createdAt
updatedAt
createdBySub
updatedBySub
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...SkillLearningActivitiesEdgeFragment
}
nodes {
...SkillLearningActivityFragment
}
}
node {
id
version
meta {
... on LineNodeMeta {
...LineNodeMetaFragment
}
... on DirectoryNodeMeta {
...DirectoryNodeMetaFragment
}
... on PeripheralNodeMeta {
...PeripheralNodeMetaFragment
}
... on AssetNodeMeta {
...AssetNodeMetaFragment
}
}
attachments {
...HierarchyNodeAttachmentsFragment
}
type
descendants {
...HierarchyNodeConnectionFragment
}
ancestors {
...HierarchyNodeFragment
}
}
createdBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
updatedBy {
company {
...CompanyFragment
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
...GroupFragment
}
devices {
...DeviceFragment
}
lines {
...LineFragment
}
linesPaginated {
...LinesPaginatedFragment
}
skills {
...UserSkillConnectionFragment
}
learningRoles {
...UserLearningRoleConnectionFragment
}
learningActivities {
...UserLearningActivityConnectionFragment
}
sessions {
...SessionFragment
}
}
}
}
Variables
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"input": UpdateSkillInput
}
Response
{
"data": {
"updateSkill": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"title": "xyz789",
"description": "xyz789",
"nodeId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "abc123",
"learningActivities": SkillLearningActivitiesConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
}
}
updateStopCauseMapping
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
deviceOwner - ID
|
|
peripheralId - ID!
|
|
createStopCauseMapping - [StopCauseMappingInput!]!
|
|
deleteStopCauseMapping - [StopCauseMappingInput!]!
|
Example
Query
mutation UpdateStopCauseMapping(
$deviceOwner: ID,
$peripheralId: ID!,
$createStopCauseMapping: [StopCauseMappingInput!]!,
$deleteStopCauseMapping: [StopCauseMappingInput!]!
) {
updateStopCauseMapping(
deviceOwner: $deviceOwner,
peripheralId: $peripheralId,
createStopCauseMapping: $createStopCauseMapping,
deleteStopCauseMapping: $deleteStopCauseMapping
)
}
Variables
{
"deviceOwner": "4",
"peripheralId": "4",
"createStopCauseMapping": [StopCauseMappingInput],
"deleteStopCauseMapping": [StopCauseMappingInput]
}
Response
{"data": {"updateStopCauseMapping": false}}
updateSubscribers
Response
Returns an Alarm!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
alarmId - ID!
|
|
subscribers - [SubscriberInput!]!
|
Example
Query
mutation UpdateSubscribers(
$peripheralId: ID!,
$alarmId: ID!,
$subscribers: [SubscriberInput!]!
) {
updateSubscribers(
peripheralId: $peripheralId,
alarmId: $alarmId,
subscribers: $subscribers
) {
id
name
description
peripheralId
status
threshold
repeatNotification
enabled
type
alarmConfiguration {
x
t
y
n
stopType
}
languageCode
snoozeDuration
alarmLogs {
lastEvaluatedKey {
...AlarmLogLastEvaluatedKeyFragment
}
entries {
...AlarmLogFragment
}
}
subscribers {
type
languageCode
value
}
timeRange {
from
to
}
peripheral {
_id
id
name
index
peripheralId
owner
hardwareId
peripheralType
description
offlineStatus {
...OfflineStatusFragment
}
device {
...DeviceFragment
}
hardwareDevice {
...DeviceFragment
}
}
}
}
Variables
{
"peripheralId": "4",
"alarmId": 4,
"subscribers": [SubscriberInput]
}
Response
{
"data": {
"updateSubscribers": {
"id": 4,
"name": "abc123",
"description": "xyz789",
"peripheralId": 4,
"status": "NORMAL",
"threshold": 987,
"repeatNotification": false,
"enabled": true,
"type": "AboveX",
"alarmConfiguration": AlarmConfiguration,
"languageCode": "xyz789",
"snoozeDuration": 123,
"alarmLogs": AlarmLogs,
"subscribers": [SubscriberOutput],
"timeRange": TimeRange,
"peripheral": Peripheral
}
}
}
updateUser
Response
Returns a User
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
username - String!
|
|
attributes - UserAttributes!
|
|
groupIds - [ID!]
|
|
removedGroupIds - [ID!]
|
Example
Query
mutation UpdateUser(
$companyId: ID!,
$username: String!,
$attributes: UserAttributes!,
$groupIds: [ID!],
$removedGroupIds: [ID!]
) {
updateUser(
companyId: $companyId,
username: $username,
attributes: $attributes,
groupIds: $groupIds,
removedGroupIds: $removedGroupIds
) {
company {
id
name
groups {
...GroupFragment
}
roles {
...RoleFragment
}
users {
...UserListFragment
}
group {
...GroupFragment
}
appClients {
...AppClientFragment
}
trialStatus {
...TrialStatusFragment
}
}
username
enabled
userStatus
userCreateDate
userLastModifiedDate
sub
email
givenName
familyName
emailVerified
groups {
id
defaultGroup
externalIds
peripheralIds
lineIds
owner {
...CompanyFragment
}
name
description
nodeId
role {
...RoleFragment
}
users {
...UserListFragment
}
sensors {
...SensorFragment
}
peripherals {
...PeripheralFragment
}
peripheralsPaginated {
...PeripheralsPaginatedFragment
}
lines {
...LineFragment
}
scheduledReports {
...ScheduledReportFragment
}
}
devices {
_id
uuid
owner
type
hardwareId
name
numInputPorts
status {
...DeviceStatusFragment
}
network {
...NetworkConfigFragment
}
sensors {
...SensorFragment
}
sensor {
...SensorFragment
}
peripheral {
...PeripheralFragment
}
peripherals {
...PeripheralFragment
}
peripheralPhysicalInput {
...PeripheralFragment
}
peripheralPhysicalInputs {
...PeripheralFragment
}
pendingJobExecutions {
...JobExecutionSummaryFragment
}
updateAvailable
certificates {
...CertificateFragment
}
}
lines {
id
languageCode
owner
location {
...LocationFragment
}
name
description
mainPeripheralId
nodes {
...LineNodeFragment
}
edges {
...LineEdgeFragment
}
settings {
...LineSettingsFragment
}
goldenBatch {
...GoldenBatchFragment
}
bestPendingGoldenBatch {
...GoldenBatchFragment
}
time {
...LineTimeDataFragment
}
products {
...ProductListFragment
}
packagings {
...PackagingListFragment
}
batches {
...BatchListFragment
}
batch {
...BatchFragment
}
schedule {
...ScheduleFragment
}
mainSensor {
...SensorFragment
}
scheduledReports {
...ScheduledReportFragment
}
andonSchedules {
...AndonScheduleFragment
}
nextShift {
...ShiftInstanceFragment
}
scheduledEnd
previousShift {
...ShiftInstanceFragment
}
maintenanceWorkOrders {
...MaintenanceWorkOrderConnectionFragment
}
groups {
...GroupFragment
}
}
linesPaginated {
items {
...LineFragment
}
nextOffset
total
}
skills {
pageInfo {
...PageInfoFragment
}
edges {
...UserSkillEdgeFragment
}
nodes {
...UserSkillFragment
}
}
learningRoles {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningRoleEdgeFragment
}
nodes {
...UserLearningRoleFragment
}
}
learningActivities {
pageInfo {
...PageInfoFragment
}
edges {
...UserLearningActivityEdgeFragment
}
nodes {
...UserLearningActivityFragment
}
}
sessions {
generatedAt
expiresAt
userSub
}
}
}
Variables
{
"companyId": 4,
"username": "abc123",
"attributes": UserAttributes,
"groupIds": ["4"],
"removedGroupIds": [4]
}
Response
{
"data": {
"updateUser": {
"company": Company,
"username": "xyz789",
"enabled": false,
"userStatus": "xyz789",
"userCreateDate": "2007-12-03",
"userLastModifiedDate": "2007-12-03",
"sub": "xyz789",
"email": "xyz789",
"givenName": "xyz789",
"familyName": "xyz789",
"emailVerified": "xyz789",
"groups": [Group],
"devices": [Device],
"lines": [Line],
"linesPaginated": LinesPaginated,
"skills": UserSkillConnection,
"learningRoles": UserLearningRoleConnection,
"learningActivities": UserLearningActivityConnection,
"sessions": [Session]
}
}
}
updateUserLearningActivity
Internal use only
Response
Returns a UserLearningActivity!
Arguments
| Name | Description |
|---|---|
input - UpdateUserLearningActivityInput!
|
Example
Query
mutation UpdateUserLearningActivity($input: UpdateUserLearningActivityInput!) {
updateUserLearningActivity(input: $input) {
id
learningActivityId
version
nodeId
title
status
description
content
startEndDatesRequired
validityInMonths
enrolledAt
startedAt
completedAt
exemptedAt
expiresAt
}
}
Variables
{"input": UpdateUserLearningActivityInput}
Response
{
"data": {
"updateUserLearningActivity": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"learningActivityId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"version": 987,
"nodeId": "abc123",
"title": "abc123",
"status": "ENROLLED",
"description": "abc123",
"content": "abc123",
"startEndDatesRequired": true,
"validityInMonths": 123,
"enrolledAt": "2007-12-03T10:15:30Z",
"startedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"exemptedAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z"
}
}
}
updateVerticalAnnotation
Response
Returns a VerticalAnnotation!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
verticalAnnotationId - ID!
|
|
oldTimestamp - Date!
|
|
newVerticalAnnotation - VerticalAnnotationInput!
|
Example
Query
mutation UpdateVerticalAnnotation(
$peripheralId: ID!,
$verticalAnnotationId: ID!,
$oldTimestamp: Date!,
$newVerticalAnnotation: VerticalAnnotationInput!
) {
updateVerticalAnnotation(
peripheralId: $peripheralId,
verticalAnnotationId: $verticalAnnotationId,
oldTimestamp: $oldTimestamp,
newVerticalAnnotation: $newVerticalAnnotation
) {
id
label
timestamp
timestampEnd
tags
}
}
Variables
{
"peripheralId": 4,
"verticalAnnotationId": 4,
"oldTimestamp": "2007-12-03",
"newVerticalAnnotation": VerticalAnnotationInput
}
Response
{
"data": {
"updateVerticalAnnotation": {
"id": "4",
"label": "abc123",
"timestamp": "2007-12-03",
"timestampEnd": "2007-12-03",
"tags": ["xyz789"]
}
}
}
updateWebhook
Description
Update an existing webhook.
Response
Returns a Webhook!
Arguments
| Name | Description |
|---|---|
input - UpdateWebhookInput!
|
Example
Query
mutation UpdateWebhook($input: UpdateWebhookInput!) {
updateWebhook(input: $input) {
id
url
description
headers
triggerType
createdAt
updatedAt
deletedAt
}
}
Variables
{"input": UpdateWebhookInput}
Response
{
"data": {
"updateWebhook": {
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"url": "abc123",
"description": "xyz789",
"headers": {},
"triggerType": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z"
}
}
}
upsertActionPlanCategory
Response
Returns an ActionPlanCategory!
Arguments
| Name | Description |
|---|---|
input - ActionPlanCategoryInput!
|
Example
Query
mutation UpsertActionPlanCategory($input: ActionPlanCategoryInput!) {
upsertActionPlanCategory(input: $input) {
id
meta {
name
languageCode
}
color
version
nodeId
}
}
Variables
{"input": ActionPlanCategoryInput}
Response
{
"data": {
"upsertActionPlanCategory": {
"id": "abc123",
"meta": [ActionPlanCategoryMeta],
"color": "xyz789",
"version": 123,
"nodeId": "xyz789"
}
}
}
upsertActionPlanTasks
Description
Update/Insert new tasks for action plans, and return all existing tasks for this Action Plan. Note omitted tasks are not deleted.
Response
Returns [ActionPlanTask!]!
Arguments
| Name | Description |
|---|---|
actionPlan - String!
|
|
input - [UpsertActionPlansTaskInput!]!
|
Example
Query
mutation UpsertActionPlanTasks(
$actionPlan: String!,
$input: [UpsertActionPlansTaskInput!]!
) {
upsertActionPlanTasks(
actionPlan: $actionPlan,
input: $input
) {
content
checked
version
plan {
state
title
pdcaState
followUpInterval
followUpState
dueDate
linkedProductionData
version
category {
...ActionPlanCategoryFragment
}
content {
...ActionPlanContentFragment
}
escalations {
...EscalationFragment
}
attachedFiles
tasks {
...ActionPlanTaskFragment
}
id
}
id
}
}
Variables
{
"actionPlan": "abc123",
"input": [UpsertActionPlansTaskInput]
}
Response
{
"data": {
"upsertActionPlanTasks": [
{
"content": "xyz789",
"checked": true,
"version": 987,
"plan": ActionPlan,
"id": "xyz789"
}
]
}
}
upsertConfiguration
Response
Returns a ScheduleConfiguration!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
configuration - ScheduleConfigurationInput!
|
Example
Query
mutation UpsertConfiguration(
$lineId: ID!,
$configuration: ScheduleConfigurationInput!
) {
upsertConfiguration(
lineId: $lineId,
configuration: $configuration
) {
lineId
disableLostConnectionAlarmOutsideWorkingHours
automaticStopRegistration {
enabled
stopCauseId
comment
minimumStopMillis
splitAtEnds
}
startDayOfWeek
timezone
}
}
Variables
{
"lineId": "4",
"configuration": ScheduleConfigurationInput
}
Response
{
"data": {
"upsertConfiguration": {
"lineId": "4",
"disableLostConnectionAlarmOutsideWorkingHours": true,
"automaticStopRegistration": AutomaticStopRegistration,
"startDayOfWeek": "MONDAY",
"timezone": "xyz789"
}
}
}
upsertEventActionConfigurations
Response
Returns an EventActionConfiguration!
Arguments
| Name | Description |
|---|---|
peripheralId - ID!
|
|
value - String!
|
|
actions - [ActionsInput!]!
|
Example
Query
mutation UpsertEventActionConfigurations(
$peripheralId: ID!,
$value: String!,
$actions: [ActionsInput!]!
) {
upsertEventActionConfigurations(
peripheralId: $peripheralId,
value: $value,
actions: $actions
) {
peripheralId
value
actions {
type
lineId
peripheralId
}
}
}
Variables
{
"peripheralId": 4,
"value": "xyz789",
"actions": [ActionsInput]
}
Response
{
"data": {
"upsertEventActionConfigurations": {
"peripheralId": 4,
"value": "xyz789",
"actions": [Actions]
}
}
}
upsertSchedule
Response
Returns a Schedule!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
validFrom - ScheduleTimeInput!
|
|
shifts - [ShiftInput!]!
|
|
weeklyTargets - TargetsInput
|
|
configuration - ScheduleConfigurationInput
|
|
isExceptionalWeek - Boolean
|
Default = false |
Example
Query
mutation UpsertSchedule(
$lineId: ID!,
$validFrom: ScheduleTimeInput!,
$shifts: [ShiftInput!]!,
$weeklyTargets: TargetsInput,
$configuration: ScheduleConfigurationInput,
$isExceptionalWeek: Boolean
) {
upsertSchedule(
lineId: $lineId,
validFrom: $validFrom,
shifts: $shifts,
weeklyTargets: $weeklyTargets,
configuration: $configuration,
isExceptionalWeek: $isExceptionalWeek
) {
id
lineId
validFrom {
year
week
}
validTo {
year
week
}
shifts {
id
name
description
timeRange {
...ShiftTimeRangeFragment
}
targets {
...TargetsFragment
}
}
weeklyTargets {
lineId
validFrom {
...ScheduleTimeFragment
}
id
oee
oee2
oee3
tcu
produced
numberOfBatches
mainOeeType
}
configuration {
lineId
disableLostConnectionAlarmOutsideWorkingHours
automaticStopRegistration {
...AutomaticStopRegistrationFragment
}
startDayOfWeek
timezone
}
isExceptionalWeek
isFallbackSchedule
}
}
Variables
{
"lineId": 4,
"validFrom": ScheduleTimeInput,
"shifts": [ShiftInput],
"weeklyTargets": TargetsInput,
"configuration": ScheduleConfigurationInput,
"isExceptionalWeek": false
}
Response
{
"data": {
"upsertSchedule": {
"id": 4,
"lineId": "4",
"validFrom": ScheduleTime,
"validTo": ScheduleTime,
"shifts": [Shift],
"weeklyTargets": Targets,
"configuration": ScheduleConfiguration,
"isExceptionalWeek": false,
"isFallbackSchedule": false
}
}
}
upsertTarget
Response
Returns a Targets!
Arguments
| Name | Description |
|---|---|
lineId - ID!
|
|
validFrom - ScheduleTimeInput!
|
|
weeklyTargets - TargetsInput!
|
Example
Query
mutation UpsertTarget(
$lineId: ID!,
$validFrom: ScheduleTimeInput!,
$weeklyTargets: TargetsInput!
) {
upsertTarget(
lineId: $lineId,
validFrom: $validFrom,
weeklyTargets: $weeklyTargets
) {
lineId
validFrom {
year
week
}
id
oee
oee2
oee3
tcu
produced
numberOfBatches
mainOeeType
}
}
Variables
{
"lineId": "4",
"validFrom": ScheduleTimeInput,
"weeklyTargets": TargetsInput
}
Response
{
"data": {
"upsertTarget": {
"lineId": "4",
"validFrom": ScheduleTime,
"id": "4",
"oee": 123.45,
"oee2": 123.45,
"oee3": 123.45,
"tcu": 987.65,
"produced": 987.65,
"numberOfBatches": 123.45,
"mainOeeType": "OEE1"
}
}
}
upsertWiFi
Description
Add a WiFi configuration to the specified device.
`uuid' is deprecated and used to represent the allocated software identifier.
`id' refers to the hardware identifier of the device.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
uuid - ID
|
|
id - ID
|
|
input - NetworkInput!
|
Example
Query
mutation UpsertWiFi(
$uuid: ID,
$id: ID,
$input: NetworkInput!
) {
upsertWiFi(
uuid: $uuid,
id: $id,
input: $input
)
}
Variables
{
"uuid": "4",
"id": 4,
"input": NetworkInput
}
Response
{"data": {"upsertWiFi": true}}
withdrawLearningRoleFromUser
Internal use only
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - WithdrawLearningRoleFromUserInput!
|
Example
Query
mutation WithdrawLearningRoleFromUser($input: WithdrawLearningRoleFromUserInput!) {
withdrawLearningRoleFromUser(input: $input)
}
Variables
{"input": WithdrawLearningRoleFromUserInput}
Response
{
"data": {
"withdrawLearningRoleFromUser": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
}
withdrawSkillFromUser
Internal use only
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - WithdrawSkillFromUserInput!
|
Example
Query
mutation WithdrawSkillFromUser($input: WithdrawSkillFromUserInput!) {
withdrawSkillFromUser(input: $input)
}
Variables
{"input": WithdrawSkillFromUserInput}
Response
{
"data": {
"withdrawSkillFromUser": "f6fd055e-d8b6-4525-a6a3-5d486788424e"
}
}
Types
APIToken
Fields
| Field Name | Description |
|---|---|
name - String
|
The name of the API token, visible to the user. |
description - String
|
A description of what this API token is used for. |
generatedAt - Date!
|
The date this token was issued. |
expiration - Float
|
The expiration duration of a token if set to expire. |
isActive - Boolean!
|
Whether the token is active |
userSub - ID!
|
The owner (user) of this token. |
Example
{
"name": "xyz789",
"description": "xyz789",
"generatedAt": "2007-12-03",
"expiration": 123.45,
"isActive": true,
"userSub": 4
}
AccumulatorConfig
AccumulatorConfigInput
Action
ActionMap
ActionPlan
Fields
| Field Name | Description |
|---|---|
state - ActionPlanState!
|
|
title - String!
|
|
pdcaState - ActionPlanPDCAState
|
|
followUpInterval - ActionPlanFollowUpInterval!
|
|
followUpState - Int!
|
|
dueDate - DateTime
|
|
linkedProductionData - [String!]!
|
|
version - Int!
|
|
category - ActionPlanCategory!
|
|
content - [ActionPlanContent!]!
|
|
escalations - [Escalation!]!
|
|
attachedFiles - [String!]!
|
|
tasks - [ActionPlanTask!]!
|
|
id - String!
|
Example
{
"state": "OPEN",
"title": "xyz789",
"pdcaState": "PLAN",
"followUpInterval": "DAILY",
"followUpState": 123,
"dueDate": "2007-12-03T10:15:30Z",
"linkedProductionData": ["xyz789"],
"version": 987,
"category": ActionPlanCategory,
"content": [ActionPlanContent],
"escalations": [Escalation],
"attachedFiles": ["xyz789"],
"tasks": [ActionPlanTask],
"id": "abc123"
}
ActionPlanCategory
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
meta - [ActionPlanCategoryMeta!]!
|
|
color - String!
|
|
version - Int!
|
|
nodeId - String
|
Example
{
"id": "abc123",
"meta": [ActionPlanCategoryMeta],
"color": "xyz789",
"version": 987,
"nodeId": "abc123"
}
ActionPlanCategoryInput
Fields
| Input Field | Description |
|---|---|
id - String
|
|
meta - [ActionPlanCategoryMetaInput!]!
|
|
color - String!
|
|
version - Int
|
|
nodeId - String
|
Example
{
"id": "xyz789",
"meta": [ActionPlanCategoryMetaInput],
"color": "abc123",
"version": 987,
"nodeId": "abc123"
}
ActionPlanCategoryMeta
ActionPlanCategoryMetaInput
ActionPlanContent
ActionPlanContentInput
ActionPlanFollowUpInterval
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAILY"
ActionPlanPDCAState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PLAN"
ActionPlanSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CATEGORY"
ActionPlanState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OPEN"
ActionPlanTask
Fields
| Field Name | Description |
|---|---|
content - String!
|
|
checked - Boolean!
|
|
version - Int!
|
|
plan - ActionPlan!
|
|
id - String!
|
Example
{
"content": "abc123",
"checked": false,
"version": 123,
"plan": ActionPlan,
"id": "xyz789"
}
ActionPlansPreSignedUrlsForAttachment
ActionPlansSentReminderResponse
Fields
| Field Name | Description |
|---|---|
email - String!
|
Example
{"email": "abc123"}
Actions
ActionsInput
Activity
Fields
| Field Name | Description |
|---|---|
id - ActivityId!
|
|
status - ActivityStatus!
|
|
activityTemplate - ActivityTemplate!
|
|
trigger - Trigger!
|
|
customFormData - CustomFormData
|
|
stopRegistration - ActivityStopRegistration
|
|
createdAt - DateTime!
|
|
archivedAt - DateTime
|
|
version - Int!
|
|
locationId - NodeId!
|
|
isPassing - Boolean!
|
|
batch - Batch
|
|
line - Line
|
Example
{
"id": ActivityId,
"status": "PENDING",
"activityTemplate": ActivityTemplate,
"trigger": Trigger,
"customFormData": CustomFormData,
"stopRegistration": ActivityStopRegistration,
"createdAt": "2007-12-03T10:15:30Z",
"archivedAt": "2007-12-03T10:15:30Z",
"version": 123,
"locationId": NodeId,
"isPassing": false,
"batch": Batch,
"line": Line
}
ActivityConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ActivityEdge!]!
|
A list of edges. |
nodes - [Activity!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [ActivityEdge],
"nodes": [Activity]
}
ActivityEdge
ActivityFilter
Fields
| Input Field | Description |
|---|---|
activityTemplateIds - [ActivityTemplateId!]
|
|
customFormIds - [CustomFormId!]
|
|
locationIds - [NodeId!]
|
|
statuses - [ActivityStatus!]
|
|
archivedBefore - DateTime
|
|
archivedAfter - DateTime
|
|
completedBefore - DateTime
|
|
completedAfter - DateTime
|
|
createdBefore - DateTime
|
|
createdAfter - DateTime
|
|
customFormDataValues - [CustomFormDataFilter!]
|
|
trigger - TriggerFilter
|
|
isPassing - Boolean
|
Example
{
"activityTemplateIds": [ActivityTemplateId],
"customFormIds": [CustomFormId],
"locationIds": [NodeId],
"statuses": ["PENDING"],
"archivedBefore": "2007-12-03T10:15:30Z",
"archivedAfter": "2007-12-03T10:15:30Z",
"completedBefore": "2007-12-03T10:15:30Z",
"completedAfter": "2007-12-03T10:15:30Z",
"createdBefore": "2007-12-03T10:15:30Z",
"createdAfter": "2007-12-03T10:15:30Z",
"customFormDataValues": [CustomFormDataFilter],
"trigger": TriggerFilter,
"isPassing": false
}
ActivityId
Example
ActivityId
ActivityOrdering
Fields
| Input Field | Description |
|---|---|
key - ActivityOrderingKey!
|
|
direction - OrderDirection!
|
Example
{"key": "ID", "direction": "ASCENDING"}
ActivityOrderingKey
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
ActivityStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING"
ActivityStopCause
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
description - String!
|
|
translations - [StopCauseTranslation!]!
|
|
stopType - String!
|
|
category - ActivityStopCauseCategory!
|
Example
{
"id": 4,
"name": "abc123",
"description": "abc123",
"translations": [StopCauseTranslation],
"stopType": "abc123",
"category": ActivityStopCauseCategory
}
ActivityStopCauseCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
translations - [StopCauseCategoryTranslation!]!
|
Example
{
"id": 4,
"name": "abc123",
"translations": [StopCauseCategoryTranslation]
}
ActivityStopCauseInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
translations - [StopCauseTranslationInput!]!
|
|
stopType - String!
|
|
category - StopCauseCategoryInput!
|
Example
{
"id": "4",
"translations": [StopCauseTranslationInput],
"stopType": "xyz789",
"category": StopCauseCategoryInput
}
ActivityStopRegistration
Fields
| Field Name | Description |
|---|---|
start - DateTime!
|
|
end - DateTime
|
|
comment - String
|
|
initials - String
|
|
stopCause - ActivityStopCause!
|
Example
{
"start": "2007-12-03T10:15:30Z",
"end": "2007-12-03T10:15:30Z",
"comment": "abc123",
"initials": "xyz789",
"stopCause": ActivityStopCause
}
ActivityStopRegistrationInput
Fields
| Input Field | Description |
|---|---|
start - DateTime!
|
|
end - DateTime
|
|
comment - String
|
|
initials - String
|
|
stopCause - ActivityStopCauseInput!
|
Example
{
"start": "2007-12-03T10:15:30Z",
"end": "2007-12-03T10:15:30Z",
"comment": "abc123",
"initials": "abc123",
"stopCause": ActivityStopCauseInput
}
ActivityTag
Example
{
"id": ActivityTagId,
"name": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"modifiedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"templateCount": 987
}
ActivityTagId
Example
ActivityTagId
ActivityTagInput
Fields
| Input Field | Description |
|---|---|
translations - [ActivityTagTranslationInput!]!
|
Example
{"translations": [ActivityTagTranslationInput]}
ActivityTagTranslationInput
ActivityTemplate
Fields
| Field Name | Description |
|---|---|
id - ActivityTemplateId!
|
|
title - String!
|
|
description - String!
|
|
translations - [ActivityTemplateTranslation!]!
|
|
customFormId - CustomFormId!
|
|
customFormVersion - Int!
|
|
triggers - [Trigger!]!
|
|
expiresAfterMinutes - Int
|
|
locationIds - [NodeId!]!
|
|
version - Int!
|
|
createdAt - DateTime!
|
|
deletedAt - DateTime
|
|
versions - VersionedActivityTemplatesConnection!
|
Internal use only |
customForm - CustomForm!
|
Internal use only |
tags - [ActivityTag!]!
|
Internal use only |
Example
{
"id": ActivityTemplateId,
"title": "abc123",
"description": "xyz789",
"translations": [ActivityTemplateTranslation],
"customFormId": CustomFormId,
"customFormVersion": 987,
"triggers": [Trigger],
"expiresAfterMinutes": 987,
"locationIds": [NodeId],
"version": 123,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedActivityTemplatesConnection,
"customForm": CustomForm,
"tags": [ActivityTag]
}
ActivityTemplateConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ActivityTemplateEdge!]!
|
A list of edges. |
nodes - [ActivityTemplate!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [ActivityTemplateEdge],
"nodes": [ActivityTemplate]
}
ActivityTemplateEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ActivityTemplate!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ActivityTemplate,
"cursor": "abc123"
}
ActivityTemplateFilter
Fields
| Input Field | Description |
|---|---|
locationIds - [NodeId!]
|
|
triggerConditions - TriggerConditionsFilter
|
|
triggerTypes - [TriggerTypeFilter!]
|
|
trigger - TriggerFilter
|
|
search - String
|
Example
{
"locationIds": [NodeId],
"triggerConditions": TriggerConditionsFilter,
"triggerTypes": ["MANUAL"],
"trigger": TriggerFilter,
"search": "xyz789"
}
ActivityTemplateId
Example
ActivityTemplateId
ActivityTemplateInput
Fields
| Input Field | Description |
|---|---|
translations - [ActivityTemplateTranslationInput!]!
|
|
customFormId - CustomFormId!
|
|
customFormVersion - Int!
|
|
triggers - [TriggerInput!]!
|
|
locationIds - [NodeId!]!
|
|
expiresAfterMinutes - Int
|
|
tags - [ActivityTagId!]
|
Example
{
"translations": [ActivityTemplateTranslationInput],
"customFormId": CustomFormId,
"customFormVersion": 987,
"triggers": [TriggerInput],
"locationIds": [NodeId],
"expiresAfterMinutes": 987,
"tags": [ActivityTagId]
}
ActivityTemplateTranslation
ActivityTemplateTranslationInput
ActivityTriggerType
Fields
| Field Name | Description |
|---|---|
manual - ManualTriggerOptions
|
|
everyXProduced - EveryXProducedTriggerOptions
|
|
everyXMinutes - EveryXMinutesTriggerOptions
|
|
stopRegistration - StopRegistrationTriggerOptions
|
|
batchStart - BatchStartTriggerOptions
|
|
batchEnd - BatchEndTriggerOptions
|
|
batchProgress - BatchProgressTriggerOptions
|
|
shiftStart - ShiftStartTriggerOptions
|
|
shiftEnd - ShiftEndTriggerOptions
|
|
fixedTime - FixedTimeTriggerOptions
|
Example
{
"manual": ManualTriggerOptions,
"everyXProduced": EveryXProducedTriggerOptions,
"everyXMinutes": EveryXMinutesTriggerOptions,
"stopRegistration": StopRegistrationTriggerOptions,
"batchStart": BatchStartTriggerOptions,
"batchEnd": BatchEndTriggerOptions,
"batchProgress": BatchProgressTriggerOptions,
"shiftStart": ShiftStartTriggerOptions,
"shiftEnd": ShiftEndTriggerOptions,
"fixedTime": FixedTimeTriggerOptions
}
ActivityTriggerTypeInput
Fields
| Input Field | Description |
|---|---|
manual - ManualTriggerOptionsInput
|
|
everyXProduced - EveryXProducedTriggerOptionsInput
|
|
everyXMinutes - EveryXMinutesTriggerOptionsInput
|
|
stopRegistration - StopRegistrationTriggerOptionsInput
|
|
batchStart - BatchStartTriggerOptionsInput
|
|
batchEnd - BatchEndTriggerOptionsInput
|
|
batchProgress - BatchProgressTriggerOptionsInput
|
|
shiftStart - ShiftStartTriggerOptionsInput
|
|
shiftEnd - ShiftEndTriggerOptionsInput
|
|
fixedTime - FixedTimeTriggerOptionsInput
|
Example
{
"manual": ManualTriggerOptionsInput,
"everyXProduced": EveryXProducedTriggerOptionsInput,
"everyXMinutes": EveryXMinutesTriggerOptionsInput,
"stopRegistration": StopRegistrationTriggerOptionsInput,
"batchStart": BatchStartTriggerOptionsInput,
"batchEnd": BatchEndTriggerOptionsInput,
"batchProgress": BatchProgressTriggerOptionsInput,
"shiftStart": ShiftStartTriggerOptionsInput,
"shiftEnd": ShiftEndTriggerOptionsInput,
"fixedTime": FixedTimeTriggerOptionsInput
}
Alarm
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
description - String!
|
|
peripheralId - ID!
|
|
status - AlarmStatus!
|
|
threshold - Int!
|
|
repeatNotification - Boolean!
|
|
enabled - Boolean!
|
|
type - AlarmType!
|
|
alarmConfiguration - AlarmConfiguration!
|
|
languageCode - String!
|
|
snoozeDuration - Int
|
|
alarmLogs - AlarmLogs!
|
|
Arguments
|
|
subscribers - [SubscriberOutput!]!
|
|
timeRange - TimeRange
|
|
peripheral - Peripheral
|
|
Example
{
"id": 4,
"name": "abc123",
"description": "xyz789",
"peripheralId": 4,
"status": "NORMAL",
"threshold": 987,
"repeatNotification": false,
"enabled": false,
"type": "AboveX",
"alarmConfiguration": AlarmConfiguration,
"languageCode": "abc123",
"snoozeDuration": 123,
"alarmLogs": AlarmLogs,
"subscribers": [SubscriberOutput],
"timeRange": TimeRange,
"peripheral": Peripheral
}
AlarmConfiguration
Fields
| Field Name | Description |
|---|---|
x - Float
|
|
t - Float
|
|
y - Float
|
|
n - Float
|
|
stopType - StopTypeForAlarms
|
Example
{"x": 987.65, "t": 123.45, "y": 987.65, "n": 987.65, "stopType": "NO_ACT"}
AlarmConfigurationInput
Fields
| Input Field | Description |
|---|---|
x - Float
|
|
t - Float
|
|
y - Float
|
|
n - Float
|
|
stopType - StopTypeForAlarms
|
Example
{"x": 987.65, "t": 123.45, "y": 123.45, "n": 123.45, "stopType": "NO_ACT"}
AlarmLog
Fields
| Field Name | Description |
|---|---|
status - AlarmStatus!
|
|
timeRange - TimeRange!
|
|
lastNotification - Date
|
|
createdAt - Date
|
|
start - Date
|
|
config - AlarmLogConfig
|
Example
{
"status": "NORMAL",
"timeRange": TimeRange,
"lastNotification": "2007-12-03",
"createdAt": "2007-12-03",
"start": "2007-12-03",
"config": AlarmLogConfig
}
AlarmLogConfig
Fields
| Field Name | Description |
|---|---|
stopType - StopTypeForAlarms
|
|
t - Float
|
Example
{"stopType": "NO_ACT", "t": 123.45}
AlarmLogExclusiveStartKey
AlarmLogFilter
Fields
| Input Field | Description |
|---|---|
status - AlarmStatus
|
|
start - String
|
Example
{"status": "NORMAL", "start": "abc123"}
AlarmLogLastEvaluatedKey
AlarmLogOrder
Fields
| Input Field | Description |
|---|---|
byStart - Ordering
|
Example
{"byStart": "Ascending"}
AlarmLogs
Fields
| Field Name | Description |
|---|---|
lastEvaluatedKey - AlarmLogLastEvaluatedKey
|
|
entries - [AlarmLog]!
|
Example
{
"lastEvaluatedKey": AlarmLogLastEvaluatedKey,
"entries": [AlarmLog]
}
AlarmStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NORMAL"
AlarmType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AboveX"
AnalogInputRange
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NEGATIVE_TEN_TO_TEN_VOLTS"
AnalyticsDocumentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PARETO"
Andon
Description
Andon is the operator-technician communication maintenance module of Factbird. This module enables operators to contact technicians from the stop registration dialog or through the API from the andon-prefixed mutations listed under Mutations.
An Andon call can be in one of four states, called, taken, pending and resolved. Pending is an experimental state as of this writing and is not publicly available. These states enable the operator and technician to document the steps taken to resolve a technical problem.
This full history of events is tracked by summary of details for each individual call.
Fields
| Field Name | Description |
|---|---|
calls - [Call!]!
|
The list of Andon calls in a given week with filters enabling to only list resolved, unresolved and lines initiated from a specific line. |
companyId - ID!
|
Currently scoped per company, this identifier is subject to change. |
extensions - [Extension!]
|
Not available for public use and is subject to change for external system interfacing. |
schedule - MaintenanceSchedule
|
To be replaced by _schedule with Andon 2.0. |
tags - [Tag!]!
|
To be redesigned with Andon 3.0. |
supportTypes - [SupportType!]!
|
To be replaced by roles with Andon 2.0. |
Arguments
|
|
workOrderKeys - [WorkOrderKey!]
|
To be redesigned with Andon 3.0. |
Arguments
|
|
workers - [Worker!]!
|
The list of set up `workers'. A worker represents someone at the receiving end for notifications. For that, Factbird requires information about the email and/or phone number of that person. |
roles - [AndonRole!]!
|
The list of configured roles that a worker can be assigned. Electrician, Blacksmith etc. |
schedules - [AndonSchedule!]!
|
|
_schedule - AndonSchedule!
|
|
Arguments
|
|
Example
{
"calls": [Call],
"companyId": "4",
"extensions": [Extension],
"schedule": MaintenanceSchedule,
"tags": [Tag],
"supportTypes": [SupportType],
"workOrderKeys": [WorkOrderKey],
"workers": [Worker],
"roles": [AndonRole],
"schedules": [AndonSchedule],
"_schedule": AndonSchedule
}
AndonRole
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
escalationConfiguration - [EscalationConfiguration!]
|
Example
{
"id": 4,
"name": "xyz789",
"escalationConfiguration": [EscalationConfiguration]
}
AndonSchedule
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
lineIds - [ID!]!
|
|
shifts - [AndonShift!]!
|
|
Arguments
|
|
shift - [AndonShift!]!
|
|
Arguments
|
|
lines - [Line!]!
|
Lists lines covered by this Andon schedule. |
Example
{
"id": "4",
"name": "abc123",
"lineIds": [4],
"shifts": [AndonShift],
"shift": [AndonShift],
"lines": [Line]
}
AndonShift
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
duration - Float!
|
|
rRuleSet - String!
|
|
attendees - [AttendingWorker!]!
|
|
Arguments
|
|
description - String
|
|
Example
{
"id": "4",
"name": "xyz789",
"duration": 123.45,
"rRuleSet": "abc123",
"attendees": [AttendingWorker],
"description": "xyz789"
}
AndonShiftInput
Fields
| Input Field | Description |
|---|---|
timeFilter - TimeFilter
|
Example
{"timeFilter": TimeFilter}
AppClient
AssetNodeMeta
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
description - String!
|
|
labels - [String!]!
|
Example
{
"name": "xyz789",
"description": "xyz789",
"labels": ["abc123"]
}
AssetNodeMetaInput
AssistantConversation
Description
A conversation between a human and an AI assistant
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
messages - [ConversationMessage!]!
|
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"messages": [ConversationMessage]
}
AttendanceInput
Attendee
Example
{
"id": 4,
"supportId": 4,
"email": "xyz789",
"phoneNumber": "xyz789",
"userSub": "abc123",
"dateExceptions": ["2007-12-03"],
"messages": [Message]
}
AttendeesInput
Fields
| Input Field | Description |
|---|---|
includeExcluded - Boolean
|
Example
{"includeExcluded": true}
AttendingWorker
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
email - String
|
|
phoneNumber - String
|
|
userSub - String
|
This feature is experimental and might be replaced |
role - AndonRole!
|
Workers may now reference multiple roles. |
roles - [AndonRole!]!
|
|
preferredSchedules - [AndonSchedule!]!
|
|
isPermanent - Boolean
|
|
isExcluded - Boolean
|
Example
{
"id": 4,
"name": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"userSub": "abc123",
"role": AndonRole,
"roles": [AndonRole],
"preferredSchedules": [AndonSchedule],
"isPermanent": true,
"isExcluded": true
}
AutomaticStopRegistration
AutomaticStopRegistrationInput
AverageProducedInput
Fields
| Input Field | Description |
|---|---|
duration - Float!
|
Example
{"duration": 987.65}
BarChart
Fields
| Field Name | Description |
|---|---|
xAxisLabel - String!
|
The label to use for the x-axis. |
yAxisLabel - String!
|
The label to use for the y-axis. |
xAxisField - String!
|
The field to use for the x-axis. This is a reference to the data field in the VisualizationOptions. |
yAxisField - String!
|
The field to use for the y-axis. This is a reference to the data field in the VisualizationOptions. |
xAxisType - String!
|
The type to use for the x-axis. |
xAxisTimeUnit - String
|
The time unit to use for the x-axis. |
xAxisSortField - String
|
The field to use for sorting the x-axis. |
yAxisType - String!
|
The type to use for the y-axis. |
yAxisDomain - [JSON!]
|
The domain to use for the y-axis. |
colorField - String
|
The color to use |
Example
{
"xAxisLabel": "abc123",
"yAxisLabel": "xyz789",
"xAxisField": "xyz789",
"yAxisField": "xyz789",
"xAxisType": "xyz789",
"xAxisTimeUnit": "xyz789",
"xAxisSortField": "xyz789",
"yAxisType": "abc123",
"yAxisDomain": [{}],
"colorField": "xyz789"
}
BaseBatch
BaseProduct
Fields
| Field Name | Description |
|---|---|
productId - ID!
|
|
name - String!
|
|
itemNumber - String!
|
|
validatedLineSpeed - Float!
|
|
expectedAverageSpeed - Float!
|
|
parameters - [Parameter!]!
|
Possible Types
| BaseProduct Types |
|---|
Example
{
"productId": 4,
"name": "xyz789",
"itemNumber": "abc123",
"validatedLineSpeed": 987.65,
"expectedAverageSpeed": 123.45,
"parameters": [Parameter]
}
BaseStop
Fields
| Field Name | Description |
|---|---|
_id - ID!
|
|
timeRange - TimeRange!
|
|
originalStart - Date!
|
|
ongoing - Boolean!
|
|
duration - Float!
|
|
stopCause - StopCause
|
|
comment - String
|
|
initials - String
|
|
countermeasure - String
|
|
countermeasureInitials - String
|
|
registeredTime - Date
|
|
isMicroStop - Boolean!
|
|
isAutomaticRegistration - Boolean
|
|
standalone - StandaloneConfiguration
|
Possible Types
| BaseStop Types |
|---|
Example
{
"_id": "4",
"timeRange": TimeRange,
"originalStart": "2007-12-03",
"ongoing": false,
"duration": 123.45,
"stopCause": StopCause,
"comment": "abc123",
"initials": "xyz789",
"countermeasure": "abc123",
"countermeasureInitials": "xyz789",
"registeredTime": "2007-12-03",
"isMicroStop": true,
"isAutomaticRegistration": true,
"standalone": StandaloneConfiguration
}
Batch
Fields
| Field Name | Description |
|---|---|
actualStart - Date
|
|
actualStop - Date
|
|
amount - Float!
|
|
batchId - ID!
|
|
batchNumber - String!
|
|
comment - String
|
|
lineId - ID!
|
|
manualScrap - Float
|
|
plannedStart - Date
|
|
produced - Float
|
|
product - Product!
|
|
sorting - String!
|
|
state - BatchState!
|
|
tags - [String!]
|
|
controls - [BatchControl!]!
|
|
samples - [Sample!]!
|
Get the samples collected within the timespan of the batch. |
Arguments
|
|
stops - [Stop!]!
|
Get the stops collected within the timespan of the batch. |
Arguments
|
|
stopStats - StopStats!
|
|
Arguments
|
|
stats - Stat!
|
Get the stats collected within the timespan of the batch. |
scrap - [Sample!]!
|
Get all the scrapped samples within the timespan of the batch. |
Arguments
|
|
createdBy - User!
|
Get the user who created this batch. |
line - Line!
|
Get the line related to this batch. |
Arguments
|
|
plannedEtc - Date
|
Get the estimated time of completion for the batch, if started on 'plannedStart'. Will be null if shift schedule is taken into account, and the date ends up being more than a month in the |
actualEtc - Date
|
Get the estimated time of completion for the batch, if started on 'actualStart'. Will be null if shift schedule is taken into account, and the date ends up being more than a month in the future |
Example
{
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 123.45,
"batchId": "4",
"batchNumber": "abc123",
"comment": "xyz789",
"lineId": 4,
"manualScrap": 987.65,
"plannedStart": "2007-12-03",
"produced": 987.65,
"product": Product,
"sorting": "abc123",
"state": "COMPLETED",
"tags": ["abc123"],
"controls": [BatchControl],
"samples": [Sample],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat,
"scrap": [Sample],
"createdBy": User,
"line": Line,
"plannedEtc": "2007-12-03",
"actualEtc": "2007-12-03"
}
BatchControl
Fields
| Field Name | Description |
|---|---|
batchControlId - ID!
|
|
batchId - ID!
|
|
comment - String
|
|
controlReceiptId - ID!
|
|
controlReceiptName - String!
|
|
entryId - ID!
|
|
fieldValues - [BatchControlFieldValue!]!
|
|
followUp - FollowUpSettings!
|
|
history - [BatchControlHistory!]!
|
|
initials - String
|
|
initialsSettings - InitialsSettings!
|
|
originalControl - OriginalControlDetails
|
|
status - BatchControlStatus!
|
|
timeControlUpdated - Date
|
|
timeControlled - Date
|
|
timeTriggered - Date!
|
|
title - String
|
|
trigger - ControlTrigger!
|
Example
{
"batchControlId": "4",
"batchId": "4",
"comment": "abc123",
"controlReceiptId": "4",
"controlReceiptName": "abc123",
"entryId": "4",
"fieldValues": [BatchControlFieldValue],
"followUp": FollowUpSettings,
"history": [BatchControlHistory],
"initials": "xyz789",
"initialsSettings": "REQUIRED_IF_OUTSIDE_LIMITS",
"originalControl": OriginalControlDetails,
"status": "CANCELED",
"timeControlUpdated": "2007-12-03",
"timeControlled": "2007-12-03",
"timeTriggered": "2007-12-03",
"title": "abc123",
"trigger": ControlTrigger
}
BatchControlFieldInput
BatchControlFieldValue
Fields
| Field Name | Description |
|---|---|
controlReceiptField - ControlReceiptEntryField!
|
|
value - String
|
Example
{
"controlReceiptField": ControlReceiptEntryField,
"value": "abc123"
}
BatchControlHistory
Fields
| Field Name | Description |
|---|---|
comment - String
|
|
fieldValues - [BatchControlFieldValue!]!
|
|
initials - String
|
|
status - BatchControlStatus!
|
|
timeControlUpdated - Date
|
|
timeControlled - Date
|
Example
{
"comment": "abc123",
"fieldValues": [BatchControlFieldValue],
"initials": "xyz789",
"status": "CANCELED",
"timeControlUpdated": "2007-12-03",
"timeControlled": "2007-12-03"
}
BatchControlList
Fields
| Field Name | Description |
|---|---|
nextToken - ID
|
|
items - [BatchControl!]!
|
Example
{"nextToken": 4, "items": [BatchControl]}
BatchControlStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CANCELED"
BatchEndTriggerOptions
Fields
| Field Name | Description |
|---|---|
placeholder - Boolean
|
Example
{"placeholder": false}
BatchEndTriggerOptionsInput
Fields
| Input Field | Description |
|---|---|
placeholder - Boolean
|
Example
{"placeholder": true}
BatchFilter
Example
{
"batchId": 4,
"batchNumber": "abc123",
"exclusiveFromCheck": true,
"from": "2007-12-03",
"includeSurroundingBatches": true,
"itemNumber": "xyz789",
"packagingId": "4",
"productId": 4,
"productIds": ["4"],
"productName": "abc123",
"searchField": ["xyz789"],
"state": "COMPLETED",
"to": "2007-12-03"
}
BatchList
BatchProgressTriggerOptions
Fields
| Field Name | Description |
|---|---|
percentage - Int!
|
Allowed values: [0; 100] |
Example
{"percentage": 123}
BatchProgressTriggerOptionsInput
Fields
| Input Field | Description |
|---|---|
percentage - Int!
|
Allowed values: [0; 100] |
Example
{"percentage": 987}
BatchStartTriggerOptions
Fields
| Field Name | Description |
|---|---|
placeholder - Boolean
|
Example
{"placeholder": true}
BatchStartTriggerOptionsInput
Fields
| Input Field | Description |
|---|---|
placeholder - Boolean
|
Example
{"placeholder": true}
BatchState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
BatchesInput
Fields
| Input Field | Description |
|---|---|
preferences - BatchesPreference
|
|
batchFilter - BatchFilter
|
Example
{
"preferences": BatchesPreference,
"batchFilter": BatchFilter
}
BatchesPreference
Fields
| Input Field | Description |
|---|---|
exclusiveBatchTime - Boolean
|
Example
{"exclusiveBatchTime": false}
Boolean
Description
The Boolean scalar type represents true or false.
Breadcrumb
Call
Example
{
"id": "4",
"urgency": "MEDIUM",
"requestedSupport": "abc123",
"role": AndonRole,
"tags": [Tag],
"lineId": 4,
"workOrder": WorkOrder,
"action": ActionMap,
"lastMessage": "2007-12-03",
"line": Line
}
Camera
Fields
| Field Name | Description |
|---|---|
_id - ID
|
|
id - ID!
|
Use peripheralId instead.
|
name - String!
|
|
index - ID!
|
|
peripheralId - ID!
|
|
owner - ID
|
|
hardwareId - ID
|
|
peripheralType - PeripheralType!
|
|
description - String!
|
|
offlineStatus - OfflineStatus!
|
|
attachedSensors - [Sensor]!
|
|
streamURL - String
|
|
Arguments
|
|
device - Device!
|
|
hardwareDevice - Device
|
|
Example
{
"_id": "4",
"id": "4",
"name": "abc123",
"index": 4,
"peripheralId": "4",
"owner": "4",
"hardwareId": 4,
"peripheralType": "CAMERA",
"description": "abc123",
"offlineStatus": OfflineStatus,
"attachedSensors": [Sensor],
"streamURL": "abc123",
"device": Device,
"hardwareDevice": Device
}
CameraConfigInput
Fields
| Input Field | Description |
|---|---|
retentionPeriodHours - Int
|
Example
{"retentionPeriodHours": 123}
Certificate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The identifier of the certificate. |
isActive - Boolean!
|
Whether the certificate is active. |
createdAt - Date!
|
The time when the certificate was created. |
validAt - Date
|
The time when the certificate was activated. |
expiresAt - Date!
|
The time when the certificate will expire. |
subject - String!
|
The subject of the certificate. |
issuer - String!
|
The issuer of the certificate. |
Example
{
"id": "4",
"isActive": false,
"createdAt": "2007-12-03",
"validAt": "2007-12-03",
"expiresAt": "2007-12-03",
"subject": "abc123",
"issuer": "xyz789"
}
ChangeoverStop
Fields
| Field Name | Description |
|---|---|
_id - ID!
|
|
timeRange - TimeRange!
|
|
originalStart - Date!
|
|
ongoing - Boolean!
|
|
duration - Float!
|
|
stopCause - StopCause
|
|
comment - String
|
|
initials - String
|
|
registeredTime - Date
|
|
isMicroStop - Boolean!
|
|
isAutomaticRegistration - Boolean
|
|
standalone - StandaloneConfiguration
|
|
countermeasure - String
|
|
countermeasureInitials - String
|
|
target - ChangeoverTarget
|
Example
{
"_id": 4,
"timeRange": TimeRange,
"originalStart": "2007-12-03",
"ongoing": false,
"duration": 987.65,
"stopCause": StopCause,
"comment": "xyz789",
"initials": "xyz789",
"registeredTime": "2007-12-03",
"isMicroStop": true,
"isAutomaticRegistration": false,
"standalone": StandaloneConfiguration,
"countermeasure": "xyz789",
"countermeasureInitials": "xyz789",
"target": ChangeoverTarget
}
ChangeoverTarget
Fields
| Field Name | Description |
|---|---|
target - Float!
|
|
previousBatch - MinimalBatch
|
|
nextBatch - MinimalBatch
|
|
shift - Shift
|
Example
{
"target": 987.65,
"previousBatch": MinimalBatch,
"nextBatch": MinimalBatch,
"shift": Shift
}
ChartConfiguration
Fields
| Field Name | Description |
|---|---|
scale - ChartTimeScale
|
|
dataFilter - DataFilter
|
Example
{"scale": "DAY", "dataFilter": "AVERAGE_SPEED"}
ChartConfigurationInput
Fields
| Input Field | Description |
|---|---|
scale - ChartTimeScale
|
|
dataFilter - DataFilter
|
Example
{"scale": "DAY", "dataFilter": "AVERAGE_SPEED"}
ChartTimeScale
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DAY"
CheckboxFieldOptions
Fields
| Field Name | Description |
|---|---|
mustBeTrue - Boolean!
|
Example
{"mustBeTrue": true}
CheckboxFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
mustBeTrue - Boolean!
|
Example
{"mustBeTrue": true}
Claim
ClaimDeviceInput
Fields
| Input Field | Description |
|---|---|
hardwareId - ID!
|
Example
{"hardwareId": 4}
ClaimId
Example
ClaimId
Claims
Fields
| Field Name | Description |
|---|---|
index - [Claim!]!
|
|
resources - [Resource!]!
|
Example
{
"index": [Claim],
"resources": [Resource]
}
Company
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String
|
|
groups - [Group!]!
|
|
roles - [Role!]!
|
|
users - UserList!
|
|
Arguments |
|
group - Group!
|
|
Arguments
|
|
appClients - [AppClient!]!
|
|
trialStatus - TrialStatus
|
|
Example
{
"id": "4",
"name": "xyz789",
"groups": [Group],
"roles": [Role],
"users": UserList,
"group": Group,
"appClients": [AppClient],
"trialStatus": TrialStatus
}
ConsolidatedData
Fields
| Field Name | Description |
|---|---|
timeRange - TimeRange!
|
|
oee - OEE
|
|
stopsData - [LineStopStats]
|
|
Example
{
"timeRange": TimeRange,
"oee": OEE,
"stopsData": [LineStopStats]
}
ControlDerivationFormula
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"MIN"
ControlFieldType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TEXT"
ControlReceipt
Fields
| Field Name | Description |
|---|---|
controlReceiptId - ID!
|
|
userPoolId - ID!
|
|
name - String!
|
|
description - String
|
|
entries - [ControlReceiptEntry!]!
|
|
deleted - Boolean!
|
|
attachedProducts - [Product!]!
|
Example
{
"controlReceiptId": 4,
"userPoolId": "4",
"name": "xyz789",
"description": "xyz789",
"entries": [ControlReceiptEntry],
"deleted": true,
"attachedProducts": [Product]
}
ControlReceiptEntry
Fields
| Field Name | Description |
|---|---|
entryId - ID!
|
|
title - String
|
|
trigger - ControlTrigger!
|
|
followUp - FollowUpSettings!
|
|
initialsSettings - InitialsSettings!
|
|
fields - [ControlReceiptEntryField!]!
|
Example
{
"entryId": "4",
"title": "xyz789",
"trigger": ControlTrigger,
"followUp": FollowUpSettings,
"initialsSettings": "REQUIRED_IF_OUTSIDE_LIMITS",
"fields": [ControlReceiptEntryField]
}
ControlReceiptEntryField
Fields
| Field Name | Description |
|---|---|
fieldId - ID!
|
|
label - String!
|
|
description - String
|
|
type - ControlFieldType!
|
|
limits - ControlReceiptEntryFieldLimits
|
|
derivationSettings - ControlReceiptEntryFieldDerivationSettings
|
|
sensorId - ID
|
Example
{
"fieldId": "4",
"label": "xyz789",
"description": "xyz789",
"type": "TEXT",
"limits": ControlReceiptEntryFieldLimits,
"derivationSettings": ControlReceiptEntryFieldDerivationSettings,
"sensorId": "4"
}
ControlReceiptEntryFieldDerivationSettings
Fields
| Field Name | Description |
|---|---|
formula - ControlDerivationFormula!
|
|
fields - [String!]!
|
Example
{"formula": "MIN", "fields": ["xyz789"]}
ControlReceiptEntryFieldDerivationSettingsInput
Fields
| Input Field | Description |
|---|---|
formula - ControlDerivationFormula!
|
|
fields - [String!]!
|
Example
{"formula": "MIN", "fields": ["abc123"]}
ControlReceiptEntryFieldInput
Fields
| Input Field | Description |
|---|---|
fieldId - String!
|
|
label - String!
|
|
description - String
|
|
type - ControlFieldType!
|
|
limits - ControlReceiptentryFieldLimitsInput
|
|
derivationSettings - ControlReceiptEntryFieldDerivationSettingsInput
|
|
sensorId - ID
|
Example
{
"fieldId": "xyz789",
"label": "abc123",
"description": "xyz789",
"type": "TEXT",
"limits": ControlReceiptentryFieldLimitsInput,
"derivationSettings": ControlReceiptEntryFieldDerivationSettingsInput,
"sensorId": "4"
}
ControlReceiptEntryFieldLimits
ControlReceiptEntryInput
Fields
| Input Field | Description |
|---|---|
entryId - String
|
|
title - String
|
|
trigger - ControlTriggerInput!
|
|
followUp - FollowUpSettingsInput!
|
|
initialsSettings - InitialsSettings
|
|
fields - [ControlReceiptEntryFieldInput!]!
|
Example
{
"entryId": "xyz789",
"title": "xyz789",
"trigger": ControlTriggerInput,
"followUp": FollowUpSettingsInput,
"initialsSettings": "REQUIRED_IF_OUTSIDE_LIMITS",
"fields": [ControlReceiptEntryFieldInput]
}
ControlReceiptFilter
Fields
| Input Field | Description |
|---|---|
name - String
|
Example
{"name": "xyz789"}
ControlReceiptList
Fields
| Field Name | Description |
|---|---|
nextToken - ID
|
|
items - [ControlReceipt!]!
|
Example
{
"nextToken": "4",
"items": [ControlReceipt]
}
ControlReceiptentryFieldLimitsInput
ControlTrigger
Fields
| Field Name | Description |
|---|---|
type - ControlTriggerType!
|
|
payload - TimedTriggerPayload
|
|
delayWhenStopped - Boolean!
|
Example
{
"type": "START_OF_BATCH",
"payload": TimedTriggerPayload,
"delayWhenStopped": true
}
ControlTriggerInput
Fields
| Input Field | Description |
|---|---|
type - ControlTriggerType!
|
|
payload - TimedTriggerPayloadInput
|
|
delayWhenStopped - Boolean!
|
Example
{
"type": "START_OF_BATCH",
"payload": TimedTriggerPayloadInput,
"delayWhenStopped": false
}
ControlTriggerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Use RECURRING_FROM_EPOCH instead.
|
|
|
Use RECURRING_FROM_BATCH_START instead.
|
|
|
Use RECURRING_FROM_BATCH_START instead.
|
|
|
Use RECURRING_FROM_BATCH_START instead.
|
|
|
Use RECURRING_FROM_BATCH_START instead.
|
|
|
Use RECURRING_FROM_BATCH_START instead.
|
|
|
Use RECURRING_FROM_BATCH_START instead.
|
|
|
|
|
|
|
|
|
Trigger for initiating controls manually |
Example
"START_OF_BATCH"
ConversationContent
Types
| Union Types |
|---|
Example
ConversationContentText
ConversationContentText
Fields
| Field Name | Description |
|---|---|
text - String!
|
Example
{"text": "abc123"}
ConversationContentVisualizationOptions
Fields
| Field Name | Description |
|---|---|
title - String!
|
|
visualizationType - VisualizationType!
|
|
data - JSON!
|
Example
{
"title": "xyz789",
"visualizationType": BarChart,
"data": {}
}
ConversationMessage
Fields
| Field Name | Description |
|---|---|
role - ConversationRole!
|
|
messageId - UUID!
|
|
status - MessageStatus!
|
|
content - [ConversationContent!]!
|
Example
{
"role": "USER",
"messageId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"status": "COMPLETE",
"content": [ConversationContentText]
}
ConversationRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"USER"
CountByStatus
CreateActionPlanInput
Fields
| Input Field | Description |
|---|---|
category - String!
|
|
title - String
|
|
content - [ActionPlanContentInput!]!
|
|
pdcaState - ActionPlanPDCAState
|
|
followUpInterval - ActionPlanFollowUpInterval!
|
|
followUpState - Int
|
|
linkedProductionData - [String!]
|
|
attachedFiles - [String!]
|
|
assignedSub - String
|
|
dueDate - DateTime
|
Example
{
"category": "xyz789",
"title": "xyz789",
"content": [ActionPlanContentInput],
"pdcaState": "PLAN",
"followUpInterval": "DAILY",
"followUpState": 123,
"linkedProductionData": ["abc123"],
"attachedFiles": ["abc123"],
"assignedSub": "abc123",
"dueDate": "2007-12-03T10:15:30Z"
}
CreateActionPlanTaskInput
CreateActivityInput
Fields
| Input Field | Description |
|---|---|
status - ActivityStatus!
|
|
activityTemplateId - ActivityTemplateId!
|
|
triggerId - TriggerId!
|
|
values - [CustomFieldValueInput!]
|
|
stopRegistration - ActivityStopRegistrationInput
|
|
locationId - NodeId!
|
|
initials - String
|
Example
{
"status": "PENDING",
"activityTemplateId": ActivityTemplateId,
"triggerId": TriggerId,
"values": [CustomFieldValueInput],
"stopRegistration": ActivityStopRegistrationInput,
"locationId": NodeId,
"initials": "abc123"
}
CreateAppClientInput
CreateAppClientOutput
Fields
| Field Name | Description |
|---|---|
clientSecret - String!
|
A one-time exposed, sensitive client secret to be passed to the Authorization header, i.e. Authorization: Basic base64(clientId:clientSecret) to issue short-lived access tokens. |
appClient - AppClient!
|
The underlying App client. |
Example
{
"clientSecret": "abc123",
"appClient": AppClient
}
CreateBatchByItemNumberInput
Description
Create a batch by item number inputs.
Example
{
"lineId": 4,
"itemNumber": "xyz789",
"batchNumber": "abc123",
"plannedStart": "2007-12-03",
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 987.65,
"manualScrap": 123.45,
"comment": "xyz789",
"dataMultiplier": 123.45,
"validatedLineSpeed": 123.45,
"expectedAverageSpeed": 987.65,
"forceStop": false
}
CreateDeviceInput
Fields
| Input Field | Description |
|---|---|
type - String!
|
The type of the device (only accepts 'plc' as of this writing) |
Example
{"type": "xyz789"}
CreateHierarchyNodeInput
Fields
| Input Field | Description |
|---|---|
parentId - NodeId!
|
|
meta - CreateHierarchyNodeMetaInput!
|
|
attachments - HierarchyNodeAttachmentsInput
|
Example
{
"parentId": NodeId,
"meta": CreateHierarchyNodeMetaInput,
"attachments": HierarchyNodeAttachmentsInput
}
CreateHierarchyNodeMetaInput
Fields
| Input Field | Description |
|---|---|
line - LineNodeMetaInput
|
|
directory - DirectoryNodeMetaInput
|
|
peripheral - PeripheralNodeMetaInput
|
|
asset - AssetNodeMetaInput
|
Example
{
"line": LineNodeMetaInput,
"directory": DirectoryNodeMetaInput,
"peripheral": PeripheralNodeMetaInput,
"asset": AssetNodeMetaInput
}
CreateIOTJobResponse
Example
{
"otaUpdateArn": "abc123",
"otaUpdateId": "xyz789",
"otaUpdateStatus": "abc123",
"jobId": "abc123",
"jobArn": "xyz789",
"description": "abc123"
}
CreateLearningActivityInput
Example
{
"nodeId": "abc123",
"title": "abc123",
"description": "abc123",
"content": "xyz789",
"startEndDatesRequired": false,
"validityInMonths": 123
}
CreateLearningRoleInput
CreateMaintenanceLogEntryInput
Fields
| Input Field | Description |
|---|---|
planId - MaintenancePlanId
|
|
lineId - LineId!
|
|
status - WorkOrderStatus!
|
|
initials - String!
|
|
comment - String!
|
|
customData - CustomFormDataInput
|
|
andonCallId - String
|
|
stopCauseIds - [String!]
|
|
stopCausePeripheralId - PeripheralId
|
|
assetIds - [NodeId!]
|
|
startOfService - DateTime
|
|
endOfService - DateTime
|
|
startOfStop - DateTime
|
|
endOfStop - DateTime
|
Example
{
"planId": MaintenancePlanId,
"lineId": LineId,
"status": "COMPLETED",
"initials": "abc123",
"comment": "abc123",
"customData": CustomFormDataInput,
"andonCallId": "xyz789",
"stopCauseIds": ["xyz789"],
"stopCausePeripheralId": PeripheralId,
"assetIds": [NodeId],
"startOfService": "2007-12-03T10:15:30Z",
"endOfService": "2007-12-03T10:15:30Z",
"startOfStop": "2007-12-03T10:15:30Z",
"endOfStop": "2007-12-03T10:15:30Z"
}
CreateMaintenancePlanInput
Fields
| Input Field | Description |
|---|---|
lineId - LineId!
|
|
title - String!
|
|
asset - String!
|
|
tagPartNumber - String
|
|
instructions - String
|
|
startFrom - DateTime!
|
|
repeat - ShouldRepeat!
|
|
trackBy - TrackByOptionsInput!
|
|
roleId - MaintenanceRoleId
|
Example
{
"lineId": LineId,
"title": "xyz789",
"asset": "xyz789",
"tagPartNumber": "xyz789",
"instructions": "abc123",
"startFrom": "2007-12-03T10:15:30Z",
"repeat": "YES",
"trackBy": TrackByOptionsInput,
"roleId": MaintenanceRoleId
}
CreateNodeInput
CreatePeripheralInput
CreateSkillInput
CreateWebhookInput
Fields
| Input Field | Description |
|---|---|
url - String!
|
The URL to which the webhook will send requests. |
description - String
|
An optional description for the webhook. |
headers - JSON!
|
The headers that will be sent with the webhook request. |
triggerType - String!
|
The type of trigger for the webhook. Can be "batch_start" or "batch_end". |
Example
{
"url": "xyz789",
"description": "xyz789",
"headers": {},
"triggerType": "abc123"
}
CreatedDevice
CustomFieldValue
Fields
| Field Name | Description |
|---|---|
key - CustomFormFieldId!
|
|
value - JSON!
|
|
isPassing - Boolean
|
Example
{"key": CustomFormFieldId, "value": {}, "isPassing": true}
CustomFieldValueInput
Fields
| Input Field | Description |
|---|---|
key - CustomFormFieldId!
|
|
value - JSON!
|
Example
{"key": CustomFormFieldId, "value": {}}
CustomForm
Fields
| Field Name | Description |
|---|---|
id - CustomFormId!
|
|
title - String!
|
|
description - String!
|
|
translations - [CustomFormTranslation!]!
|
|
fields - [CustomFormField!]!
|
|
requireInitials - Boolean!
|
|
version - Int!
|
|
createdAt - DateTime!
|
|
deletedAt - DateTime
|
|
versions - VersionedCustomFormsConnection!
|
Fetch all versions of this form. Note that if the form is deleted, this will return an empty list. Internal use only |
Example
{
"id": CustomFormId,
"title": "xyz789",
"description": "abc123",
"translations": [CustomFormTranslation],
"fields": [CustomFormField],
"requireInitials": true,
"version": 987,
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"versions": VersionedCustomFormsConnection
}
CustomFormConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [CustomFormEdge!]!
|
A list of edges. |
nodes - [CustomForm!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [CustomFormEdge],
"nodes": [CustomForm]
}
CustomFormData
Fields
| Field Name | Description |
|---|---|
formId - CustomFormId!
|
|
formVersion - Int!
|
|
values - [CustomFieldValue!]!
|
|
initials - String
|
|
form - CustomForm!
|
Internal use only |
schema - JSON!
|
Example
{
"formId": CustomFormId,
"formVersion": 123,
"values": [CustomFieldValue],
"initials": "abc123",
"form": CustomForm,
"schema": {}
}
CustomFormDataFilter
Fields
| Input Field | Description |
|---|---|
key - CustomFormFieldId!
|
|
value - JSON!
|
|
op - Operator!
|
Example
{"key": CustomFormFieldId, "value": {}, "op": "EQ"}
CustomFormDataInput
Fields
| Input Field | Description |
|---|---|
schema - JSON!
|
|
values - [CustomFieldValueInput!]!
|
Example
{"schema": {}, "values": [CustomFieldValueInput]}
CustomFormEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - CustomForm!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": CustomForm,
"cursor": "xyz789"
}
CustomFormField
Fields
| Field Name | Description |
|---|---|
id - CustomFormFieldId!
|
|
name - String!
|
|
description - String!
|
|
translations - [CustomFormFieldTranslation!]!
|
|
fieldOptions - CustomFormFieldOptions!
|
Example
{
"id": CustomFormFieldId,
"name": "xyz789",
"description": "abc123",
"translations": [CustomFormFieldTranslation],
"fieldOptions": CustomFormFieldOptions
}
CustomFormFieldId
Example
CustomFormFieldId
CustomFormFieldInput
Fields
| Input Field | Description |
|---|---|
id - CustomFormFieldId
|
|
translations - [CustomFormFieldTranslationInput!]!
|
|
fieldOptions - CustomFormFieldOptionsInput!
|
Example
{
"id": CustomFormFieldId,
"translations": [CustomFormFieldTranslationInput],
"fieldOptions": CustomFormFieldOptionsInput
}
CustomFormFieldOptions
Fields
| Field Name | Description |
|---|---|
text - TextFieldOptions
|
|
number - NumberFieldOptions
|
|
derivedNumber - DerivedNumberFieldOptions
|
|
checkbox - CheckboxFieldOptions
|
|
passFail - PassFailFieldOptions
|
|
date - DateFieldOptions
|
|
select - SelectFieldOptions
|
|
multiSelect - MultiSelectFieldOptions
|
|
selectEntity - SelectEntityFieldOptions
|
|
markdown - MarkdownOptions
|
|
images - ImagesOptions
|
Example
{
"text": TextFieldOptions,
"number": NumberFieldOptions,
"derivedNumber": DerivedNumberFieldOptions,
"checkbox": CheckboxFieldOptions,
"passFail": PassFailFieldOptions,
"date": DateFieldOptions,
"select": SelectFieldOptions,
"multiSelect": MultiSelectFieldOptions,
"selectEntity": SelectEntityFieldOptions,
"markdown": MarkdownOptions,
"images": ImagesOptions
}
CustomFormFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
text - TextFieldOptionsInput
|
|
number - NumberFieldOptionsInput
|
|
derivedNumber - DerivedNumberFieldOptionsInput
|
|
checkbox - CheckboxFieldOptionsInput
|
|
passFail - PassFailFieldOptionsInput
|
|
date - DateFieldOptionsInput
|
|
select - SelectFieldOptionsInput
|
|
multiSelect - MultiSelectFieldOptionsInput
|
|
selectEntity - SelectEntityFieldOptionsInput
|
|
markdown - MarkdownOptionsInput
|
|
images - ImagesOptionsInput
|
Example
{
"text": TextFieldOptionsInput,
"number": NumberFieldOptionsInput,
"derivedNumber": DerivedNumberFieldOptionsInput,
"checkbox": CheckboxFieldOptionsInput,
"passFail": PassFailFieldOptionsInput,
"date": DateFieldOptionsInput,
"select": SelectFieldOptionsInput,
"multiSelect": MultiSelectFieldOptionsInput,
"selectEntity": SelectEntityFieldOptionsInput,
"markdown": MarkdownOptionsInput,
"images": ImagesOptionsInput
}
CustomFormFieldTranslation
CustomFormFieldTranslationInput
CustomFormId
Example
CustomFormId
CustomFormInput
Fields
| Input Field | Description |
|---|---|
translations - [CustomFormTranslationInput!]!
|
|
fields - [CustomFormFieldInput!]!
|
|
requireInitials - Boolean
|
Example
{
"translations": [CustomFormTranslationInput],
"fields": [CustomFormFieldInput],
"requireInitials": true
}
CustomFormTranslation
CustomFormTranslationInput
CustomKPI
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
peripheralId - ID!
|
|
name - String!
|
|
description - String!
|
|
unit - String!
|
|
decimals - Int!
|
|
type - CustomKPIType!
|
|
templateParameters - [KPIParameter!]
|
|
kpiParameters - [KPIParameter!]
|
Example
{
"id": 4,
"peripheralId": "4",
"name": "abc123",
"description": "abc123",
"unit": "abc123",
"decimals": 123,
"type": "FORMULA",
"templateParameters": [KPIParameter],
"kpiParameters": [KPIParameter]
}
CustomKPIType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FORMULA"
CustomKPIValue
Data
Fields
| Field Name | Description |
|---|---|
produced - Float
|
Produced: Sum of value produced. |
goodParts - Float
|
Good parts: Number produced - number scrapped downstream. |
longestNonStop - Float
|
Longest non-stop: Longest duration running. |
lineStatus - LineStatus
|
Line status, indicating if it's running or stopped, and for how long. |
numberOfStops - Int
|
Number of stops: Count of all stops. |
numberOfUnregisteredStops - Int
|
Number of unregistered stops: Count of all stops that have not been registered. |
averageStopLength - Float
|
Average stop length: Average stop length in minutes. |
valueAddingTime - Float
|
Value adding time: [Total time - stopped time] / Total time. |
valueAddingTimeWhileManned - Float
|
Value adding time while manned: [(Total time - time spent on blue stops) - (stopped time without time spent on blue stops)] / (Total time - time spent on blue stops). |
valueAddingTimeWhileOperating - Float
|
Value adding time while operating: [(Total time - time spent on blue stops and gray) - (stopped time without time spent on blue stops and gray)] / (Total time - time spent on blue stops and gray). |
mtbf - Float
|
Meant Time Between Failures: (Total time - all stops) / Count of red stops. |
downtime - Float
|
Downtime: Sum of duration stopped. |
uptime - Float
|
Uptime: Total duration - Sum of duration stopped. |
averageProducedMinute - Float
|
Average produced minute: Sum of value produced / time. Use averageProduced instead. |
averageProducedHour - Float
|
Average produced hour: Sum of value produced / time. Use averageProduced instead. |
averageProduced - Float
|
Average produced over duration: Sum of value produced / time - scoped within the requested time range. |
Arguments
|
|
cycleTime - Float
|
Cycle time: Time / Sum of value produced. |
producedPerStop - Float
|
Produced units pr. stop: Sum of value produced / Count of all stops. |
speedWhileManned - Float
|
Speed while manned: Sum of value produced / (time - time spent on blue stops). |
speedWhileProducing - Float
|
Speed while producing: Sum of value produced / (time - time spent on blue stops and the yellow stops). |
speedWhileRunning - Float
|
Speed while running: Sum of value produced / (time - time spent on all stops). |
machineCycleTimeWhileRunning - Float
|
Machine cycle time while running: (time - time spent on all stops) / Sum of produced ignoring data multipliers (= machine cycles) . |
scrap - Float
|
Number of units scrapped downstream Use scrapData.downstream or scrapData.total instead. |
scrapData - ScrapData
|
Scrapped units, upstream, downstream or total |
oee - OEE
|
Breakdown of the OEE (Overall Equipment Efficiency). Will be null if the time range does not have a 'start' and 'end', e.g OEE for a pending batch |
customKPIs - [CustomKPIValue!]
|
List of the results of custom KPIs on the peripheral |
Example
{
"produced": 987.65,
"goodParts": 123.45,
"longestNonStop": 987.65,
"lineStatus": LineStatus,
"numberOfStops": 123,
"numberOfUnregisteredStops": 123,
"averageStopLength": 987.65,
"valueAddingTime": 987.65,
"valueAddingTimeWhileManned": 987.65,
"valueAddingTimeWhileOperating": 987.65,
"mtbf": 987.65,
"downtime": 123.45,
"uptime": 987.65,
"averageProducedMinute": 123.45,
"averageProducedHour": 987.65,
"averageProduced": 123.45,
"cycleTime": 123.45,
"producedPerStop": 987.65,
"speedWhileManned": 987.65,
"speedWhileProducing": 123.45,
"speedWhileRunning": 123.45,
"machineCycleTimeWhileRunning": 987.65,
"scrap": 987.65,
"scrapData": ScrapData,
"oee": OEE,
"customKPIs": [CustomKPIValue]
}
DataAlarm
Fields
| Field Name | Description |
|---|---|
updateBuffer - Int
|
|
notificationFrequency - Int
|
|
repeatNotification - Boolean
|
|
subscribers - [Subscriber!]!
|
Example
{
"updateBuffer": 123,
"notificationFrequency": 123,
"repeatNotification": false,
"subscribers": [Subscriber]
}
DataAlarmInput
Fields
| Input Field | Description |
|---|---|
updateBuffer - Int
|
|
notificationFrequency - Int
|
|
repeatNotification - Boolean
|
|
subscribers - [SubscriberInput!]!
|
Example
{
"updateBuffer": 987,
"notificationFrequency": 123,
"repeatNotification": false,
"subscribers": [SubscriberInput]
}
DataFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AVERAGE_SPEED"
DataOverride
Fields
| Field Name | Description |
|---|---|
peripheralId - ID!
|
|
timeRange - TimeRange!
|
|
value - Int!
|
|
author - String!
|
|
comment - String!
|
Example
{
"peripheralId": "4",
"timeRange": TimeRange,
"value": 123,
"author": "abc123",
"comment": "xyz789"
}
DataOverrideUpsertInput
Fields
| Input Field | Description |
|---|---|
timeRange - InputTimeRange!
|
|
value - Int!
|
|
author - String!
|
|
comment - String!
|
Example
{
"timeRange": InputTimeRange,
"value": 987,
"author": "abc123",
"comment": "xyz789"
}
Date
Example
"2007-12-03"
DateFieldOptions
Fields
| Field Name | Description |
|---|---|
validation - DateFieldValidation!
|
Example
{"validation": DateFieldValidation}
DateFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
validation - DateFieldValidationInput!
|
Example
{"validation": DateFieldValidationInput}
DateFieldValidation
Fields
| Field Name | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
DateFieldValidationInput
Fields
| Input Field | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
DateTime
Description
Implement the DateTime
The input/output is a string in RFC3339 format.
Example
"2007-12-03T10:15:30Z"
DayOfWeek
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MONDAY"
DebounceState
DerivedNumberFieldOptions
Fields
| Field Name | Description |
|---|---|
validation - NumberFieldValidation!
|
|
passCriteria - NumberFieldPassCriteria!
|
Pass criteria are different from form validation, because they do not influence the ability to submit the form. When a form is submitted it passes by default, but fails if any value fails the pass criteria of its field. |
op - NumberFieldOperator!
|
|
inputFields - [CustomFormFieldId!]!
|
Example
{
"validation": NumberFieldValidation,
"passCriteria": NumberFieldPassCriteria,
"op": "SUM",
"inputFields": [CustomFormFieldId]
}
DerivedNumberFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
validation - NumberFieldValidationInput!
|
|
passCriteria - NumberFieldPassCriteriaInput!
|
Pass criteria are different from form validation, because they do not influence the ability to submit the form. When a form is submitted it passes by default, but fails if any value fails the pass criteria of its field. |
op - NumberFieldOperator!
|
|
inputFields - [CustomFormFieldId!]!
|
Example
{
"validation": NumberFieldValidationInput,
"passCriteria": NumberFieldPassCriteriaInput,
"op": "SUM",
"inputFields": [CustomFormFieldId]
}
DescribeJobExecution
Fields
| Field Name | Description |
|---|---|
statusDetails - StatusDetails!
|
Example
{"statusDetails": StatusDetails}
Device
Fields
| Field Name | Description |
|---|---|
_id - ID
|
|
uuid - ID!
|
|
owner - ID
|
|
type - String!
|
|
hardwareId - ID
|
|
name - String
|
|
numInputPorts - Int!
|
|
status - DeviceStatus
|
|
network - NetworkConfig
|
|
sensors - [Sensor!]!
|
Use peripherals, with inline fragments instead.
|
Arguments
|
|
sensor - Sensor
|
Use peripheral, with inline fragments instead.
|
Arguments
|
|
peripheral - Peripheral
|
|
Arguments
|
|
peripherals - [Peripheral]!
|
|
Arguments
|
|
peripheralPhysicalInput - Peripheral
|
|
Arguments
|
|
peripheralPhysicalInputs - [Peripheral]!
|
|
pendingJobExecutions - [JobExecutionSummary]
|
|
updateAvailable - Boolean
|
|
certificates - [Certificate!]!
|
|
Example
{
"_id": 4,
"uuid": 4,
"owner": 4,
"type": "xyz789",
"hardwareId": "4",
"name": "xyz789",
"numInputPorts": 987,
"status": DeviceStatus,
"network": NetworkConfig,
"sensors": [Sensor],
"sensor": Sensor,
"peripheral": Peripheral,
"peripherals": [Peripheral],
"peripheralPhysicalInput": Peripheral,
"peripheralPhysicalInputs": [Peripheral],
"pendingJobExecutions": [JobExecutionSummary],
"updateAvailable": true,
"certificates": [Certificate]
}
DeviceMetaInput
DeviceStatus
Fields
| Field Name | Description |
|---|---|
firmwareVersions - FirmwareVersions
|
|
hardwareVersion - String
|
Example
{
"firmwareVersions": FirmwareVersions,
"hardwareVersion": "abc123"
}
DevicesPaginated
Fields
| Field Name | Description |
|---|---|
items - [Device!]!
|
|
nextOffset - Int
|
|
total - Int!
|
Example
{"items": [Device], "nextOffset": 123, "total": 987}
DirectoryNodeMeta
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
description - String!
|
|
lineIds - [LineId!]!
|
Returns all descendant line Ids. |
Example
{
"name": "xyz789",
"description": "xyz789",
"lineIds": [LineId]
}
DirectoryNodeMetaInput
DiscreteConfig
Fields
| Field Name | Description |
|---|---|
onStates - [Int!]!
|
|
offStates - [Int!]!
|
|
defaultState - DiscreteDeviceState!
|
Example
{"onStates": [987], "offStates": [987], "defaultState": "ON"}
DiscreteConfigInput
Fields
| Input Field | Description |
|---|---|
onStates - [Int!]!
|
|
offStates - [Int!]!
|
|
defaultState - DiscreteDeviceState!
|
Example
{"onStates": [123], "offStates": [987], "defaultState": "ON"}
DiscreteDeviceState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ON"
DocumentFormat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CSV"
DocumentInputActivities
Fields
| Input Field | Description |
|---|---|
format - DocumentFormat!
|
|
filter - ActivityFilter!
|
|
orderBy - ActivityOrdering!
|
Example
{
"format": "CSV",
"filter": ActivityFilter,
"orderBy": ActivityOrdering
}
DocumentInputAnalytics
Fields
| Input Field | Description |
|---|---|
documentType - AnalyticsDocumentType!
|
|
format - DocumentFormat!
|
|
filter - String!
|
Example
{
"documentType": "PARETO",
"format": "CSV",
"filter": "abc123"
}
DocumentInputBatches
Fields
| Input Field | Description |
|---|---|
format - DocumentFormat!
|
|
filter - String!
|
|
total - Int!
|
Example
{
"format": "CSV",
"filter": "xyz789",
"total": 123
}
DocumentInputHeaders
Fields
| Input Field | Description |
|---|---|
timeRange - InputTimeRange
|
|
language - String
|
|
timezone - String
|
|
title - String
|
Example
{
"timeRange": InputTimeRange,
"language": "abc123",
"timezone": "xyz789",
"title": "xyz789"
}
DocumentInputLineOEE
Fields
| Input Field | Description |
|---|---|
oeeDocumentType - OEEDocumentType!
|
|
stopFilterInput - StopFilterInput
|
Example
{
"oeeDocumentType": "STOPS_LAST_6_DAYS",
"stopFilterInput": StopFilterInput
}
DocumentInputLinesGroupOEE
Fields
| Input Field | Description |
|---|---|
isDynamic - Boolean!
|
|
stopFilterInput - StopFilterInput
|
Example
{"isDynamic": false, "stopFilterInput": StopFilterInput}
DocumentInputLiveData
Fields
| Input Field | Description |
|---|---|
documentType - LiveDataDocumentType!
|
|
points - Int!
|
|
time - [InputTimeRange!]!
|
|
format - DocumentFormat!
|
|
sensorType - SensorType
|
|
unitLabel - String
|
|
chartScale - ChartTimeScale
|
Example
{
"documentType": "CHART",
"points": 987,
"time": [InputTimeRange],
"format": "CSV",
"sensorType": "COUNTER",
"unitLabel": "abc123",
"chartScale": "DAY"
}
DocumentInputMaintenanceLog
Fields
| Input Field | Description |
|---|---|
format - DocumentFormat!
|
|
filter - MaintenanceLogFilter!
|
Example
{"format": "CSV", "filter": MaintenanceLogFilter}
DownloadVideoClip
Fields
| Field Name | Description |
|---|---|
videoClipUrl - String!
|
Example
{"videoClipUrl": "xyz789"}
EditHierarchyDirectoryInput
EditHierarchyNodeInput
Fields
| Input Field | Description |
|---|---|
version - Int!
|
|
id - NodeId!
|
|
meta - EditHierarchyNodeMetaInput
|
|
attachments - HierarchyNodeAttachmentsInput
|
Example
{
"version": 123,
"id": NodeId,
"meta": EditHierarchyNodeMetaInput,
"attachments": HierarchyNodeAttachmentsInput
}
EditHierarchyNodeMetaInput
Fields
| Input Field | Description |
|---|---|
line - LineNodeMetaUpdateInput
|
|
directory - DirectoryNodeMetaInput
|
|
asset - AssetNodeMetaInput
|
|
peripheral - PeripheralNodeMetaUpdateInput
|
Example
{
"line": LineNodeMetaUpdateInput,
"directory": DirectoryNodeMetaInput,
"asset": AssetNodeMetaInput,
"peripheral": PeripheralNodeMetaUpdateInput
}
EnrollUserInLearningRoleInput
EnrollUserInSkillInput
Entity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PERIPHERAL"
EntityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LINE"
Escalation
Example
{
"nodeId": "abc123",
"creationDate": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"assignedToSub": "xyz789",
"priority": true,
"version": 123,
"plan": ActionPlan,
"id": "abc123",
"assignedTo": User,
"createdBy": User,
"node": HierarchyNode
}
EscalationConfiguration
Fields
| Field Name | Description |
|---|---|
type - SubscriptionType!
|
|
delay - Float
|
|
takenDelay - Float
|
Example
{"type": "SMS", "delay": 123.45, "takenDelay": 123.45}
EscalationConfigurationInput
Fields
| Input Field | Description |
|---|---|
type - SubscriptionType!
|
|
delay - Float
|
|
takenDelay - Float
|
Example
{"type": "SMS", "delay": 123.45, "takenDelay": 987.65}
EscalationConnection
Fields
| Field Name | Description |
|---|---|
edges - [EscalationEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [EscalationEdge],
"pageInfo": PageInfo
}
EscalationEdge
Fields
| Field Name | Description |
|---|---|
node - Escalation!
|
|
cursor - String!
|
Example
{
"node": Escalation,
"cursor": "abc123"
}
EscalationOrder
Fields
| Input Field | Description |
|---|---|
field - ActionPlanSortField!
|
|
order - Order
|
Example
{"field": "CATEGORY", "order": "ASCENDING"}
EventActionConfiguration
Fields
| Field Name | Description |
|---|---|
peripheralId - ID!
|
|
value - String!
|
|
actions - [Actions!]!
|
Example
{
"peripheralId": 4,
"value": "abc123",
"actions": [Actions]
}
EveryXMinutesTriggerOptions
EveryXMinutesTriggerOptionsInput
EveryXProducedTriggerOptions
EveryXProducedTriggerOptionsInput
Extension
Fields
| Field Name | Description |
|---|---|
type - ExtensionType!
|
|
service - String!
|
Example
{"type": "WORK_ORDER", "service": "xyz789"}
ExtensionType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"WORK_ORDER"
FeatureItem
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
feature - [FeatureValue!]!
|
Example
{
"id": "abc123",
"feature": [FeatureValue]
}
FeatureList
Fields
| Field Name | Description |
|---|---|
group - [FeatureItem!]!
|
|
line - [FeatureItem!]!
|
|
peripheral - [FeatureItem!]!
|
|
userPool - [FeatureItem!]!
|
Example
{
"group": [FeatureItem],
"line": [FeatureItem],
"peripheral": [FeatureItem],
"userPool": [FeatureItem]
}
FeatureValue
FirmwareVersions
FixedTimeTriggerOptions
FixedTimeTriggerOptionsInput
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FollowUpSettings
FollowUpSettingsInput
GeneralNetworkSettings
Fields
| Field Name | Description |
|---|---|
fallback - NetworkFallbackStrategy
|
Example
{"fallback": "NEVER"}
GeneralNetworkSettingsInput
Fields
| Input Field | Description |
|---|---|
fallback - NetworkFallbackStrategy
|
Example
{"fallback": "NEVER"}
GeneralNetworkShadowSettings
Fields
| Field Name | Description |
|---|---|
desired - GeneralNetworkSettings!
|
|
reported - GeneralNetworkSettings!
|
Example
{
"desired": GeneralNetworkSettings,
"reported": GeneralNetworkSettings
}
GenerateAPITokenInput
GeneratedAPIToken
Fields
| Field Name | Description |
|---|---|
token - String!
|
The API token value, only exposed upon creation. |
name - String!
|
The name of the API token, visible to the user. |
description - String
|
A description of what this API token is used for. |
generatedAt - Date!
|
The date this token was issued. |
expiration - Float
|
The expiration duration of a token if set to expire. |
isActive - Boolean!
|
Whether the token is active |
userSub - ID!
|
The owner (user) of this token. |
Example
{
"token": "xyz789",
"name": "xyz789",
"description": "abc123",
"generatedAt": "2007-12-03",
"expiration": 123.45,
"isActive": false,
"userSub": 4
}
GeneratedExportDocument
GeneratedPageReport
GoldenBatch
GoldenBatchSettings
Fields
| Field Name | Description |
|---|---|
timePeriodMonths - Int!
|
Example
{"timePeriodMonths": 123}
Group
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
defaultGroup - Boolean
|
|
externalIds - [String!]!
|
|
peripheralIds - [ID!]!
|
|
lineIds - [ID!]!
|
|
owner - Company!
|
|
name - String!
|
|
description - String
|
|
nodeId - ID
|
|
role - Role!
|
|
users - UserList!
|
|
Arguments |
|
sensors - [Sensor]!
|
Use peripherals, with inline fragments instead.
|
peripherals - [Peripheral]!
|
|
Arguments
|
|
peripheralsPaginated - PeripheralsPaginated!
|
|
lines - [Line]!
|
|
scheduledReports - [ScheduledReport!]!
|
|
Example
{
"id": 4,
"defaultGroup": false,
"externalIds": ["abc123"],
"peripheralIds": ["4"],
"lineIds": [4],
"owner": Company,
"name": "xyz789",
"description": "xyz789",
"nodeId": "4",
"role": Role,
"users": UserList,
"sensors": [Sensor],
"peripherals": [Peripheral],
"peripheralsPaginated": PeripheralsPaginated,
"lines": [Line],
"scheduledReports": [ScheduledReport]
}
GroupAttributes
HierarchyNode
Fields
| Field Name | Description |
|---|---|
id - NodeId!
|
|
version - Int!
|
|
meta - NodeMeta!
|
|
attachments - HierarchyNodeAttachments
|
Internal use only |
type - HierarchyNodeType!
|
|
descendants - HierarchyNodeConnection!
|
|
ancestors - [HierarchyNode!]!
|
|
Arguments
|
|
Example
{
"id": NodeId,
"version": 987,
"meta": LineNodeMeta,
"attachments": HierarchyNodeAttachments,
"type": "LINE",
"descendants": HierarchyNodeConnection,
"ancestors": [HierarchyNode]
}
HierarchyNodeAttachments
Fields
| Field Name | Description |
|---|---|
customForms - HierarchyNodeCustomFormAttachments
|
Example
{"customForms": HierarchyNodeCustomFormAttachments}
HierarchyNodeAttachmentsInput
Fields
| Input Field | Description |
|---|---|
customForms - HierarchyNodeCustomFormAttachmentsInput
|
Example
{"customForms": HierarchyNodeCustomFormAttachmentsInput}
HierarchyNodeConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [HierarchyNodeEdge!]!
|
A list of edges. |
nodes - [HierarchyNode!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [HierarchyNodeEdge],
"nodes": [HierarchyNode]
}
HierarchyNodeCustomFormAttachments
Fields
| Field Name | Description |
|---|---|
unplannedMaintenanceId - CustomFormId
|
|
unplannedMaintenance - CustomForm
|
Example
{
"unplannedMaintenanceId": CustomFormId,
"unplannedMaintenance": CustomForm
}
HierarchyNodeCustomFormAttachmentsInput
Fields
| Input Field | Description |
|---|---|
unplannedMaintenanceId - String
|
Example
{"unplannedMaintenanceId": "abc123"}
HierarchyNodeEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - HierarchyNode!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": HierarchyNode,
"cursor": "xyz789"
}
HierarchyNodeFilter
HierarchyNodeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LINE"
HorizontalAnnotation
HorizontalAnnotationInput
HttpRedirect
ID
Description
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
"4"
IWorker
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
email - String
|
|
phoneNumber - String
|
|
userSub - String
|
This feature is experimental and might be replaced |
role - AndonRole!
|
Workers may now reference multiple roles. |
roles - [AndonRole!]!
|
|
preferredSchedules - [AndonSchedule!]!
|
Possible Types
| IWorker Types |
|---|
Example
{
"id": 4,
"name": "xyz789",
"email": "abc123",
"phoneNumber": "xyz789",
"userSub": "abc123",
"role": AndonRole,
"roles": [AndonRole],
"preferredSchedules": [AndonSchedule]
}
ImagesOptions
Fields
| Field Name | Description |
|---|---|
validation - ImagesOptionsValidation!
|
Example
{"validation": ImagesOptionsValidation}
ImagesOptionsInput
Fields
| Input Field | Description |
|---|---|
validation - ImagesOptionsValidationInput!
|
Example
{"validation": ImagesOptionsValidationInput}
ImagesOptionsValidation
Fields
| Field Name | Description |
|---|---|
required - Boolean!
|
Example
{"required": true}
ImagesOptionsValidationInput
Fields
| Input Field | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
InitializeHierarchyInput
Fields
| Input Field | Description |
|---|---|
rootName - String!
|
Example
{"rootName": "abc123"}
InitialsSettings
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"REQUIRED_IF_OUTSIDE_LIMITS"
InputMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COUNTER"
InputModeState
InputParameter
InputTimeRange
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
InvalidateSessionInput
Fields
| Input Field | Description |
|---|---|
timestamp - String!
|
Example
{"timestamp": "abc123"}
InvalidateUserSessionInput
IssueCertificateInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The thing (device hardware) identifier. |
Example
{"id": 4}
IssuedCertificate
Fields
| Field Name | Description |
|---|---|
url - String!
|
The temporary URL where the certificate is available |
certificate - Certificate!
|
Example
{
"url": "xyz789",
"certificate": Certificate
}
JSON
Example
{}
JobExecutionSummary
Example
{
"thingName": "abc123",
"jobId": "xyz789",
"executionNumber": 987,
"lastUpdatedAt": 123,
"queuedAt": 987,
"retryAttempt": 987,
"startedAt": 123,
"status": "QUEUED",
"describeJobExecution": DescribeJobExecution
}
JobStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"QUEUED"
JobType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OTA"
KPIConfiguration
Fields
| Field Name | Description |
|---|---|
displayKPIs - [String!]!
|
Example
{"displayKPIs": ["abc123"]}
KPIConfigurationInput
Fields
| Input Field | Description |
|---|---|
displayKPIs - [String!]!
|
Example
{"displayKPIs": ["xyz789"]}
KPIParameter
LearningActivity
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
version - Int!
|
|
nodeId - String!
|
|
title - String!
|
|
description - String
|
|
content - String
|
|
startEndDatesRequired - Boolean!
|
|
validityInMonths - Int
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
createdBySub - String!
|
|
updatedBySub - String!
|
|
node - HierarchyNode
|
|
createdBy - User
|
|
updatedBy - User
|
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"version": 123,
"nodeId": "xyz789",
"title": "xyz789",
"description": "xyz789",
"content": "xyz789",
"startEndDatesRequired": false,
"validityInMonths": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"updatedBySub": "abc123",
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
LearningActivityConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [LearningActivityEdge!]!
|
A list of edges. |
nodes - [LearningActivity!]!
|
A list of nodes. |
totalCount - Int!
|
Example
{
"pageInfo": PageInfo,
"edges": [LearningActivityEdge],
"nodes": [LearningActivity],
"totalCount": 987
}
LearningActivityEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - LearningActivity!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": LearningActivity,
"cursor": "abc123"
}
LearningActivityFilter
LearningRole
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"title": "abc123",
"description": "xyz789",
"nodeId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "abc123",
"skills": LearningRoleSkillsConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
LearningRoleConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [LearningRoleEdge!]!
|
A list of edges. |
nodes - [LearningRole!]!
|
A list of nodes. |
totalCount - Int!
|
Example
{
"pageInfo": PageInfo,
"edges": [LearningRoleEdge],
"nodes": [LearningRole],
"totalCount": 123
}
LearningRoleEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - LearningRole!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": LearningRole,
"cursor": "xyz789"
}
LearningRoleFilter
LearningRoleSkill
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"nodeId": "xyz789",
"title": "abc123",
"description": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "abc123",
"updatedBy": "xyz789",
"orderIndex": 123,
"node": HierarchyNode
}
LearningRoleSkillsConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [LearningRoleSkillsEdge!]!
|
A list of edges. |
nodes - [LearningRoleSkill!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [LearningRoleSkillsEdge],
"nodes": [LearningRoleSkill]
}
LearningRoleSkillsEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - LearningRoleSkill!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": LearningRoleSkill,
"cursor": "xyz789"
}
LearningRoleStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENROLLED"
Line
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The identifier of the line. |
languageCode - String!
|
The language code of the line metadata. |
owner - ID
|
TODO: Implement this bad boi |
location - Location!
|
|
name - String!
|
The name of the line. |
description - String
|
A description of the line. |
mainPeripheralId - ID!
|
The peripheral Id of the main node. |
nodes - [LineNode!]!
|
The nodes that make of the line. |
edges - [LineEdge!]!
|
The edges between the nodes. |
settings - LineSettings
|
Settings for this line |
goldenBatch - GoldenBatch
|
Get the golden batch for this line, or optionally for a product on this line if productId is set. Internal use only
|
Arguments
|
|
bestPendingGoldenBatch - GoldenBatch
|
Get the best pending golden batch for a product on this line. Internal use only |
Arguments
|
|
time - [LineTimeData!]!
|
|
Arguments
|
|
products - ProductList!
|
|
Arguments |
|
packagings - PackagingList!
|
|
Arguments |
|
batches - BatchList!
|
|
Arguments |
|
batch - Batch!
|
|
Arguments
|
|
schedule - Schedule
|
|
Arguments
|
|
mainSensor - Sensor
|
|
scheduledReports - [ScheduledReport!]!
|
|
andonSchedules - [AndonSchedule!]!
|
|
nextShift - ShiftInstance
|
|
Arguments
|
|
scheduledEnd - Date
|
Calculates the date where {duration} seconds of production time have passed, starting from {from} and ignoring time outside shifts. |
previousShift - ShiftInstance
|
|
Arguments
|
|
maintenanceWorkOrders - MaintenanceWorkOrderConnection!
|
Get the line's maintenance work orders |
Arguments
|
|
groups - [Group!]
|
|
Example
{
"id": 4,
"languageCode": "xyz789",
"owner": "4",
"location": Location,
"name": "abc123",
"description": "xyz789",
"mainPeripheralId": 4,
"nodes": [LineNode],
"edges": [LineEdge],
"settings": LineSettings,
"goldenBatch": GoldenBatch,
"bestPendingGoldenBatch": GoldenBatch,
"time": [LineTimeData],
"products": ProductList,
"packagings": PackagingList,
"batches": BatchList,
"batch": Batch,
"schedule": Schedule,
"mainSensor": Sensor,
"scheduledReports": [ScheduledReport],
"andonSchedules": [AndonSchedule],
"nextShift": ShiftInstance,
"scheduledEnd": "2007-12-03",
"previousShift": ShiftInstance,
"maintenanceWorkOrders": MaintenanceWorkOrderConnection,
"groups": [Group]
}
LineBatchSettings
Fields
| Field Name | Description |
|---|---|
useShiftScheduleInETC - Boolean!
|
Example
{"useShiftScheduleInETC": true}
LineBatchSettingsInput
Fields
| Input Field | Description |
|---|---|
useShiftScheduleInETC - Boolean
|
Example
{"useShiftScheduleInETC": false}
LineEdge
LineEdgeInput
LineFilterInput
Fields
| Input Field | Description |
|---|---|
lineName - String
|
Apply a filter on the line names. |
lineDescription - String
|
Apply a filter on the line descriptions. |
nodeType - NodeType
|
Apply a filter on the node type. |
nodePosition - NodePosition
|
Filter nodes that are upstream/downstream from main peripheral |
lineIds - [ID!]
|
Apply a filter on specific line IDs. |
Example
{
"lineName": "xyz789",
"lineDescription": "xyz789",
"nodeType": "Main",
"nodePosition": "DOWNSTREAM_FROM_MAIN",
"lineIds": [4]
}
LineId
Example
LineId
LineNode
LineNodeInput
LineNodeMeta
Fields
| Field Name | Description |
|---|---|
lineId - LineId!
|
|
labels - [String!]!
|
|
line - Line
|
Example
{
"lineId": LineId,
"labels": ["xyz789"],
"line": Line
}
LineNodeMetaInput
LineNodeMetaUpdateInput
Fields
| Input Field | Description |
|---|---|
labels - [String!]
|
Example
{"labels": ["abc123"]}
LineOEESettings
LineOEESettingsInput
LineSettings
Fields
| Field Name | Description |
|---|---|
oee - LineOEESettings
|
|
batch - LineBatchSettings
|
Example
{
"oee": LineOEESettings,
"batch": LineBatchSettings
}
LineSettingsInput
Fields
| Input Field | Description |
|---|---|
oee - LineOEESettingsInput
|
|
batch - LineBatchSettingsInput
|
Example
{
"oee": LineOEESettingsInput,
"batch": LineBatchSettingsInput
}
LineStatus
LineStopStats
Fields
| Field Name | Description |
|---|---|
lineId - ID!
|
|
lineName - String!
|
|
stopStats - StopStats!
|
Example
{
"lineId": "4",
"lineName": "abc123",
"stopStats": StopStats
}
LineTimeData
Fields
| Field Name | Description |
|---|---|
configs - [SensorConfig]!
|
|
alarmLogs - AlarmLogs!
|
|
Arguments |
|
batches - BatchList!
|
|
Arguments |
|
dataOverrides - [DataOverride!]!
|
|
pendingControls - BatchControlList!
|
|
samples - [Sample!]!
|
|
scrap - [Sample!]!
|
|
shifts - [ShiftInstance!]!
|
Get the shifts on the line |
stops - [Stop!]!
|
|
Arguments
|
|
stopStats - StopStats!
|
|
Arguments
|
|
stats - Stat!
|
|
Arguments
|
|
changeoverStops - [ChangeoverStop]!
|
|
Arguments
|
|
_id - ID
|
|
timeRange - TimeRange!
|
|
Example
{
"configs": [SensorConfig],
"alarmLogs": AlarmLogs,
"batches": BatchList,
"dataOverrides": [DataOverride],
"pendingControls": BatchControlList,
"samples": [Sample],
"scrap": [Sample],
"shifts": [ShiftInstance],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat,
"changeoverStops": [ChangeoverStop],
"_id": "4",
"timeRange": TimeRange
}
LinesPaginated
LiveDataDocumentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CHART"
Location
Fields
| Field Name | Description |
|---|---|
timeZone - String
|
Example
{"timeZone": "xyz789"}
MaintenanceEvent
Example
{
"id": "4",
"lineId": 4,
"summary": "abc123",
"description": "abc123",
"duration": 123.45,
"rRuleSet": "abc123",
"attendees": [Attendee]
}
MaintenanceFilter
Fields
| Input Field | Description |
|---|---|
status - [WorkOrderStatusFilter!]
|
If set, only work orders with the given status will be returned. If not set, all work orders will be returned. |
lineIds - [LineId!]
|
|
roleIds - [MaintenanceRoleId!]
|
|
repeat - ShouldRepeat
|
Example
{
"status": ["PLANNED"],
"lineIds": [LineId],
"roleIds": [MaintenanceRoleId],
"repeat": "YES"
}
MaintenanceLogEntry
Fields
| Field Name | Description |
|---|---|
planId - MaintenancePlanId
|
|
lineId - LineId!
|
|
status - WorkOrderStatus!
|
|
workOrderDueAt - DateTime
|
Timestamp when the work order was due, recorded at time of log entry creation |
workOrderOverdueAt - DateTime
|
Timestamp when the work order was overdue, recorded at time of log entry creation |
timestamp - DateTime!
|
Timestamp when the log entry was created |
produced - Int
|
The number of cycled since the previous maintenance. Only set if tracking by production |
startFrom - DateTime
|
The time at which the previous maintenance was done. |
initials - String!
|
|
comment - String!
|
|
planSnapshot - MaintenancePlanSnapshot
|
Snapshot of the maintenance plan that scheduled the work order |
customData - CustomFormData
|
Custom data that may have been attached to the work order |
andonCallId - String
|
ID of Andon call associated with the entry |
stopCauseIds - [String!]!
|
Stop causes associated with the entry |
stopCausePeripheralId - PeripheralId
|
ID of peripheral associated with the stop cause |
assetIds - [NodeId!]!
|
ID of assets associated with the entry |
startOfService - DateTime
|
Start of service |
endOfService - DateTime
|
End of service |
startOfStop - DateTime
|
Start of stop |
endOfStop - DateTime
|
End of stop |
version - Int!
|
Version of the log entry |
effectiveDuration - Int
|
Duration in seconds between the previous maintenance and the time the work order was completed. The duration is effective in the sense that it does not include days that are skipped. Only set if tracking by time. |
line - Line
|
|
stopCauses - [StopCause!]
|
|
assets - [HierarchyNode!]
|
Example
{
"planId": MaintenancePlanId,
"lineId": LineId,
"status": "COMPLETED",
"workOrderDueAt": "2007-12-03T10:15:30Z",
"workOrderOverdueAt": "2007-12-03T10:15:30Z",
"timestamp": "2007-12-03T10:15:30Z",
"produced": 987,
"startFrom": "2007-12-03T10:15:30Z",
"initials": "xyz789",
"comment": "xyz789",
"planSnapshot": MaintenancePlanSnapshot,
"customData": CustomFormData,
"andonCallId": "xyz789",
"stopCauseIds": ["xyz789"],
"stopCausePeripheralId": PeripheralId,
"assetIds": [NodeId],
"startOfService": "2007-12-03T10:15:30Z",
"endOfService": "2007-12-03T10:15:30Z",
"startOfStop": "2007-12-03T10:15:30Z",
"endOfStop": "2007-12-03T10:15:30Z",
"version": 123,
"effectiveDuration": 987,
"line": Line,
"stopCauses": [StopCause],
"assets": [HierarchyNode]
}
MaintenanceLogEntryConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [MaintenanceLogEntryEdge!]!
|
A list of edges. |
nodes - [MaintenanceLogEntry!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [MaintenanceLogEntryEdge],
"nodes": [MaintenanceLogEntry]
}
MaintenanceLogEntryEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - MaintenanceLogEntry!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": MaintenanceLogEntry,
"cursor": "xyz789"
}
MaintenanceLogFilter
Fields
| Input Field | Description |
|---|---|
lineIds - [LineId!]
|
Example
{"lineIds": [LineId]}
MaintenancePlan
Fields
| Field Name | Description |
|---|---|
planId - MaintenancePlanId!
|
|
lineId - LineId!
|
|
title - String!
|
|
asset - String!
|
|
tagPartNumber - String
|
|
instructions - String
|
|
startFrom - DateTime!
|
|
trackBy - TrackByOptions!
|
|
repeat - ShouldRepeat!
|
|
version - Int!
|
|
role - MaintenanceRole!
|
|
log - MaintenanceLogEntryConnection!
|
|
nextWorkOrder - MaintenanceWorkOrder
|
|
Arguments
|
|
peripheral - Peripheral
|
|
line - Line
|
|
Example
{
"planId": MaintenancePlanId,
"lineId": LineId,
"title": "xyz789",
"asset": "xyz789",
"tagPartNumber": "abc123",
"instructions": "abc123",
"startFrom": "2007-12-03T10:15:30Z",
"trackBy": TrackByOptions,
"repeat": "YES",
"version": 123,
"role": MaintenanceRole,
"log": MaintenanceLogEntryConnection,
"nextWorkOrder": MaintenanceWorkOrder,
"peripheral": Peripheral,
"line": Line
}
MaintenancePlanConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [MaintenancePlanEdge!]!
|
A list of edges. |
nodes - [MaintenancePlan!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [MaintenancePlanEdge],
"nodes": [MaintenancePlan]
}
MaintenancePlanEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - MaintenancePlan!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": MaintenancePlan,
"cursor": "abc123"
}
MaintenancePlanFilter
Fields
| Input Field | Description |
|---|---|
lineIds - [LineId!]
|
|
roleIds - [MaintenanceRoleId!]
|
|
repeat - ShouldRepeat
|
Example
{
"lineIds": [LineId],
"roleIds": [MaintenanceRoleId],
"repeat": "YES"
}
MaintenancePlanId
Example
MaintenancePlanId
MaintenancePlanSnapshot
Fields
| Field Name | Description |
|---|---|
title - String!
|
|
asset - String!
|
|
tagPartNumber - String
|
|
instructions - String
|
|
trackBy - TrackByOptions!
|
Example
{
"title": "xyz789",
"asset": "xyz789",
"tagPartNumber": "abc123",
"instructions": "abc123",
"trackBy": TrackByOptions
}
MaintenanceRole
Fields
| Field Name | Description |
|---|---|
id - MaintenanceRoleId!
|
|
name - String
|
Example
{
"id": MaintenanceRoleId,
"name": "xyz789"
}
MaintenanceRoleId
Example
MaintenanceRoleId
MaintenanceSchedule
Fields
| Field Name | Description |
|---|---|
events - [MaintenanceEvent!]!
|
|
Example
{"events": [MaintenanceEvent]}
MaintenanceWorkOrder
Description
A work order is an actual maintenance event produced by a maintenance plan
Fields
| Field Name | Description |
|---|---|
plan - MaintenancePlan!
|
The plan that generated the work order |
dueAt - DateTime!
|
"dueAt" is the time where the event is to be done - after the cycle (time or production-based) completes |
overdueAt - DateTime!
|
"overdueAt" is the time where the grace period ends - after which the work order is overdue |
produced - Int
|
|
latestMaintenance - MaintenanceLogEntry
|
|
peripheral - Peripheral
|
|
line - Line
|
Example
{
"plan": MaintenancePlan,
"dueAt": "2007-12-03T10:15:30Z",
"overdueAt": "2007-12-03T10:15:30Z",
"produced": 987,
"latestMaintenance": MaintenanceLogEntry,
"peripheral": Peripheral,
"line": Line
}
MaintenanceWorkOrderConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [MaintenanceWorkOrderEdge!]!
|
A list of edges. |
nodes - [MaintenanceWorkOrder!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [MaintenanceWorkOrderEdge],
"nodes": [MaintenanceWorkOrder]
}
MaintenanceWorkOrderEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - MaintenanceWorkOrder!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": MaintenanceWorkOrder,
"cursor": "xyz789"
}
MaintenanceWorkOrderFilter
Fields
| Input Field | Description |
|---|---|
status - [WorkOrderStatusFilter!]
|
If set, only work orders with the given status will be returned. If not set, all work orders will be returned. |
Example
{"status": ["PLANNED"]}
ManualConfig
ManualConfigInput
ManualTriggerOptions
Fields
| Field Name | Description |
|---|---|
placeholder - Boolean
|
Example
{"placeholder": true}
ManualTriggerOptionsInput
Fields
| Input Field | Description |
|---|---|
placeholder - Boolean
|
Example
{"placeholder": true}
MarkdownOptions
Fields
| Field Name | Description |
|---|---|
content - String!
|
Example
{"content": "xyz789"}
MarkdownOptionsInput
Fields
| Input Field | Description |
|---|---|
content - String!
|
Example
{"content": "xyz789"}
MediaPresignedDownloadUrl
Fields
| Field Name | Description |
|---|---|
downloadUrl - String!
|
Example
{"downloadUrl": "abc123"}
MediaPresignedUploadUrl
Message
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - SubscriptionType!
|
|
delay - Float!
|
|
takenDelay - Float
|
Example
{
"id": "4",
"type": "SMS",
"delay": 123.45,
"takenDelay": 987.65
}
MessageContext
Fields
| Input Field | Description |
|---|---|
directoryIds - [String!]!
|
|
lineIds - [String!]!
|
Example
{
"directoryIds": ["abc123"],
"lineIds": ["xyz789"]
}
MessageStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
MinimalBatch
Example
{
"batchId": "4",
"batchNumber": "xyz789",
"plannedStart": "2007-12-03",
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"product": MinimalProduct
}
MinimalProduct
Example
{
"productId": "4",
"name": "xyz789",
"itemNumber": "abc123",
"validatedLineSpeed": 987.65,
"expectedAverageSpeed": 987.65,
"parameters": [Parameter]
}
MultiSelectFieldOptions
Fields
| Field Name | Description |
|---|---|
validation - MultiSelectFieldValidation!
|
|
options - [SelectFieldOption!]!
|
Example
{
"validation": MultiSelectFieldValidation,
"options": [SelectFieldOption]
}
MultiSelectFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
validation - MultiSelectFieldValidationInput!
|
|
options - [SelectFieldOptionInput!]!
|
Example
{
"validation": MultiSelectFieldValidationInput,
"options": [SelectFieldOptionInput]
}
MultiSelectFieldValidation
Fields
| Field Name | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
MultiSelectFieldValidationInput
Fields
| Input Field | Description |
|---|---|
required - Boolean!
|
Example
{"required": true}
Network
NetworkConfig
Fields
| Field Name | Description |
|---|---|
wifi - WiFiConfigShadow
|
|
connection - NetworkConnectionType!
|
|
general - GeneralNetworkShadowSettings!
|
Example
{
"wifi": WiFiConfigShadow,
"connection": "WIFI",
"general": GeneralNetworkShadowSettings
}
NetworkConnectionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"WIFI"
NetworkFallbackStrategy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NEVER"
NetworkInput
NewStopCauseCategory
Node
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
breadcrumb - [Breadcrumb!]!
|
|
refId - ID
|
|
alarmStatus - NodeAlarmStatus
|
|
children - [Node!]!
|
|
Arguments
|
|
leafDescendants - NodesWithPageToken
|
|
line - Line
|
|
peripheral - Peripheral
|
|
Example
{
"id": 4,
"breadcrumb": [Breadcrumb],
"refId": 4,
"alarmStatus": "Ongoing",
"children": [Node],
"leafDescendants": NodesWithPageToken,
"line": Line,
"peripheral": Peripheral
}
NodeAlarmStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Ongoing"
NodeId
Example
NodeId
NodeMeta
Types
| Union Types |
|---|
Example
LineNodeMeta
NodePosition
Values
| Enum Value | Description |
|---|---|
|
|
Node is downstream from the main peripheral |
|
|
Node is upstream from the main peripheral |
Example
"DOWNSTREAM_FROM_MAIN"
NodeType
Values
| Enum Value | Description |
|---|---|
|
|
The main counter of the line. |
|
|
A counter in the line. |
|
|
A scrap counter in the line. |
|
|
A camera on the line. |
|
|
Events from the line. |
Example
"Main"
NodesWithPageToken
NumberFieldOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUM"
NumberFieldOptions
Fields
| Field Name | Description |
|---|---|
validation - NumberFieldValidation!
|
|
passCriteria - NumberFieldPassCriteria!
|
Pass criteria are different from form validation, because they do not influence the ability to submit the form. When a form is submitted it passes by default, but fails if any value fails the pass criteria of its field. |
Example
{
"validation": NumberFieldValidation,
"passCriteria": NumberFieldPassCriteria
}
NumberFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
validation - NumberFieldValidationInput!
|
|
passCriteria - NumberFieldPassCriteriaInput!
|
Pass criteria are different from form validation, because they do not influence the ability to submit the form. When a form is submitted it passes by default, but fails if any value fails the pass criteria of its field. |
Example
{
"validation": NumberFieldValidationInput,
"passCriteria": NumberFieldPassCriteriaInput
}
NumberFieldPassCriteria
NumberFieldPassCriteriaInput
NumberFieldValidation
NumberFieldValidationInput
OEE
Fields
| Field Name | Description |
|---|---|
oee1 - Float!
|
|
oee2 - Float!
|
|
oee3 - Float!
|
|
tcu - Float!
|
|
totalEquipmentTime - Float!
|
|
mannedTime - Float!
|
|
operatingTime - Float!
|
|
productionTime - Float!
|
|
valuedOperatingTime - Float!
|
|
scrapLoss - Float!
|
|
speedLoss - Float!
|
|
oee1MaxProduced - Float!
|
|
oee2MaxProduced - Float!
|
|
oee3MaxProduced - Float!
|
|
tcuMaxProduced - Float!
|
Example
{
"oee1": 123.45,
"oee2": 987.65,
"oee3": 123.45,
"tcu": 987.65,
"totalEquipmentTime": 987.65,
"mannedTime": 987.65,
"operatingTime": 987.65,
"productionTime": 987.65,
"valuedOperatingTime": 987.65,
"scrapLoss": 987.65,
"speedLoss": 123.45,
"oee1MaxProduced": 987.65,
"oee2MaxProduced": 123.45,
"oee3MaxProduced": 123.45,
"tcuMaxProduced": 987.65
}
OEEDocumentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"STOPS_LAST_6_DAYS"
OEEInput
Fields
| Input Field | Description |
|---|---|
preferences - OEEPreferences
|
Example
{"preferences": OEEPreferences}
OEEPreferences
OEEType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OEE1"
OfflineStatus
OffsetDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BEFORE"
Operator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQ"
Order
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASCENDING"
OrderDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASCENDING"
Ordering
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Ascending"
OriginalControlDetails
OwnerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SENSOR"
Packaging
PackagingFilter
PackagingList
Fields
| Field Name | Description |
|---|---|
nextToken - ID
|
|
items - [Packaging!]!
|
Example
{"nextToken": 4, "items": [Packaging]}
PageInfo
Description
Information about pagination in a connection
Fields
| Field Name | Description |
|---|---|
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
endCursor - String
|
When paginating forwards, the cursor to continue. |
Example
{
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "abc123",
"endCursor": "abc123"
}
Parameter
PassFailFieldOptions
Fields
| Field Name | Description |
|---|---|
validation - PassFailFieldValidation!
|
|
passCriteria - PassFailPassCriteria!
|
|
translations - [PassFailFieldTranslation!]!
|
|
passLabel - String!
|
|
failLabel - String!
|
Example
{
"validation": PassFailFieldValidation,
"passCriteria": PassFailPassCriteria,
"translations": [PassFailFieldTranslation],
"passLabel": "xyz789",
"failLabel": "xyz789"
}
PassFailFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
validation - PassFailFieldValidationInput!
|
|
passCriteria - PassFailPassCriteriaInput!
|
|
translations - [PassFailFieldTranslationInput!]!
|
Example
{
"validation": PassFailFieldValidationInput,
"passCriteria": PassFailPassCriteriaInput,
"translations": [PassFailFieldTranslationInput]
}
PassFailFieldTranslation
PassFailFieldTranslationInput
PassFailFieldValidation
Fields
| Field Name | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
PassFailFieldValidationInput
Fields
| Input Field | Description |
|---|---|
required - Boolean!
|
Example
{"required": true}
PassFailPassCriteria
Fields
| Field Name | Description |
|---|---|
mustPass - Boolean!
|
Example
{"mustPass": true}
PassFailPassCriteriaInput
Fields
| Input Field | Description |
|---|---|
mustPass - Boolean!
|
Example
{"mustPass": false}
PendingActivityFilter
Fields
| Input Field | Description |
|---|---|
activityTemplateIds - [ActivityTemplateId!]
|
|
customFormIds - [CustomFormId!]
|
|
locationIds - [NodeId!]
|
|
createdBefore - DateTime
|
|
createdAfter - DateTime
|
|
trigger - TriggerFilter
|
Example
{
"activityTemplateIds": [ActivityTemplateId],
"customFormIds": [CustomFormId],
"locationIds": [NodeId],
"createdBefore": "2007-12-03T10:15:30Z",
"createdAfter": "2007-12-03T10:15:30Z",
"trigger": TriggerFilter
}
Peripheral
Example
{
"_id": 4,
"id": "4",
"name": "abc123",
"index": 4,
"peripheralId": 4,
"owner": "4",
"hardwareId": 4,
"peripheralType": "CAMERA",
"description": "xyz789",
"offlineStatus": OfflineStatus,
"device": Device,
"hardwareDevice": Device
}
PeripheralId
Description
Format:
Example
PeripheralId
PeripheralInformation
PeripheralMetaInput
PeripheralNodeMeta
Fields
| Field Name | Description |
|---|---|
peripheralId - PeripheralId!
|
|
labels - [String!]!
|
|
peripheral - Peripheral
|
Example
{
"peripheralId": PeripheralId,
"labels": ["abc123"],
"peripheral": Peripheral
}
PeripheralNodeMetaInput
Fields
| Input Field | Description |
|---|---|
peripheralId - PeripheralId!
|
|
labels - [String!]
|
Example
{
"peripheralId": PeripheralId,
"labels": ["abc123"]
}
PeripheralNodeMetaUpdateInput
Fields
| Input Field | Description |
|---|---|
labels - [String!]
|
Example
{"labels": ["xyz789"]}
PeripheralType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CAMERA"
PeripheralsPaginated
Fields
| Field Name | Description |
|---|---|
items - [Peripheral!]!
|
|
nextOffset - Int
|
|
total - Int!
|
Example
{"items": [Peripheral], "nextOffset": 987, "total": 987}
Permission
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
type - RequestType!
|
|
description - String
|
Example
{
"key": "abc123",
"type": "QUERY",
"description": "xyz789"
}
PermissionInput
Fields
| Input Field | Description |
|---|---|
key - String!
|
|
type - RequestType!
|
Example
{"key": "xyz789", "type": "QUERY"}
PreSignedURL
Product
Fields
| Field Name | Description |
|---|---|
productId - ID!
|
|
name - String!
|
|
itemNumber - String!
|
|
validatedLineSpeed - Float!
|
|
expectedAverageSpeed - Float!
|
|
comment - String
|
|
lineId - ID!
|
|
dataMultiplier - Float!
|
|
packaging - Packaging!
|
|
overwrittenByBatch - Boolean
|
|
parameters - [Parameter!]!
|
|
attachedControlReceipts - [ControlReceipt!]!
|
Example
{
"productId": 4,
"name": "abc123",
"itemNumber": "xyz789",
"validatedLineSpeed": 123.45,
"expectedAverageSpeed": 123.45,
"comment": "xyz789",
"lineId": "4",
"dataMultiplier": 123.45,
"packaging": Packaging,
"overwrittenByBatch": true,
"parameters": [Parameter],
"attachedControlReceipts": [ControlReceipt]
}
ProductFilter
ProductList
Fields
| Field Name | Description |
|---|---|
nextToken - ID
|
|
items - [Product!]!
|
Example
{"nextToken": 4, "items": [Product]}
PublishDataInput
Fields
| Input Field | Description |
|---|---|
peripheralId - ID!
|
Must be a peripheral on a virtual device |
values - [PublishDataValue!]!
|
Example
{"peripheralId": 4, "values": [PublishDataValue]}
PublishDataValue
RRule
Description
RRule string
Example
RRule
ReplaceDeviceInput
ReplacePeripheralsInput
ReportStopFilter
Fields
| Field Name | Description |
|---|---|
stopTypes - [StopType!]
|
|
stopCauseIds - [ID!]
|
|
includeMicroStops - Boolean
|
Example
{
"stopTypes": ["NO_ACT"],
"stopCauseIds": ["4"],
"includeMicroStops": true
}
ReportSubscriber
Fields
| Field Name | Description |
|---|---|
type - SubscriptionType!
|
|
value - String!
|
|
languageCode - String!
|
|
disabled - Boolean!
|
Example
{
"type": "SMS",
"value": "abc123",
"languageCode": "abc123",
"disabled": true
}
ReportSubscriberInput
Fields
| Input Field | Description |
|---|---|
type - SubscriptionType!
|
|
value - String!
|
|
languageCode - String!
|
|
disabled - Boolean
|
Example
{
"type": "SMS",
"value": "xyz789",
"languageCode": "abc123",
"disabled": false
}
ReportType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"STOPS_LAST_6_DAYS"
RequestType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"QUERY"
Resource
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
claims - [ClaimId!]!
|
Example
{
"key": "xyz789",
"claims": [ClaimId]
}
RevokeAPITokenInput
Fields
| Input Field | Description |
|---|---|
token - String!
|
Example
{"token": "abc123"}
Role
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
type - RoleType!
|
|
permissions - [Permission!]!
|
Example
{
"id": 4,
"name": "xyz789",
"type": "SUPER",
"permissions": [Permission]
}
RoleAttributes
Fields
| Input Field | Description |
|---|---|
name - String
|
|
permissionKeys - [PermissionInput!]
|
Example
{
"name": "abc123",
"permissionKeys": [PermissionInput]
}
RoleCreateInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
languageCode - String
|
|
escalationConfiguration - [EscalationConfigurationInput!]
|
Example
{
"name": "xyz789",
"languageCode": "abc123",
"escalationConfiguration": [
EscalationConfigurationInput
]
}
RoleType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SUPER"
RoleUpdateInput
Fields
| Input Field | Description |
|---|---|
name - String
|
|
languageCode - String
|
|
escalationConfiguration - [EscalationConfigurationInput!]
|
Example
{
"name": "xyz789",
"languageCode": "abc123",
"escalationConfiguration": [
EscalationConfigurationInput
]
}
Sample
Fields
| Field Name | Description |
|---|---|
data - SampleData!
|
|
timeRange - TimeRange!
|
Example
{
"data": SampleData,
"timeRange": TimeRange
}
SampleData
Schedule
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
lineId - ID!
|
|
validFrom - ScheduleTime!
|
|
validTo - ScheduleTime
|
|
shifts - [Shift!]!
|
|
weeklyTargets - Targets!
|
|
configuration - ScheduleConfiguration!
|
|
isExceptionalWeek - Boolean!
|
|
isFallbackSchedule - Boolean!
|
Example
{
"id": 4,
"lineId": "4",
"validFrom": ScheduleTime,
"validTo": ScheduleTime,
"shifts": [Shift],
"weeklyTargets": Targets,
"configuration": ScheduleConfiguration,
"isExceptionalWeek": true,
"isFallbackSchedule": true
}
ScheduleConfiguration
Fields
| Field Name | Description |
|---|---|
lineId - ID!
|
|
disableLostConnectionAlarmOutsideWorkingHours - Boolean!
|
|
automaticStopRegistration - AutomaticStopRegistration!
|
|
startDayOfWeek - DayOfWeek!
|
|
timezone - String!
|
Example
{
"lineId": "4",
"disableLostConnectionAlarmOutsideWorkingHours": true,
"automaticStopRegistration": AutomaticStopRegistration,
"startDayOfWeek": "MONDAY",
"timezone": "abc123"
}
ScheduleConfigurationInput
Fields
| Input Field | Description |
|---|---|
disableLostConnectionAlarmOutsideWorkingHours - Boolean!
|
|
automaticStopRegistration - AutomaticStopRegistrationInput
|
|
startDayOfWeek - DayOfWeek!
|
|
timezone - String!
|
Example
{
"disableLostConnectionAlarmOutsideWorkingHours": false,
"automaticStopRegistration": AutomaticStopRegistrationInput,
"startDayOfWeek": "MONDAY",
"timezone": "abc123"
}
ScheduleCreateInput
ScheduleTime
ScheduleTimeInput
ScheduleUpdateInput
ScheduledReport
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - ReportType!
|
|
entityId - ID!
|
|
entityType - EntityType!
|
|
name - String!
|
|
description - String
|
|
enabled - Boolean!
|
|
subscribers - [ReportSubscriber!]!
|
|
trigger - ScheduledReportTrigger!
|
|
nextTriggerDate - Date!
|
|
timezone - String!
|
|
stopFilter - ReportStopFilter
|
Example
{
"id": "4",
"type": "STOPS_LAST_6_DAYS",
"entityId": "4",
"entityType": "LINE",
"name": "abc123",
"description": "abc123",
"enabled": true,
"subscribers": [ReportSubscriber],
"trigger": ScheduledReportTrigger,
"nextTriggerDate": "2007-12-03",
"timezone": "xyz789",
"stopFilter": ReportStopFilter
}
ScheduledReportTrigger
Fields
| Field Name | Description |
|---|---|
type - TriggerType!
|
|
parameters - String!
|
Example
{"type": "CRON", "parameters": "xyz789"}
ScrapData
SelectEntityFieldOptions
Fields
| Field Name | Description |
|---|---|
validation - SelectEntityFieldValidation!
|
|
entity - Entity!
|
Example
{
"validation": SelectEntityFieldValidation,
"entity": "PERIPHERAL"
}
SelectEntityFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
validation - SelectEntityFieldValidationInput!
|
|
entity - Entity!
|
Example
{
"validation": SelectEntityFieldValidationInput,
"entity": "PERIPHERAL"
}
SelectEntityFieldValidation
Fields
| Field Name | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
SelectEntityFieldValidationInput
Fields
| Input Field | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
SelectFieldOption
Fields
| Field Name | Description |
|---|---|
value - String!
|
|
label - String!
|
|
labelTranslations - [SelectOptionLabel!]!
|
Example
{
"value": "abc123",
"label": "abc123",
"labelTranslations": [SelectOptionLabel]
}
SelectFieldOptionInput
Fields
| Input Field | Description |
|---|---|
value - String!
|
|
labelTranslations - [SelectOptionLabelInput!]!
|
Example
{
"value": "xyz789",
"labelTranslations": [SelectOptionLabelInput]
}
SelectFieldOptions
Fields
| Field Name | Description |
|---|---|
validation - SelectFieldValidation!
|
|
options - [SelectFieldOption!]!
|
Example
{
"validation": SelectFieldValidation,
"options": [SelectFieldOption]
}
SelectFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
validation - SelectFieldValidationInput!
|
|
options - [SelectFieldOptionInput!]!
|
Example
{
"validation": SelectFieldValidationInput,
"options": [SelectFieldOptionInput]
}
SelectFieldValidation
Fields
| Field Name | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
SelectFieldValidationInput
Fields
| Input Field | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
SelectOptionLabel
SelectOptionLabelInput
Sensor
Fields
| Field Name | Description |
|---|---|
_id - ID
|
|
id - ID!
|
Use peripheralId instead.
|
name - String!
|
|
index - ID!
|
|
peripheralId - ID!
|
|
owner - ID
|
|
hardwareId - ID
|
|
peripheralType - PeripheralType!
|
|
config - SensorConfig!
|
|
description - String!
|
|
offlineStatus - OfflineStatus!
|
|
cameras - [Camera]!
|
|
customKPIs - [CustomKPI!]!
|
|
device - Device!
|
|
hardwareDevice - Device
|
|
peripheralInformation - PeripheralInformation
|
The line information for the peripheral. |
alarms - [Alarm]!
|
Get a list of all alarms. |
alarm - Alarm!
|
Get a specific alarm. |
stopCauseCategories - [StopCauseCategory!]!
|
Get the stop cause categories of the sensor. |
Arguments
|
|
stopCauseMappings - [StopCauseMapping]!
|
Get the stop cause categories of the sensor. |
time - [SensorTimeData!]!
|
Time dependant fields of the sensor. |
Arguments
|
|
groups - [Group!]!
|
Groups the sensor is member of |
horizontalAnnotations - [HorizontalAnnotation!]
|
Horizontal annotations on the sensor |
verticalAnnotations - [VerticalAnnotation!]
|
Vertical annotations on the sensor |
Arguments |
|
scheduledReports - [ScheduledReport!]!
|
Get scheduled reports for the sensor |
maintenanceWorkOrders - MaintenanceWorkOrderConnection!
|
Get the sensor's maintenance work orders |
Arguments |
|
Example
{
"_id": 4,
"id": "4",
"name": "xyz789",
"index": "4",
"peripheralId": 4,
"owner": "4",
"hardwareId": "4",
"peripheralType": "CAMERA",
"config": SensorConfig,
"description": "abc123",
"offlineStatus": OfflineStatus,
"cameras": [Camera],
"customKPIs": [CustomKPI],
"device": Device,
"hardwareDevice": Device,
"peripheralInformation": PeripheralInformation,
"alarms": [Alarm],
"alarm": Alarm,
"stopCauseCategories": [StopCauseCategory],
"stopCauseMappings": [StopCauseMapping],
"time": [SensorTimeData],
"groups": [Group],
"horizontalAnnotations": [HorizontalAnnotation],
"verticalAnnotations": [VerticalAnnotation],
"scheduledReports": [ScheduledReport],
"maintenanceWorkOrders": MaintenanceWorkOrderConnection
}
SensorConfig
Fields
| Field Name | Description |
|---|---|
validFrom - Date
|
|
type - SensorType
|
|
energyMeter - Boolean
|
|
wiring - SensorWiringState
|
|
inputMode - InputModeState
|
|
debounce - DebounceState
|
|
stopThreshold - Int
|
|
stopRegisterThreshold - Int
|
|
stopValueThreshold - Float
|
|
dataMultiplier - Float
|
|
validatedSpeed - Float
|
|
expectedSpeed - Float
|
|
analogOffset - Float
|
|
analogInputRange - AnalogInputRange
|
|
sensorUnit - SensorUnit
|
|
chartTimeScale - ChartTimeScale
|
Use chart.scale instead.
|
accumulatorConfig - AccumulatorConfig
|
|
discreteConfig - DiscreteConfig
|
|
manualConfig - ManualConfig
|
|
publishRate - Int
|
Unused, and will always resolve to null. |
sampleRate - Int
|
Unused, and will always resolve to null. |
triggerIndex - Int
|
Unused, and will always resolve to null. |
dataAlarm - DataAlarm
|
|
findStops - Boolean
|
|
chart - ChartConfiguration
|
|
kpiConfig - KPIConfiguration
|
|
subtractCycleTime - Boolean
|
|
extraMultiplierForFrontend - Float
|
This value is only needed in the frontend for knowing how the offset + multiplier got scaled when doing min/max + scale, changes nothing on the backend. |
Example
{
"validFrom": "2007-12-03",
"type": "COUNTER",
"energyMeter": false,
"wiring": SensorWiringState,
"inputMode": InputModeState,
"debounce": DebounceState,
"stopThreshold": 123,
"stopRegisterThreshold": 987,
"stopValueThreshold": 123.45,
"dataMultiplier": 987.65,
"validatedSpeed": 987.65,
"expectedSpeed": 123.45,
"analogOffset": 123.45,
"analogInputRange": "NEGATIVE_TEN_TO_TEN_VOLTS",
"sensorUnit": SensorUnit,
"chartTimeScale": "DAY",
"accumulatorConfig": AccumulatorConfig,
"discreteConfig": DiscreteConfig,
"manualConfig": ManualConfig,
"publishRate": 987,
"sampleRate": 123,
"triggerIndex": 123,
"dataAlarm": DataAlarm,
"findStops": true,
"chart": ChartConfiguration,
"kpiConfig": KPIConfiguration,
"subtractCycleTime": true,
"extraMultiplierForFrontend": 123.45
}
SensorConfigInput
Fields
| Input Field | Description |
|---|---|
type - SensorType
|
|
energyMeter - Boolean
|
|
wiring - SensorWiring
|
|
inputMode - InputMode
|
|
debounce - Int
|
|
stopThreshold - Int
|
|
stopRegisterThreshold - Int
|
|
stopValueThreshold - Float
|
|
dataMultiplier - Float
|
|
validatedSpeed - Float
|
|
expectedSpeed - Float
|
|
analogOffset - Float
|
|
analogInputRange - AnalogInputRange
|
|
sensorUnit - SensorUnitInput
|
|
chartTimeScale - ChartTimeScale
|
|
accumulatorConfig - AccumulatorConfigInput
|
|
discreteConfig - DiscreteConfigInput
|
|
manualConfig - ManualConfigInput
|
|
publishRate - Int
|
|
sampleRate - Int
|
|
triggerIndex - Int
|
|
dataAlarm - DataAlarmInput
|
|
findStops - Boolean
|
|
chart - ChartConfigurationInput
|
|
kpiConfig - KPIConfigurationInput
|
|
subtractCycleTime - Boolean
|
|
extraMultiplierForFrontend - Float
|
Example
{
"type": "COUNTER",
"energyMeter": false,
"wiring": "INACTIVE",
"inputMode": "COUNTER",
"debounce": 987,
"stopThreshold": 987,
"stopRegisterThreshold": 123,
"stopValueThreshold": 123.45,
"dataMultiplier": 987.65,
"validatedSpeed": 987.65,
"expectedSpeed": 987.65,
"analogOffset": 987.65,
"analogInputRange": "NEGATIVE_TEN_TO_TEN_VOLTS",
"sensorUnit": SensorUnitInput,
"chartTimeScale": "DAY",
"accumulatorConfig": AccumulatorConfigInput,
"discreteConfig": DiscreteConfigInput,
"manualConfig": ManualConfigInput,
"publishRate": 123,
"sampleRate": 123,
"triggerIndex": 987,
"dataAlarm": DataAlarmInput,
"findStops": false,
"chart": ChartConfigurationInput,
"kpiConfig": KPIConfigurationInput,
"subtractCycleTime": true,
"extraMultiplierForFrontend": 123.45
}
SensorTimeData
Fields
| Field Name | Description |
|---|---|
configs - [SensorConfig!]!
|
Get all the sensor configs within the time range. |
alarmLogs - AlarmLogs!
|
Get all the alarm logs. |
Arguments |
|
batches - BatchList!
|
Get batches of the line, this sensor is part of. |
Arguments |
|
dataOverrides - [DataOverride!]!
|
Get data overrides on the sensor |
samples - [Sample!]!
|
Get samples of the sensor. |
stops - [Stop!]!
|
Get stops of the sensor. |
Arguments
|
|
stopStats - StopStats!
|
Get stop-related stats of the sensor. |
Arguments
|
|
stats - Stat!
|
Get stats KPIs of the sensor. |
Arguments
|
|
_id - ID
|
|
timeRange - TimeRange!
|
|
Example
{
"configs": [SensorConfig],
"alarmLogs": AlarmLogs,
"batches": BatchList,
"dataOverrides": [DataOverride],
"samples": [Sample],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat,
"_id": 4,
"timeRange": TimeRange
}
SensorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COUNTER"
SensorUnit
SensorUnitInput
SensorWiring
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"INACTIVE"
SensorWiringState
Fields
| Field Name | Description |
|---|---|
desired - SensorWiring
|
|
reported - SensorWiring
|
Example
{"desired": "INACTIVE", "reported": "INACTIVE"}
Session
Example
{
"generatedAt": "2007-12-03",
"expiresAt": "2007-12-03",
"userSub": 4
}
SessionConnection
Fields
| Field Name | Description |
|---|---|
edges - [SessionEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [SessionEdge],
"pageInfo": PageInfo
}
SessionEdge
SessionFilter
Fields
| Input Field | Description |
|---|---|
sub - ID
|
Example
{"sub": "4"}
SessionOrder
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection
|
|
field - SessionOrderField
|
Example
{"direction": "ASCENDING", "field": "GENERATED_AT"}
SessionOrderField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"GENERATED_AT"
SetAlarmEnablementInput
SetPoint
Fields
| Field Name | Description |
|---|---|
peripheralId - ID!
|
|
peripheral - Peripheral!
|
|
value - Float!
|
Example
{
"peripheralId": 4,
"peripheral": Peripheral,
"value": 987.65
}
Shift
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
description - String!
|
|
timeRange - ShiftTimeRange!
|
|
targets - Targets!
|
Example
{
"id": "4",
"name": "abc123",
"description": "xyz789",
"timeRange": ShiftTimeRange,
"targets": Targets
}
ShiftCreateInput
ShiftEndTriggerOptions
Fields
| Field Name | Description |
|---|---|
placeholder - Boolean
|
|
offsetMinutes - Int
|
|
offsetDirection - OffsetDirection
|
Example
{"placeholder": true, "offsetMinutes": 123, "offsetDirection": "BEFORE"}
ShiftEndTriggerOptionsInput
Fields
| Input Field | Description |
|---|---|
placeholder - Boolean
|
|
offsetMinutes - Int
|
|
offsetDirection - OffsetDirection
|
Example
{"placeholder": true, "offsetMinutes": 987, "offsetDirection": "BEFORE"}
ShiftInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
name - String!
|
|
description - String!
|
|
timeRange - ShiftTimeRangeInput!
|
|
targets - TargetsInput!
|
Example
{
"id": 4,
"name": "abc123",
"description": "abc123",
"timeRange": ShiftTimeRangeInput,
"targets": TargetsInput
}
ShiftInstance
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
from - Date!
|
|
to - Date!
|
|
name - String!
|
|
description - String!
|
|
shiftId - ID!
|
|
batches - BatchList!
|
Get batches contained within this shift. |
Arguments |
|
samples - [Sample!]!
|
Get the samples collected within the timespan of the shift. |
Arguments
|
|
stops - [Stop!]!
|
Get the stops collected within the timespan of the shift. |
Arguments
|
|
stopStats - StopStats!
|
|
Arguments
|
|
stats - Stat!
|
Get the stats collected within the timespan of the shift. |
Example
{
"id": 4,
"from": "2007-12-03",
"to": "2007-12-03",
"name": "abc123",
"description": "xyz789",
"shiftId": 4,
"batches": BatchList,
"samples": [Sample],
"stops": [Stop],
"stopStats": StopStats,
"stats": Stat
}
ShiftStartTriggerOptions
Fields
| Field Name | Description |
|---|---|
placeholder - Boolean
|
|
offsetMinutes - Int
|
|
offsetDirection - OffsetDirection
|
Example
{"placeholder": false, "offsetMinutes": 123, "offsetDirection": "BEFORE"}
ShiftStartTriggerOptionsInput
Fields
| Input Field | Description |
|---|---|
placeholder - Boolean
|
|
offsetMinutes - Int
|
|
offsetDirection - OffsetDirection
|
Example
{"placeholder": true, "offsetMinutes": 987, "offsetDirection": "BEFORE"}
ShiftTime
Fields
| Field Name | Description |
|---|---|
day - DayOfWeek!
|
|
hour - Int!
|
|
minute - Int!
|
Example
{"day": "MONDAY", "hour": 123, "minute": 987}
ShiftTimeInput
Fields
| Input Field | Description |
|---|---|
day - DayOfWeek!
|
|
hour - Int!
|
|
minute - Int!
|
Example
{"day": "MONDAY", "hour": 123, "minute": 987}
ShiftTimeRange
Fields
| Field Name | Description |
|---|---|
from - ShiftTime!
|
|
to - ShiftTime!
|
Example
{"from": ShiftTime, "to": ShiftTime}
ShiftTimeRangeInput
Fields
| Input Field | Description |
|---|---|
from - ShiftTimeInput!
|
|
to - ShiftTimeInput!
|
Example
{
"from": ShiftTimeInput,
"to": ShiftTimeInput
}
ShiftUpdateInput
ShouldRepeat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"YES"
Skill
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
title - String!
|
|
description - String
|
|
nodeId - ID!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
createdBySub - String!
|
|
updatedBySub - String!
|
|
learningActivities - SkillLearningActivitiesConnection!
|
Internal use only |
node - HierarchyNode
|
|
createdBy - User
|
|
updatedBy - User
|
|
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"title": "abc123",
"description": "abc123",
"nodeId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "abc123",
"updatedBySub": "xyz789",
"learningActivities": SkillLearningActivitiesConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User
}
SkillConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [SkillEdge!]!
|
A list of edges. |
nodes - [Skill!]!
|
A list of nodes. |
totalCount - Int!
|
Example
{
"pageInfo": PageInfo,
"edges": [SkillEdge],
"nodes": [Skill],
"totalCount": 123
}
SkillEdge
SkillFilter
SkillLearningActivitiesConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [SkillLearningActivitiesEdge!]!
|
A list of edges. |
nodes - [SkillLearningActivity!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [SkillLearningActivitiesEdge],
"nodes": [SkillLearningActivity]
}
SkillLearningActivitiesEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - SkillLearningActivity!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": SkillLearningActivity,
"cursor": "abc123"
}
SkillLearningActivity
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"version": 123,
"nodeId": "xyz789",
"title": "xyz789",
"description": "abc123",
"content": "abc123",
"startEndDatesRequired": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "abc123",
"updatedBy": "xyz789",
"orderIndex": 123,
"node": HierarchyNode
}
SkillStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENROLLED"
StandaloneConfiguration
Fields
| Field Name | Description |
|---|---|
excludeProduction - Boolean
|
Example
{"excludeProduction": true}
StandaloneConfigurationInput
Fields
| Input Field | Description |
|---|---|
excludeProduction - Boolean
|
Example
{"excludeProduction": false}
StartBatchByBatchNumberInput
Stat
Fields
| Field Name | Description |
|---|---|
timeRange - TimeRange!
|
|
data - Data!
|
Example
{
"timeRange": TimeRange,
"data": Data
}
StatsInput
Fields
| Input Field | Description |
|---|---|
batchesInput - BatchesInput
|
Example
{"batchesInput": BatchesInput}
Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OFF"
StatusDetails
Stop
Fields
| Field Name | Description |
|---|---|
_id - ID!
|
|
timeRange - TimeRange!
|
|
originalStart - Date!
|
|
ongoing - Boolean!
|
|
duration - Float!
|
|
stopCause - StopCause
|
|
comment - String
|
|
initials - String
|
|
registeredTime - Date
|
|
isMicroStop - Boolean!
|
|
isAutomaticRegistration - Boolean
|
|
standalone - StandaloneConfiguration
|
|
target - Target
|
|
countermeasure - String
|
|
countermeasureInitials - String
|
Example
{
"_id": 4,
"timeRange": TimeRange,
"originalStart": "2007-12-03",
"ongoing": true,
"duration": 123.45,
"stopCause": StopCause,
"comment": "xyz789",
"initials": "abc123",
"registeredTime": "2007-12-03",
"isMicroStop": true,
"isAutomaticRegistration": true,
"standalone": StandaloneConfiguration,
"target": Target,
"countermeasure": "abc123",
"countermeasureInitials": "xyz789"
}
StopBatchByBatchNumberInput
StopCause
Fields
| Field Name | Description |
|---|---|
_id - ID!
|
|
id - ID!
|
|
stopType - StopType!
|
|
categoryId - String!
|
|
categoryName - String!
|
|
name - String!
|
|
description - String!
|
|
meta - [StopCauseMeta!]!
|
|
order - Int!
|
|
requireInitials - Boolean!
|
|
requireComment - Boolean!
|
|
deleted - Boolean!
|
|
languageCode - String!
|
|
legacyStopCauseId - ID
|
|
targetSetup - TargetSetup
|
|
enableCountermeasure - Boolean!
|
Example
{
"_id": 4,
"id": 4,
"stopType": "NO_ACT",
"categoryId": "xyz789",
"categoryName": "xyz789",
"name": "abc123",
"description": "xyz789",
"meta": [StopCauseMeta],
"order": 987,
"requireInitials": false,
"requireComment": false,
"deleted": false,
"languageCode": "abc123",
"legacyStopCauseId": 4,
"targetSetup": TargetSetup,
"enableCountermeasure": false
}
StopCauseCategory
Fields
| Field Name | Description |
|---|---|
_id - ID!
|
|
id - ID!
|
|
ownerType - OwnerType!
|
|
order - Int!
|
|
name - String!
|
|
meta - [StopCauseCategoryMeta!]!
|
|
languageCode - String!
|
|
deleted - Boolean!
|
|
stopCauses - [StopCause!]!
|
|
legacyCategoryId - ID
|
Example
{
"_id": "4",
"id": 4,
"ownerType": "SENSOR",
"order": 987,
"name": "xyz789",
"meta": [StopCauseCategoryMeta],
"languageCode": "abc123",
"deleted": true,
"stopCauses": [StopCause],
"legacyCategoryId": 4
}
StopCauseCategoryInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
translations - [StopCauseCategoryTranslationInput!]!
|
Example
{
"id": "4",
"translations": [StopCauseCategoryTranslationInput]
}
StopCauseCategoryMeta
StopCauseCategoryMetaInput
StopCauseCategoryTranslation
StopCauseCategoryTranslationInput
StopCauseMapping
Example
{
"_id": "4",
"peripheralIdEvent": "abc123",
"peripheralIdTarget": "xyz789",
"value": "abc123",
"stopCauseId": 4,
"buffer": 123,
"lookForward": 987,
"lookBack": 123,
"userPool": "abc123",
"split": true,
"regPriority": 987
}
StopCauseMappingInput
Example
{
"peripheralIdEvent": "abc123",
"peripheralIdTarget": "abc123",
"value": "xyz789",
"stopCauseId": "4",
"buffer": 123,
"lookForward": 987,
"lookBack": 123,
"split": false,
"regPriority": 987,
"userPool": "xyz789"
}
StopCauseMeta
StopCauseMetaInput
StopCauseStat
Example
{
"stopCauseId": 4,
"stopCauseName": "xyz789",
"stopCauseDescription": "abc123",
"stopCategoryName": "xyz789",
"type": "NO_ACT",
"numberOfStops": 987,
"accDuration": 123.45,
"accTarget": 987.65,
"isMicroStop": false
}
StopCauseTranslation
StopCauseTranslationInput
StopFilter
Example
{
"minDuration": 123.45,
"includeMicroStops": true,
"stopCauseIds": ["4"],
"stopCauseName": "abc123",
"stopTypes": ["NO_ACT"],
"excludeStandaloneStops": false,
"excludeNonChangeoverTrackingStops": true
}
StopFilterInput
Fields
| Input Field | Description |
|---|---|
stopTypes - [StopType!]
|
|
stopCauseIds - [ID!]
|
|
includeMicroStops - Boolean
|
Example
{
"stopTypes": ["NO_ACT"],
"stopCauseIds": ["4"],
"includeMicroStops": false
}
StopRegistrationTriggerOptions
StopRegistrationTriggerOptionsInput
StopStats
Fields
| Field Name | Description |
|---|---|
longestNonStop - Float!
|
|
lastStop - Stop
|
|
stopCauseStats - [StopCauseStat]!
|
Example
{
"longestNonStop": 123.45,
"lastStop": Stop,
"stopCauseStats": [StopCauseStat]
}
StopType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NO_ACT"
StopTypeForAlarms
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NO_ACT"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
Subscriber
Fields
| Field Name | Description |
|---|---|
type - SubscriberType!
|
|
value - String!
|
|
languageCode - String!
|
Example
{
"type": "EMAIL",
"value": "xyz789",
"languageCode": "abc123"
}
SubscriberInput
Fields
| Input Field | Description |
|---|---|
type - SubscriberType!
|
|
languageCode - String!
|
|
value - String!
|
Example
{
"type": "EMAIL",
"languageCode": "abc123",
"value": "abc123"
}
SubscriberOutput
Fields
| Field Name | Description |
|---|---|
type - SubscriberType!
|
|
languageCode - String!
|
|
value - String!
|
Example
{
"type": "EMAIL",
"languageCode": "abc123",
"value": "abc123"
}
SubscriberType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EMAIL"
SubscriptionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SMS"
SupportType
SwapPeripheralsInput
Tag
Target
TargetInput
TargetSetup
Fields
| Field Name | Description |
|---|---|
constantTime - Float!
|
|
parameterTimes - [TargetSetupParameterTime!]!
|
Example
{
"constantTime": 123.45,
"parameterTimes": [TargetSetupParameterTime]
}
TargetSetupInput
Fields
| Input Field | Description |
|---|---|
constantTime - Float!
|
|
parameterTimes - [TargetSetupParameterTimeInput!]!
|
Example
{
"constantTime": 123.45,
"parameterTimes": [TargetSetupParameterTimeInput]
}
TargetSetupParameterTime
TargetSetupParameterTimeInput
Targets
Example
{
"lineId": 4,
"validFrom": ScheduleTime,
"id": "4",
"oee": 987.65,
"oee2": 123.45,
"oee3": 987.65,
"tcu": 987.65,
"produced": 123.45,
"numberOfBatches": 987.65,
"mainOeeType": "OEE1"
}
TargetsInput
TextFieldOptions
Fields
| Field Name | Description |
|---|---|
validation - TextFieldValidation!
|
Example
{"validation": TextFieldValidation}
TextFieldOptionsInput
Fields
| Input Field | Description |
|---|---|
validation - TextFieldValidationInput!
|
Example
{"validation": TextFieldValidationInput}
TextFieldValidation
Fields
| Field Name | Description |
|---|---|
required - Boolean!
|
Example
{"required": true}
TextFieldValidationInput
Fields
| Input Field | Description |
|---|---|
required - Boolean!
|
Example
{"required": false}
ThingEndpoint
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The identifier for this endpoint |
name - String!
|
The name of this endpoint |
domainName - String!
|
Whether the endpoint is enabled. |
enabled - Boolean!
|
Whether the endpoint is enabled. |
authenticationType - String!
|
The authentication type that determines how devices authenticate when connecting. |
applicationProtocol - String!
|
The protocol used to communicate with endpoint. |
Example
{
"id": "4",
"name": "xyz789",
"domainName": "xyz789",
"enabled": true,
"authenticationType": "xyz789",
"applicationProtocol": "xyz789"
}
Time
TimeFilter
TimeRange
TimedTriggerPayload
Fields
| Field Name | Description |
|---|---|
millis - Int!
|
Example
{"millis": 987}
TimedTriggerPayloadInput
Fields
| Input Field | Description |
|---|---|
millis - Int!
|
Example
{"millis": 123}
Token
TokenInput
TrackByCalendar
Description
Describes how a calendar-based maintenance plan produces recurring work orders
Fields
| Field Name | Description |
|---|---|
rrule - RRule!
|
The calendar rule that determines when a new work order is due |
gracePeriodDays - Int!
|
Combined with "gracePeriodHours" to represent the time from a work order is due until it is overdue |
gracePeriodHours - Int!
|
Combined with "gracePeriodDays" to represent the time from a work order is due until it is overdue |
Example
{
"rrule": RRule,
"gracePeriodDays": 987,
"gracePeriodHours": 123
}
TrackByCalendarInput
TrackByOptions
Fields
| Field Name | Description |
|---|---|
time - TrackByTime
|
|
production - TrackByProduction
|
|
calendar - TrackByCalendar
|
Example
{
"time": TrackByTime,
"production": TrackByProduction,
"calendar": TrackByCalendar
}
TrackByOptionsInput
Fields
| Input Field | Description |
|---|---|
time - TrackByTimeInput
|
|
production - TrackByProductionInput
|
|
calendar - TrackByCalendarInput
|
Example
{
"time": TrackByTimeInput,
"production": TrackByProductionInput,
"calendar": TrackByCalendarInput
}
TrackByProduction
Description
Describes how a production-based maintenance plan produces recurring work orders
Fields
| Field Name | Description |
|---|---|
produced - Int!
|
The production count after which a new work order is due |
gracePeriodProduced - Int!
|
The production count after which a due work order becomes overdue |
peripheralId - PeripheralId!
|
ID of peripheral data |
peripheral - Peripheral
|
Example
{
"produced": 123,
"gracePeriodProduced": 987,
"peripheralId": PeripheralId,
"peripheral": Peripheral
}
TrackByProductionInput
Fields
| Input Field | Description |
|---|---|
produced - Int!
|
|
gracePeriodProduced - Int!
|
|
peripheralId - PeripheralId!
|
Example
{
"produced": 987,
"gracePeriodProduced": 123,
"peripheralId": PeripheralId
}
TrackByTime
Description
Describes how a time-based maintenance plan produces recurring work orders After a plan is started or a work order is completed, a new work order will be due after an interval determined by this object
Fields
| Field Name | Description |
|---|---|
days - Int!
|
Combined with "hours" to represent the interval with which work orders are created |
hours - Int!
|
Combined with "days" to represent the interval with which work orders are created |
gracePeriodDays - Int!
|
Combined with "gracePeriodHours" to represent the time from a work order is due until it is overdue |
gracePeriodHours - Int!
|
Combined with "gracePeriodDays" to represent the time from a work order is due until it is overdue |
skipWeekdays - [Weekday!]
|
Used if certain weekdays should be skipped when counting down towards the due date The grace period is not affected by "skipWeekdays" |
Example
{
"days": 123,
"hours": 987,
"gracePeriodDays": 123,
"gracePeriodHours": 123,
"skipWeekdays": ["MONDAY"]
}
TrackByTimeInput
Fields
| Input Field | Description |
|---|---|
days - Int!
|
|
hours - Int!
|
|
gracePeriodDays - Int!
|
|
gracePeriodHours - Int!
|
|
skipWeekdays - [Weekday!]
|
Example
{
"days": 123,
"hours": 123,
"gracePeriodDays": 123,
"gracePeriodHours": 123,
"skipWeekdays": ["MONDAY"]
}
TrialStatus
Trigger
Fields
| Field Name | Description |
|---|---|
id - TriggerId!
|
|
type - ActivityTriggerType!
|
|
conditions - TriggerConditions!
|
Example
{
"id": TriggerId,
"type": ActivityTriggerType,
"conditions": TriggerConditions
}
TriggerConditions
Fields
| Field Name | Description |
|---|---|
locationIds - [NodeId!]!
|
|
productIds - [String!]!
|
|
packagingIds - [String!]!
|
|
stopCauseIds - [String!]!
|
|
stopCauseCategoryIds - [String!]!
|
|
stopTypes - [String!]!
|
|
duringBatch - Boolean!
|
|
duringShift - Boolean!
|
Example
{
"locationIds": [NodeId],
"productIds": ["xyz789"],
"packagingIds": ["abc123"],
"stopCauseIds": ["abc123"],
"stopCauseCategoryIds": ["xyz789"],
"stopTypes": ["abc123"],
"duringBatch": false,
"duringShift": true
}
TriggerConditionsFilter
Example
{
"locationIds": [NodeId],
"productIds": ["abc123"],
"packagingIds": ["xyz789"],
"stopCauseIds": ["abc123"],
"stopCauseCategoryIds": ["abc123"],
"stopTypes": ["xyz789"]
}
TriggerConditionsInput
Example
{
"locationIds": [NodeId],
"productIds": ["xyz789"],
"packagingIds": ["abc123"],
"stopCauseIds": ["abc123"],
"stopCauseCategoryIds": ["abc123"],
"stopTypes": ["abc123"],
"duringBatch": false,
"duringShift": true
}
TriggerFilter
Fields
| Input Field | Description |
|---|---|
types - [TriggerTypeFilter!]
|
|
duringBatch - Boolean
|
|
duringShift - Boolean
|
Example
{"types": ["MANUAL"], "duringBatch": false, "duringShift": true}
TriggerId
Example
TriggerId
TriggerInput
Fields
| Input Field | Description |
|---|---|
type - ActivityTriggerTypeInput!
|
|
conditions - TriggerConditionsInput!
|
Example
{
"type": ActivityTriggerTypeInput,
"conditions": TriggerConditionsInput
}
TriggerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CRON"
TriggerTypeFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MANUAL"
UUID
Description
A UUID is a unique 128-bit number, stored as 16 octets. UUIDs are parsed as Strings within GraphQL. UUIDs are used to assign unique identifiers to entities without requiring a central allocating authority.
References
Example
"f6fd055e-d8b6-4525-a6a3-5d486788424e"
Unit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TEMPERATURE"
UpdateActionPlanInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
category - String!
|
|
title - String
|
|
content - [ActionPlanContentInput!]!
|
|
pdcaState - ActionPlanPDCAState
|
|
state - ActionPlanState!
|
|
followUpState - Int!
|
|
followUpInterval - ActionPlanFollowUpInterval!
|
|
linkedProductionData - [String!]!
|
|
attachedFiles - [String!]!
|
|
dueDate - DateTime
|
|
version - Int!
|
Example
{
"id": "xyz789",
"category": "xyz789",
"title": "abc123",
"content": [ActionPlanContentInput],
"pdcaState": "PLAN",
"state": "OPEN",
"followUpState": 123,
"followUpInterval": "DAILY",
"linkedProductionData": ["abc123"],
"attachedFiles": ["abc123"],
"dueDate": "2007-12-03T10:15:30Z",
"version": 123
}
UpdateActionPlanTaskInput
UpdateActivityInput
Fields
| Input Field | Description |
|---|---|
status - ActivityStatus!
|
|
values - [CustomFieldValueInput!]
|
|
initials - String
|
Example
{
"status": "PENDING",
"values": [CustomFieldValueInput],
"initials": "abc123"
}
UpdateBatchByBatchNumberInput
Description
Update a batch by batch number inputs.
Example
{
"lineId": "4",
"batchNumber": "xyz789",
"productId": "4",
"plannedStart": "2007-12-03",
"actualStart": "2007-12-03",
"actualStop": "2007-12-03",
"amount": 987.65,
"manualScrap": 123.45,
"comment": "abc123",
"dataMultiplier": 123.45,
"validatedLineSpeed": 123.45,
"expectedAverageSpeed": 123.45,
"forceStop": false
}
UpdateConfigInput
Fields
| Input Field | Description |
|---|---|
sensor - SensorConfigInput
|
|
camera - CameraConfigInput
|
Example
{
"sensor": SensorConfigInput,
"camera": CameraConfigInput
}
UpdateEscalation
UpdateGoldenBatchSettingsInput
Fields
| Input Field | Description |
|---|---|
timePeriodMonths - Int!
|
Example
{"timePeriodMonths": 987}
UpdateLearningActivityInput
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"nodeId": "abc123",
"title": "abc123",
"description": "abc123",
"content": "xyz789",
"startEndDatesRequired": false,
"validityInMonths": 987
}
UpdateLearningRoleInput
UpdateMaintenanceLogEntryInput
Fields
| Input Field | Description |
|---|---|
initials - String
|
|
comment - String
|
|
customData - CustomFormDataInput
|
|
stopCauseIds - [String!]
|
|
stopCausePeripheralId - PeripheralId
|
|
assetIds - [NodeId!]
|
|
startOfService - DateTime
|
|
endOfService - DateTime
|
Example
{
"initials": "abc123",
"comment": "xyz789",
"customData": CustomFormDataInput,
"stopCauseIds": ["xyz789"],
"stopCausePeripheralId": PeripheralId,
"assetIds": [NodeId],
"startOfService": "2007-12-03T10:15:30Z",
"endOfService": "2007-12-03T10:15:30Z"
}
UpdateMaintenancePlanInput
Fields
| Input Field | Description |
|---|---|
asset - String
|
|
title - String
|
|
tagPartNumber - String
|
|
instructions - String
|
|
startFrom - DateTime
|
|
trackBy - TrackByOptionsInput
|
|
roleId - MaintenanceRoleId
|
Example
{
"asset": "xyz789",
"title": "abc123",
"tagPartNumber": "xyz789",
"instructions": "xyz789",
"startFrom": "2007-12-03T10:15:30Z",
"trackBy": TrackByOptionsInput,
"roleId": MaintenanceRoleId
}
UpdateSkillInput
UpdateUserLearningActivityInput
Example
{
"userId": 4,
"learningActivityId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"learningActivityVersion": 123,
"newStatus": "ENROLLED",
"startedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z"
}
UpdateWebhookInput
Fields
| Input Field | Description |
|---|---|
id - UUID!
|
The unique ID of the webhook to update. |
url - String!
|
The new URL to which the webhook will send requests. |
description - String!
|
An optional new description for the webhook. |
headers - JSON!
|
The new headers that will be sent with the webhook request. |
triggerType - String!
|
The new type of trigger for the webhook. Can be "batch_start" or "batch_end". |
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"url": "xyz789",
"description": "abc123",
"headers": {},
"triggerType": "abc123"
}
UpsertActionPlansTaskInput
Urgency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MEDIUM"
User
Fields
| Field Name | Description |
|---|---|
company - Company!
|
|
username - String!
|
|
enabled - Boolean!
|
|
userStatus - String!
|
|
userCreateDate - Date!
|
|
userLastModifiedDate - Date!
|
|
sub - String!
|
|
email - String
|
|
givenName - String
|
|
familyName - String
|
|
emailVerified - String
|
|
groups - [Group!]!
|
|
devices - [Device]!
|
|
lines - [Line]!
|
|
linesPaginated - LinesPaginated!
|
|
skills - UserSkillConnection!
|
|
Arguments |
|
learningRoles - UserLearningRoleConnection!
|
|
Arguments |
|
learningActivities - UserLearningActivityConnection!
|
|
Arguments |
|
sessions - [Session!]!
|
|
Example
{
"company": Company,
"username": "xyz789",
"enabled": true,
"userStatus": "xyz789",
"userCreateDate": "2007-12-03",
"userLastModifiedDate": "2007-12-03",
"sub": "xyz789",
"email": "abc123",
"givenName": "abc123",
"familyName": "xyz789",
"emailVerified": "xyz789",
"groups": [Group],
"devices": [Device],
"lines": [Line],
"linesPaginated": LinesPaginated,
"skills": UserSkillConnection,
"learningRoles": UserLearningRoleConnection,
"learningActivities": UserLearningActivityConnection,
"sessions": [Session]
}
UserAttributes
Fields
| Input Field | Description |
|---|---|
address - String
|
|
birthdate - String
|
|
email - String
|
|
familyName - String
|
|
gender - String
|
|
givenName - String
|
|
locale - String
|
|
middleName - String
|
|
name - String
|
|
nickname - String
|
|
phoneNumber - String
|
|
picture - String
|
|
preferredUsername - String
|
|
profile - String
|
|
timezone - String
|
|
updatedAt - String
|
|
website - String
|
Example
{
"address": "xyz789",
"birthdate": "xyz789",
"email": "xyz789",
"familyName": "abc123",
"gender": "abc123",
"givenName": "abc123",
"locale": "xyz789",
"middleName": "xyz789",
"name": "xyz789",
"nickname": "xyz789",
"phoneNumber": "xyz789",
"picture": "abc123",
"preferredUsername": "xyz789",
"profile": "abc123",
"timezone": "xyz789",
"updatedAt": "abc123",
"website": "abc123"
}
UserFilter
UserLearningActivity
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
learningActivityId - UUID!
|
|
version - Int!
|
|
nodeId - String!
|
|
title - String!
|
|
status - UserLearningActivityStatus!
|
|
description - String
|
|
content - String
|
|
startEndDatesRequired - Boolean!
|
|
validityInMonths - Int
|
|
enrolledAt - DateTime
|
|
startedAt - DateTime
|
|
completedAt - DateTime
|
|
exemptedAt - DateTime
|
|
expiresAt - DateTime
|
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"learningActivityId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"version": 987,
"nodeId": "abc123",
"title": "abc123",
"status": "ENROLLED",
"description": "abc123",
"content": "abc123",
"startEndDatesRequired": false,
"validityInMonths": 987,
"enrolledAt": "2007-12-03T10:15:30Z",
"startedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"exemptedAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z"
}
UserLearningActivityConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [UserLearningActivityEdge!]!
|
A list of edges. |
nodes - [UserLearningActivity!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [UserLearningActivityEdge],
"nodes": [UserLearningActivity]
}
UserLearningActivityEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - UserLearningActivity!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": UserLearningActivity,
"cursor": "xyz789"
}
UserLearningActivityFilter
Fields
| Input Field | Description |
|---|---|
nodeIds - [ID!]
|
|
skillIds - [UUID!]
|
|
status - [UserLearningActivityStatus!]
|
Example
{
"nodeIds": [4],
"skillIds": [
"f6fd055e-d8b6-4525-a6a3-5d486788424e"
],
"status": ["ENROLLED"]
}
UserLearningActivityStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENROLLED"
UserLearningActivityStatusInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENROLLED"
UserLearningRole
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
learningRoleId - UUID!
|
|
userId - ID!
|
|
title - String!
|
|
status - LearningRoleStatus!
|
|
description - String
|
|
nodeId - ID!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
createdBySub - String!
|
|
updatedBySub - String!
|
|
expiresAt - DateTime
|
|
completedAt - DateTime
|
|
enrolledBySub - String!
|
|
skills - UserLearningRoleSkillsConnection!
|
Internal use only |
Arguments |
|
node - HierarchyNode
|
|
user - User
|
|
createdBy - User
|
|
updatedBy - User
|
|
enrolledBy - User
|
|
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"learningRoleId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"userId": 4,
"title": "abc123",
"status": "ENROLLED",
"description": "abc123",
"nodeId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "xyz789",
"expiresAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"enrolledBySub": "abc123",
"skills": UserLearningRoleSkillsConnection,
"node": HierarchyNode,
"user": User,
"createdBy": User,
"updatedBy": User,
"enrolledBy": User
}
UserLearningRoleConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [UserLearningRoleEdge!]!
|
A list of edges. |
nodes - [UserLearningRole!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [UserLearningRoleEdge],
"nodes": [UserLearningRole]
}
UserLearningRoleEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - UserLearningRole!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": UserLearningRole,
"cursor": "xyz789"
}
UserLearningRoleFilter
UserLearningRoleSkill
Fields
| Field Name | Description |
|---|---|
skillId - UUID!
|
|
userId - ID!
|
|
title - String!
|
|
status - SkillStatus!
|
|
description - String
|
|
nodeId - ID!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
createdBySub - String!
|
|
updatedBySub - String!
|
|
expiresAt - DateTime
|
|
completedAt - DateTime
|
|
orderIndex - Int!
|
|
learningActivities - UserLearningRoleSkillLearningActivitiesConnection!
|
Internal use only |
Arguments |
|
Example
{
"skillId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"userId": 4,
"title": "abc123",
"status": "ENROLLED",
"description": "xyz789",
"nodeId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "abc123",
"expiresAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"orderIndex": 987,
"learningActivities": UserLearningRoleSkillLearningActivitiesConnection
}
UserLearningRoleSkillLearningActivitiesConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [UserLearningRoleSkillLearningActivitiesEdge!]!
|
A list of edges. |
nodes - [UserSkillLearningActivity!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [UserLearningRoleSkillLearningActivitiesEdge],
"nodes": [UserSkillLearningActivity]
}
UserLearningRoleSkillLearningActivitiesEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - UserSkillLearningActivity!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": UserSkillLearningActivity,
"cursor": "xyz789"
}
UserLearningRoleSkillsConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [UserLearningRoleSkillsEdge!]!
|
A list of edges. |
nodes - [UserLearningRoleSkill!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [UserLearningRoleSkillsEdge],
"nodes": [UserLearningRoleSkill]
}
UserLearningRoleSkillsEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - UserLearningRoleSkill!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": UserLearningRoleSkill,
"cursor": "abc123"
}
UserList
UserSkill
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
skillId - UUID!
|
|
userId - ID!
|
|
title - String!
|
|
status - SkillStatus!
|
|
description - String
|
|
nodeId - ID!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
createdBySub - String!
|
|
updatedBySub - String!
|
|
expiresAt - DateTime
|
|
completedAt - DateTime
|
|
enrolledBySub - String!
|
|
learningActivities - UserSkillLearningActivitiesConnection!
|
Internal use only |
Arguments |
|
node - HierarchyNode
|
|
createdBy - User
|
|
updatedBy - User
|
|
enrolledBy - User
|
|
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"skillId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"userId": "4",
"title": "abc123",
"status": "ENROLLED",
"description": "abc123",
"nodeId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBySub": "xyz789",
"updatedBySub": "abc123",
"expiresAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"enrolledBySub": "abc123",
"learningActivities": UserSkillLearningActivitiesConnection,
"node": HierarchyNode,
"createdBy": User,
"updatedBy": User,
"enrolledBy": User
}
UserSkillConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [UserSkillEdge!]!
|
A list of edges. |
nodes - [UserSkill!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [UserSkillEdge],
"nodes": [UserSkill]
}
UserSkillEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - UserSkill!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": UserSkill,
"cursor": "abc123"
}
UserSkillFilter
UserSkillLearningActivitiesConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [UserSkillLearningActivitiesEdge!]!
|
A list of edges. |
nodes - [UserSkillLearningActivity!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [UserSkillLearningActivitiesEdge],
"nodes": [UserSkillLearningActivity]
}
UserSkillLearningActivitiesEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - UserSkillLearningActivity!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": UserSkillLearningActivity,
"cursor": "abc123"
}
UserSkillLearningActivity
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
learningActivityId - UUID!
|
|
version - Int!
|
|
nodeId - String!
|
|
title - String!
|
|
status - UserLearningActivityStatus!
|
|
description - String
|
|
content - String
|
|
startEndDatesRequired - Boolean!
|
|
enrolledAt - DateTime
|
|
startedAt - DateTime
|
|
completedAt - DateTime
|
|
exemptedAt - DateTime
|
|
validityInMonths - Int
|
|
expiresAt - DateTime
|
|
orderIndex - Int!
|
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"learningActivityId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"version": 123,
"nodeId": "xyz789",
"title": "abc123",
"status": "ENROLLED",
"description": "xyz789",
"content": "abc123",
"startEndDatesRequired": true,
"enrolledAt": "2007-12-03T10:15:30Z",
"startedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"exemptedAt": "2007-12-03T10:15:30Z",
"validityInMonths": 987,
"expiresAt": "2007-12-03T10:15:30Z",
"orderIndex": 123
}
UserSub
VersionedActivityTemplateEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ActivityTemplate!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ActivityTemplate,
"cursor": "abc123"
}
VersionedActivityTemplatesConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [VersionedActivityTemplateEdge!]!
|
A list of edges. |
nodes - [ActivityTemplate!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [VersionedActivityTemplateEdge],
"nodes": [ActivityTemplate]
}
VersionedCustomFormEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - CustomForm!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": CustomForm,
"cursor": "xyz789"
}
VersionedCustomFormsConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [VersionedCustomFormEdge!]!
|
A list of edges. |
nodes - [CustomForm!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [VersionedCustomFormEdge],
"nodes": [CustomForm]
}
VerticalAnnotation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
label - String!
|
|
timestamp - Date!
|
|
timestampEnd - Date
|
|
tags - [String!]!
|
Example
{
"id": "4",
"label": "abc123",
"timestamp": "2007-12-03",
"timestampEnd": "2007-12-03",
"tags": ["xyz789"]
}
VerticalAnnotationInput
VerticalAnnotationsInput
Fields
| Input Field | Description |
|---|---|
sample - Boolean
|
Example
{"sample": true}
VisualizationType
Types
| Union Types |
|---|
Example
BarChart
WebPushSubscription
Fields
| Input Field | Description |
|---|---|
endpoint - String!
|
|
keys - WebPushSubscriptionKeys!
|
Example
{
"endpoint": "abc123",
"keys": WebPushSubscriptionKeys
}
WebPushSubscriptionKeys
Webhook
Description
Represents a webhook.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the webhook. |
url - String!
|
The URL of the webhook. |
description - String
|
An optional description of the webhook. |
headers - JSON!
|
The headers that will be sent with the webhook request, represented as a JSON object. |
triggerType - String!
|
The trigger that determines when the webhook is executed |
createdAt - DateTime!
|
The timestamp when the webhook was created. |
updatedAt - DateTime!
|
The timestamp when the webhook was last updated. |
deletedAt - DateTime
|
The timestamp when the webhook was deleted, if applicable. |
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"url": "abc123",
"description": "xyz789",
"headers": {},
"triggerType": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z"
}
WebhookConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [WebhookEdge!]!
|
A list of edges. |
nodes - [Webhook!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [WebhookEdge],
"nodes": [Webhook]
}
WebhookEdge
WebhookExecution
Description
Represents a webhook execution.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the webhook execution. |
webhookId - UUID!
|
The ID of the webhook associated with this execution. |
requestUrl - String!
|
The URL that was requested during the execution. |
requestHeaders - JSON
|
The headers sent with the request, represented as a JSON object. |
requestBody - String
|
The body of the request, if any. |
statusCode - Int
|
The HTTP status code returned by the execution, if available. |
responseHeaders - JSON
|
The headers returned in the response, represented as a JSON object. |
responseBody - String
|
The body of the response, if any. |
responseError - String
|
Any error message returned during the execution, if applicable. |
result - WebhookResult!
|
The result of the webhook execution. |
ipAddress - String
|
The IP address of the client that made the request. |
redirectChain - [HttpRedirect!]
|
The chain of redirects followed during the execution, if any. |
responseTimeMs - Int
|
The time taken for the response, in milliseconds. |
requestAt - DateTime
|
The timestamp when the request was made. |
responseAt - DateTime
|
The timestamp when the response was received. |
createdAt - DateTime!
|
The timestamp when the execution was created. |
attemptCount - Int
|
The number of attempts made for this execution. |
Example
{
"id": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"webhookId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"requestUrl": "abc123",
"requestHeaders": {},
"requestBody": "abc123",
"statusCode": 123,
"responseHeaders": {},
"responseBody": "abc123",
"responseError": "abc123",
"result": "SUCCESS",
"ipAddress": "abc123",
"redirectChain": [HttpRedirect],
"responseTimeMs": 987,
"requestAt": "2007-12-03T10:15:30Z",
"responseAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"attemptCount": 987
}
WebhookExecutionConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [WebhookExecutionEdge!]!
|
A list of edges. |
nodes - [WebhookExecution!]!
|
A list of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": [WebhookExecutionEdge],
"nodes": [WebhookExecution]
}
WebhookExecutionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - WebhookExecution!
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": WebhookExecution,
"cursor": "xyz789"
}
WebhookExecutionFilter
Description
Input type for filtering webhook executions.
Fields
| Input Field | Description |
|---|---|
webhookId - UUID
|
Filter by the ID of the webhook. |
requestAtBefore - DateTime
|
Filter executions requested before this timestamp. |
requestAtAfter - DateTime
|
Filter executions requested after this timestamp. |
result - String
|
Filter by the result of the execution. |
statusCode - Int
|
Filter by the HTTP status code of the execution. |
Example
{
"webhookId": "f6fd055e-d8b6-4525-a6a3-5d486788424e",
"requestAtBefore": "2007-12-03T10:15:30Z",
"requestAtAfter": "2007-12-03T10:15:30Z",
"result": "xyz789",
"statusCode": 123
}
WebhookFilter
Description
Input type for filtering webhooks.
Fields
| Input Field | Description |
|---|---|
triggerType - String
|
Filter by the trigger type of the webhook. |
Example
{"triggerType": "abc123"}
WebhookResult
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUCCESS"
Weekday
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MONDAY"
WiFiConfig
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
|
networks - [Network!]
|
Example
{"enabled": false, "networks": [Network]}
WiFiConfigShadow
Fields
| Field Name | Description |
|---|---|
desired - WiFiConfig
|
|
reported - WiFiConfig
|
Example
{
"desired": WiFiConfig,
"reported": WiFiConfig
}
WithdrawLearningRoleFromUserInput
WithdrawSkillFromUserInput
WorkOrder
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
WorkOrderKey
WorkOrderStatus
Values
| Enum Value | Description |
|---|---|
|
|
Example
"COMPLETED"
WorkOrderStatusFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PLANNED"
Worker
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
email - String
|
|
phoneNumber - String
|
|
userSub - String
|
This feature is experimental and might be replaced |
role - AndonRole!
|
Workers may now reference multiple roles. |
roles - [AndonRole!]!
|
|
preferredSchedules - [AndonSchedule!]!
|
Example
{
"id": 4,
"name": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"userSub": "abc123",
"role": AndonRole,
"roles": [AndonRole],
"preferredSchedules": [AndonSchedule]
}
WorkerCreateInput
Example
{
"name": "xyz789",
"email": "abc123",
"phoneNumber": "abc123",
"userSub": "abc123",
"roleId": 4,
"roleIds": [4],
"preferredSchedules": [4]
}
WorkerUpdateInput
Example
{
"name": "xyz789",
"email": "abc123",
"phoneNumber": "xyz789",
"userSub": "xyz789",
"roleId": "4",
"roleIds": ["4"],
"preferredSchedules": [4]
}
_Any
Description
The _Any scalar is used to pass representations of entities from external services into the root _entities field for execution.
Example
_Any
_Entity
Types
| Union Types |
|---|
Example
Line
_Service
Fields
| Field Name | Description |
|---|---|
sdl - String
|
Example
{"sdl": "abc123"}