Bastian Exacta Maestro™ GraphQL Documentation

Table of Contents

Query

      AciEmulatorQuery

      AciQuery

      AgentHubQuery

      AliasingQuery

      ArchiveQuery

      ArchiveReferenceClientQuery

      CoordinateConversionQuery

      DeadLetterQueryOfIAciEmulatorStatelessService

      DeadLetterQueryOfIAciStatelessService

      DeadLetterQueryOfIAgentHubWebService

      DeadLetterQueryOfISeegridEmulatorStatelessService

      DeadLetterQueryOfISeegridStatelessService

      DeadLetterQueryOfITaskAssignmentWebService

      DeadLetterQueryOfITdaProxyCommunicatorWebService

      DeadLetterQueryOfITdaProxyEmulatorWebService

      InventoryQuery

      LocationQuery

      LogHubQuery

      MapQuery

      Query

      SeegridEmulatorQuery

      SeegridQuery

      TaskAssignmentQuery

      TdaProxyCommunicatorQuery

      TdaProxyEmulatorQuery

Mutation

      AciEmulatorMutation

      AciMutation

      AgentHubMutation

      AliasingMutation

      ArchiveMutation

      ArchiveReferenceClientMutation

      CoordinateConversionMutation

      DeadLetterMutationOfIAciEmulatorStatelessService

      DeadLetterMutationOfIAciStatelessService

      DeadLetterMutationOfIAgentHubWebService

      DeadLetterMutationOfISeegridEmulatorStatelessService

      DeadLetterMutationOfISeegridStatelessService

      DeadLetterMutationOfITaskAssignmentWebService

      DeadLetterMutationOfITdaProxyCommunicatorWebService

      DeadLetterMutationOfITdaProxyEmulatorWebService

      InventoryMutation

      LogHubMutation

      MapMutation

      Mutation

      QueueProcessorMutationOfIAciEmulatorStatelessService

      QueueProcessorMutationOfIAciStatelessService

      QueueProcessorMutationOfIAgentHubWebService

      QueueProcessorMutationOfISeegridEmulatorStatelessService

      QueueProcessorMutationOfISeegridStatelessService

      QueueProcessorMutationOfITaskAssignmentWebService

      QueueProcessorMutationOfITdaProxyCommunicatorWebService

      QueueProcessorMutationOfITdaProxyEmulatorWebService

      SeegridEmulatorMutation

      SeegridMutation

      TaskAssignmentMutation

      TaskBidEnricherMutationOfIMapStatelessService

      TdaProxyCommunicatorMutation

      TdaProxyEmulatorMutation

Object

      __Directive

      __EnumValue

      __Field

      __InputValue

      __Schema

      __Type

      AciActiveTask

      AciCarrier

      ActiveMissionOverrideStatus

      ActiveRouteObject

      AddLocationFailure

      AddLocationsResponse

      Agent

      AgentEmulatorActor

      AgentIdAndType

      AgentPayloadPosition

      AgentPayloadPositionCriteria

      AgentSettings

      AgentType

      AgentTypeAndProfileType

      AgentTypeCapability

      AliasBatchObject

      AliasBatchObjectConnection

      AliasBatchObjectEdge

      AliasConfig

      AliasObject

      AliasObjectConnection

      AliasObjectEdge

      AliasRecord

      AliasRecordConnection

      AliasRecordEdge

      AliasType

      ArchivableService

      ArchiveRecord

      ArchiveSchedule

      ArchiveTrigger

      ArchiveTriggerMetric

      BastianServiceIdentifierType

      BlockList

      BlockListEntry

      BooleanResponse

      CollectionResult

      Container

      CoordinatePoseTransform

      createMissionResponseType

      Curve

      DeadLetter

      DeadLetterConnection

      DeadLetterEdge

      DeletedService

      Dictionary_Key_AgentTypeAndProfileType_Value_String

      Dictionary_Key_RichKey_Value_String

      Dictionary_Key_String_Value_Boolean

      Dictionary_Key_String_Value_Float

      Dictionary_Key_String_Value_String

      Dictionary_Key_String_Value_TaskBidCustomCost

      Dictionary_Key_String_Value_TaskBidEnrichmentData

      Dictionary_Key_TaskBidRejectionCodeEnum_Value_ListOf_AgentIdAndType

      EdgeResponse

      EmulatedActiveTask

      EmulatedAgent

      EmulatorConfig

      EnrichTaskBidsResponse

      GetLogSummariesResponse

      getMissionsStatusResponseType

      getMissionStatusResponseType

      GetTaskAssignmentsResponseType

      GetTaskBidsResponse

      GetTasksByNameResponseType

      getVehiclesStatusResponseType

      InventoryLocation

      InventoryLocationConnection

      InventoryLocationEdge

      KVP_Key_AgentTypeAndProfileType_Value_String

      KVP_Key_RichKey_Value_String

      KVP_Key_String_Value_Boolean

      KVP_Key_String_Value_Float

      KVP_Key_String_Value_String

      KVP_Key_String_Value_TaskBidCustomCost

      KVP_Key_String_Value_TaskBidEnrichmentData

      KVP_Key_TaskBidRejectionCodeEnum_Value_ListOf_AgentIdAndType

      LocationScheme

      LogChannel

      LogChannelConfigs

      LogEntry

      LogEntryConnection

      LogEntryEdge

      LogSummary

      MaestroMapConfiguration

      MapEdge

      MapVersionResponse

      mission

      MissionChildTask

      MissionTask

      MissionTaskCriteriaPayload

      MissionTaskInstructionPayload

      NamedResult

      NodeResponse

      NodeResponseConnection

      NodeResponseEdge

      PageInfo

      PalletPickTask

      PalletPickTaskCriteraPayload

      PalletPickTaskInstructionPayload

      PalletPlaceTask

      PalletPlaceTaskCriteraPayload

      PalletPlaceTaskInstructionPayload

      Payload

      PayloadPosition

      PayloadPositionType

      ProcessingError

      ProductPickTask

      ProductPickTaskCriteraPayload

      ProductPickTaskInstructionPayload

      ProviderCriteria

      QueueProcessor

      QueueProcessorFault

      QueueProcessorOfIAciEmulatorStatelessService

      QueueProcessorOfIAciStatelessService

      QueueProcessorOfIAgentHubWebService

      QueueProcessorOfISeegridEmulatorStatelessService

      QueueProcessorOfISeegridStatelessService

      QueueProcessorOfITaskAssignmentWebService

      QueueProcessorOfITdaProxyCommunicatorWebService

      QueueProcessorOfITdaProxyEmulatorWebService

      ReliableQueueProcessorConfig

      RemoveTaskGroupsResponse

      Reservation

      ReserveLocationResponse

      Result

      Result_ActiveRouteObject

      Result_ListOf_ActiveRouteObject

      Result_StartRouteResponse

      Result_UpdateRouteReservationResponse

      RichKey

      RouteSegment

      RouteSummary

      StartRouteResponse

      Switch

      TaskAssignmentConfig

      TaskAssignmentCostType

      TaskAssignmentRunLoopMetrics

      TaskBatchConfiguration

      TaskBatchCriteria

      TaskBid

      TaskBidCostComponentWeights

      TaskBidCostType

      TaskBidCustomCost

      TaskBidEnricherOfIMapStatelessService

      TaskBidEnricherType

      TaskBidEnrichmentData

      TaskBidMetrics

      TaskBidRejection

      TaskBidRequest

      TaskCommission

      TaskCommissionAcceptance

      TaskCommissionRejection

      TaskCostComponentBatchMetricsModelType

      TaskExecutionErrorType

      TaskGroup

      TaskGroupMetrics

      TaskInterfaceConnection

      TaskInterfaceEdge

      TaskNameAndGroup

      TaskPriorityComponentWeights

      TaskTransformConfig

      TaskTypeConfig

      TaskUpdateSubscriber

      TdaProxyAgent

      TdaProxyAgentExtended

      TdaProxyConfig

      TransferTask

      TransferTaskCriteriaPayload

      TransferTaskInstructionPayload

      UpdateLocationsFailure

      UpdateLocationsResponse

      UpdateRouteReservationResponse

      UpdateTaskBatchResponse

      Vector2

      Vector3

      Vector3Transform

      Vector4

      ZoneResponse

InputObject

      AddAliasBatchHeaderInput

      AddAliasBatchRecordInput

      AddLocationRequestType

      AddLocationSchemeRequest

      AddLocationsRequestInput

      AgentIdAndTypeInput

      agentInput

      AgentPayloadPositionCriteriaInput

      agentSettingsInput

      AgentTypeAndProfileInputType

      agentTypeCapabilityInput

      agentTypeInput

      AliasConfigInput

      AliasObjectInput

      ArchivableServiceInputType

      ArchiveRecordInputType

      ArchiveTriggerInputType

      ArchiveTriggerMetricInputType

      AssignedTaskIdInputType

      BeginCancelTaskInput

      BeginCompleteTaskInput

      BeginDispatchTasksInput

      BeginFaultTaskInput

      BeginReAssignTaskInput

      BeginUnassignTasksInput

      BlockListEntryInput

      ClearNodeReservationCommand

      ContainerInput

      CoordinatePoseTransformInputType

      DeleteLocationRequest

      DeleteLocationSchemeRequest

      DictionaryInput_Key_AgentTypeAndProfileInputType_Value_String

      DictionaryInput_Key_RichKeyInput_Value_String

      DictionaryInput_Key_String_Value_Float

      DictionaryInput_Key_String_Value_ListOf_TaskModelInputType

      DictionaryInput_Key_String_Value_String

      DictionaryInput_Key_String_Value_TaskBidCustomCostInputType

      DictionaryInput_Key_String_Value_TaskBidEnrichmentDataInputType

      EmulatorConfigInputType

      EndTaskInput

      EnrichTaskBidsCommandInputType

      GetActiveRouteInput

      GetAgentsInput

      GetAliasesByRegexRequestInput

      GetGraphNodePagedRequest

      GetLocationByContainerIdRequestInput

      GetLocationByLocationNameRequestInput

      GetLocationsByRegexRequestInput

      GetLocationSchemesRequestInput

      GetLocationsPagedQueryInput

      GetLocationsRequestInput

      GetLogsQueryInput

      GetLogSummariesQueryInput

      GetMapVersions

      GetRouteExecution

      GetRouteQuery

      GetTaskBidsQueryInputType

      GetTasksInput

      GetZoneQuery

      InventoryLocationInput

      KVPInput_Key_AgentTypeAndProfileInputType_Value_String

      KVPInput_Key_RichKeyInput_Value_String

      KVPInput_Key_String_Value_Float

      KVPInput_Key_String_Value_ListOf_TaskModelInputType

      KVPInput_Key_String_Value_String

      KVPInput_Key_String_Value_TaskBidCustomCostInputType

      KVPInput_Key_String_Value_TaskBidEnrichmentDataInputType

      LocationQueryInput

      LogChannelInput

      LogEntryInput

      LogMultipleRequestInput

      MaestroMapConfigurationInput

      MissionTaskInput

      MissionTaskInputType

      PalletPickTaskInput

      PalletPlaceTaskInput

      PayloadInput

      PayloadPositionInput

      PayloadPositionTypeInput

      ProductPickTaskInput

      ProviderCriteriaInput

      RecordFilterInputType

      registrationInput

      ReliableQueueProcessorConfigInput

      ReserveLocationRequest

      RichKeyInput

      startRouteInput

      stopRouteInput

      StoreContainerRequest

      switchInput

      TaskBatchConfigurationInput

      TaskBatchCriteriaInput

      TaskBidCostComponentWeightsInput

      TaskBidCustomCostInputType

      TaskBidEnricherInputType

      TaskBidEnrichmentDataInputType

      TaskBidInputType

      TaskBidRequestInputType

      TaskExecutionErrorInputType

      TaskGroupInput

      TaskGroupQueryInput

      TaskModelInputType

      TaskNameAndGroupInputType

      TaskPriorityComponentWeightsInput

      TaskSortCriterionInputType

      TaskTransformConfigInput

      TaskTypeConfigInput

      TdaProxyConfigInput

      TransferContainerRequest

      TransferTaskInput

      TransferTaskUpdateInput

      UnreserveLocationRequest

      updatedProperty

      UpdateLocationsRequestInput

      updateRouteInput

      updateRouteReservationInput

      UpdateTaskBatchCommandInput

      UpdateTaskBatchItemCommandInput

      Vector3Input

      Vector3TransformInput

      Vector4Input

Scalar

      Boolean

      ByteGraphType

      Date

      DateTime

      DateTimeOffset

      Decimal

      Float

      GuidGraphType

      ID

      Int

      Milliseconds

      Seconds

      Short

      String

      UIntGraphType

      Uri

      UShort

Interface

      TaskModel

Enum

      __DirectiveLocation

      __TypeKind

      ActiveTaskOverrideState

      AliasableProperty

      AxisSwapEnum

      AxisSwapEnumType

      DayOfWeek

      EventSeverityEnum

      FaultSetting

      FinalTaskExecutionStatus

      ForkDirections

      HostActionCode

      KollmorgenCarrierErrorCode

      OrderStatus

      RaymondCarrierErrorCode

      RecommendedAisleExit

      RepairType

      ReturnCode

      TaskAction

      TaskAssignmentStatus

      TaskBidRejectionCodeEnum

      TaskCommissionRejectionCode

      TaskExecutionStatus

      TaskGroupStatus

      TaskResult

      TaskSortDirectionEnum

      TaskSortEnum

      TransferOrderPhase

      TransportStructure

      VehicleStatuses

Query

AciEmulatorQuery

Object

Exposes queries that can be made against the service

Methods:

1. deadLetterQuery
  • Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type
2. getAgentsData

  • Get the details of the specified agents. If no agents are specified, the details for all agents will be returned

  • Arguments:

Name Description Type
agentIds The ids of the agents whose details to get. If no agents are specified, the details for all agents will be returned
  • List
  • Type:
3. getEmulatedTasks

  • Get the details of the specified tasks. If no agent ids or order indexes are specified, the details for all tasks will be returned

  • Arguments:

Name Description Type
agentIds The ids of the agents whose active tasks to get. If no agent ids or order indexes are specified, all tasks will be returned
  • List
  • Type:
orderIndexes The id of the tasks to get. If no agent ids or order indexes are specified, all tasks will be returned
  • List
  • Type:
4. getEmulatorConfig
  • Get the current configuration for the emulator
5. getTaskExecutionErrors
  • Get the task execution errors currently set. When an emulated agent has a task execution error, the emulator pauses that agent's task execution and reports the associated error codes
6. queueProcessorQuery
  • Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Return to top

AciQuery

Object

Exposes queries that can be made against the service

Methods:

1. deadLetterQuery
  • Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type
2. getActiveTask

  • Get the active task for the specified agents. If no agents are specified, the active task for all agents will be returned

  • Arguments:

Name Description Type
agentIds The ids of the agents whose active tasks to get. If no agents are specified, the active tasks for all agents will be returned
  • List
  • Type:
3. getAgentsData

  • Get the details of the specified agents. If no agents are specified, the details for all agents will be returned

  • Arguments:

Name Description Type
agentIds The ids of the agents whose details to get. If no agents are specified, the details for all agents will be returned
  • List
  • Type:
4. queueProcessorQuery
  • Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Return to top

AgentHubQuery

Object

Exposes queries that can be made against the service

Methods:

1. deadLetterQuery
  • Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type
2. getAgents

  • Get the details of the agents stored in the AgentHub service using a variety of filters

  • Arguments:

Name Description Type
getAgentInput Input type describing how to filter the result set
3. getAgentTypeByAgentId

  • Get the details of the AgentType for the specified agent in the AgentHub service

  • Arguments:

Name Description Type
agentId The id of the agent whose AgentType to get
4. getAgentTypes

  • Get the details of the AgentTypes stored in the AgentHub service

  • Arguments:

Name Description Type
agentTypeIds The AgentTypes to get the details of. Gets all if null or empty
5. getCoordinatePoseTransform

  • Get the coordinate pose transform configuration for the specified agent type

  • Arguments:

Name Description Type
agentTypeId The id of the AgentType whose transform to get
6. getTaskBids

  • Endpoint used for integration testing the AgentHub service's ability to collect task bids and bid rejections

  • Arguments:

Name Description Type
input The request containing the tasks to collect bids & bid rejections for
7. queueProcessorQuery
  • Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Return to top

AliasingQuery

Object

Root query exposing types from the Aliasing web service

Methods:

1. getAlias

  • Get the Alias in the Aliasing Service with the given key.

  • Arguments:

Name Description Type
sourceAliasType The type of value that is aliased.
aliasValue The value that is aliased.
2. getAliasBatch

  • Get the Aliases in the Aliasing Service that match the type and keys given.

  • Arguments:

Name Description Type
sourceAliasType The origin type of alias given.
destinationAliasType [Nullable] The requested type of alias received. If null, all aliases will be returned.
aliasValues The keys to retrieve aliases for.
3. getAliasesByRegex

  • Get alias(es) from the Aliasing service that contains the regex provided

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
request The request object that retrieves the alias(es) that contain the given regex
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. getAliasesFlat

  • Get aliases that match the criteria of the parameters.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
aliasTypes Optional. Get or set a set of alias types to include in results. A null or empty array applies no filter.
aliasValueRegex Optional. Get or set a regular expression identifying one or more alias values to include in results. A null or whitespace value applies no filter.
sourceTypes Optional. Get or set a set of source value types to include in results. A null or empty array applies no filter.
sourceValueRegex Optional. A regular expression identifying one or more source values to include in results. A null or whitespace value applies no filter.
5. getAliasTypes
  • Get all the alias types in the Aliasing Service, or those that match the optional Regular Expression.
6. getAllAliases

  • Get all Aliases in the Aliasing Service.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.

Return to top

ArchiveQuery

Object

Exposes queries that can be made against the services

Methods:

1. getArchivableServices

  • Get the details of the services registered with the archive for scheduled collection of records

  • Arguments:

Name Description Type
scheduleIds The ids of the schedules to get. If serviceIds is null, gets the data for all of the services with the specified scheduleIds. If serviceIds and scheduleIds are both null, gets all of the registered services
serviceIds The ids of the services to get. If scheduleIds is null, gets the data for all of the specified serviceIds regardless of schedule. If serviceIds and scheduleIds are both null, gets all of the registered services
2. getRecords

  • Get the records from the archive that pass the specified filter

  • Arguments:

Name Description Type
recordFilter The filter used to determine which records to get
3. getSchedules

  • Get the details of the archive schedules in the system

  • Arguments:

Name Description Type
scheduleIds The ids of the schedules to get. If null or empty, gets all schedules

Return to top

ArchiveReferenceClientQuery

Object

Exposes queries that can be made against the services

Methods:

1. getAllTasks
  • Get the details of every task in the service
2. getLatestArchiveRecords
  • Get all of the ArchiveRecords that were sent to the archive in the last batch

Return to top

CoordinateConversionQuery

Object

Root query exposing types from the CoordinateConversion web service

Methods:

1. getConversion

  • Retrieves a conversion from the Reliable Collection

  • Arguments:

Name Description Type
agentType
facilityId

Return to top

DeadLetterQueryOfIAciEmulatorStatelessService

Object

Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type

Methods:

1. countDeadLetters
  • NonNull
  • Type:

  • Counts the number of dead letters currently in the dead letter dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. deadLetter

  • Retrieves a dead letter from the dead letter collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. deadLetters

  • Gets a page of letters from the dead letter dictionary for the specified letter sender. The cursors in the type can be sent in subsequent requests to retrieve next / previous pages of letters.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. deadLetterSenderNames
  • NonNull
  • Type:
    • List
    • Type:

  • Gets the names of all sources which have sent a dead letter.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterQueryOfIAciStatelessService

Object

Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type

Methods:

1. countDeadLetters
  • NonNull
  • Type:

  • Counts the number of dead letters currently in the dead letter dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. deadLetter

  • Retrieves a dead letter from the dead letter collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. deadLetters

  • Gets a page of letters from the dead letter dictionary for the specified letter sender. The cursors in the type can be sent in subsequent requests to retrieve next / previous pages of letters.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. deadLetterSenderNames
  • NonNull
  • Type:
    • List
    • Type:

  • Gets the names of all sources which have sent a dead letter.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterQueryOfIAgentHubWebService

Object

Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type

Methods:

1. countDeadLetters
  • NonNull
  • Type:

  • Counts the number of dead letters currently in the dead letter dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. deadLetter

  • Retrieves a dead letter from the dead letter collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. deadLetters

  • Gets a page of letters from the dead letter dictionary for the specified letter sender. The cursors in the type can be sent in subsequent requests to retrieve next / previous pages of letters.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. deadLetterSenderNames
  • NonNull
  • Type:
    • List
    • Type:

  • Gets the names of all sources which have sent a dead letter.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterQueryOfISeegridEmulatorStatelessService

Object

Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type

Methods:

1. countDeadLetters
  • NonNull
  • Type:

  • Counts the number of dead letters currently in the dead letter dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. deadLetter

  • Retrieves a dead letter from the dead letter collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. deadLetters

  • Gets a page of letters from the dead letter dictionary for the specified letter sender. The cursors in the type can be sent in subsequent requests to retrieve next / previous pages of letters.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. deadLetterSenderNames
  • NonNull
  • Type:
    • List
    • Type:

  • Gets the names of all sources which have sent a dead letter.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterQueryOfISeegridStatelessService

Object

Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type

Methods:

1. countDeadLetters
  • NonNull
  • Type:

  • Counts the number of dead letters currently in the dead letter dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. deadLetter

  • Retrieves a dead letter from the dead letter collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. deadLetters

  • Gets a page of letters from the dead letter dictionary for the specified letter sender. The cursors in the type can be sent in subsequent requests to retrieve next / previous pages of letters.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. deadLetterSenderNames
  • NonNull
  • Type:
    • List
    • Type:

  • Gets the names of all sources which have sent a dead letter.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterQueryOfITaskAssignmentWebService

Object

Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type

Methods:

1. countDeadLetters
  • NonNull
  • Type:

  • Counts the number of dead letters currently in the dead letter dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. deadLetter

  • Retrieves a dead letter from the dead letter collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. deadLetters

  • Gets a page of letters from the dead letter dictionary for the specified letter sender. The cursors in the type can be sent in subsequent requests to retrieve next / previous pages of letters.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. deadLetterSenderNames
  • NonNull
  • Type:
    • List
    • Type:

  • Gets the names of all sources which have sent a dead letter.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterQueryOfITdaProxyCommunicatorWebService

Object

Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type

Methods:

1. countDeadLetters
  • NonNull
  • Type:

  • Counts the number of dead letters currently in the dead letter dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. deadLetter

  • Retrieves a dead letter from the dead letter collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. deadLetters

  • Gets a page of letters from the dead letter dictionary for the specified letter sender. The cursors in the type can be sent in subsequent requests to retrieve next / previous pages of letters.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. deadLetterSenderNames
  • NonNull
  • Type:
    • List
    • Type:

  • Gets the names of all sources which have sent a dead letter.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterQueryOfITdaProxyEmulatorWebService

Object

Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type

Methods:

1. countDeadLetters
  • NonNull
  • Type:

  • Counts the number of dead letters currently in the dead letter dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. deadLetter

  • Retrieves a dead letter from the dead letter collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. deadLetters

  • Gets a page of letters from the dead letter dictionary for the specified letter sender. The cursors in the type can be sent in subsequent requests to retrieve next / previous pages of letters.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. deadLetterSenderNames
  • NonNull
  • Type:
    • List
    • Type:

  • Gets the names of all sources which have sent a dead letter.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

InventoryQuery

Object

Root query exposing types from the Inventory web service

Methods:

1. getLocationByLocationName

  • Get location from the Inventory service that matches the given locaiton name provided

  • Arguments:

Name Description Type
request
2. getLocations

  • Gets location(s) from the Inventory service that match the scheme with the name given

  • Arguments:

Name Description Type
request
3. getLocationsByContainerId

  • Gets location from the Inventory service that contains the container Id provided

  • Arguments:

Name Description Type
request
4. getLocationsByRegex

  • Gets location(s) from the Inventory service that contains the regex provided

  • Arguments:

Name Description Type
request
5. getLocationSchemes

  • Gets location(s) from the Inventory service that match the scheme with the name given

  • Arguments:

Name Description Type
request
6. getLocationsPaged

  • Gets location(s) from the Inventory service that match the given filters

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
request The request given to retrieve inventory locations
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.

Return to top

LocationQuery

Object

A query object which can be used to resolve a location using one of several criteria.

Methods:

1. containerId
  • The id of a container. Resolves the location at which the container is currently held.
2. excludedLocations
  • The collection of locations that should not be reserved. Only used when reserving with LocationPattern
3. locationId
  • The id of the location
4. locationPattern
  • A regular expression which identifies one or more locations by their id.
5. locationPatterns
  • Container of regular expressions to identify one or more locations by their id.

Return to top

LogHubQuery

Object

Root query exposing types from the LogHub web service

Methods:

1. getBlockList
  • Return a list of entries on the block list. Block list entries consist of event provider/event name pairs which prevent any log entry with a matching pair from entering the SQL database. Pairs enter the block list automatically based on configuration for the max number of events for a specific pair in a configured time window.
2. getLogChannelConfigs
  • Return a list of all log channels with their configurations.
3. getLogs

  • Return a page of log entries that match the given filters from the LogHub database.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
request The request given to retrieve log entries
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
4. getLogSummaries

  • Return a list of log summaries after applying event filters.

  • Arguments:

Name Description Type
request The filters to be applied.

Return to top

MapQuery

Object

Root query exposing types from the Map web service

Methods:

1. getActiveRoute

  • Get the active route an agent is executing

  • Arguments:

Name Description Type
request
2. getActiveRoutes

  • Get one or more currently active routes

  • Arguments:

Name Description Type
assignedTaskIds Optional. If specified, only returns the specified active routes
agentIds Optional. If specified, only returns the active routes for the specified agents
taskIds Optional. If specified, only returns the active routes for the specified tasks
3. getMaestroMapConfiguration
  • Get the current configuration for the map service
4. getMapVersions

  • Get map versions that maestro is currently storing.

  • Arguments:

Name Description Type
request
5. getNodeReservations

  • Get the current node reservations

  • Arguments:

Name Description Type
agentIds Optional. If specified, only returns the reservations for the specified agents
6. getNodes

  • Get Nodes from one or more graphs as filtered by the provided parameters

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
request The request given to retrieve Graph Nodes
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
7. getRoute

  • Get the optimal route between List endpoints in traversal order

  • Arguments:

Name Description Type
request
8. getRouteExecution

  • Get the active route an agent is executing. This has been deprecated in favor of GetActiveRoute

  • Arguments:

Name Description Type
request
9. getZones

  • Get a list of zones in the current map file, or a subset of zones if zone id's are provided

  • Arguments:

Name Description Type
request
10. taskBidEnricherQuery
  • Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Return to top

Query

Object

Contains field from the following sub-queries: AciQuery: Exposes queries that can be made against the service AciEmulatorQuery: Exposes queries that can be made against the service TdaProxyCommunicatorQuery: Exposes queries that can be made against the service TdaProxyEmulatorQuery: Exposes queries that can be made against the services SeegridQuery: Exposes queries that can be made against the service SeegridEmulatorQuery: Exposes queries that can be made against the service AgentHubQuery: Exposes queries that can be made against the service AliasingQuery: Root query exposing types from the Aliasing web service ArchiveQuery: Exposes queries that can be made against the services ArchiveReferenceClientQuery: Exposes queries that can be made against the services CoordinateConversionQuery: Root query exposing types from the CoordinateConversion web service InventoryQuery: Root query exposing types from the Inventory web service TaskAssignmentQuery: Defines the types which can be queried by the task assignment api LogHubQuery: Root query exposing types from the LogHub web service MapQuery: Root query exposing types from the Map web service

Methods:

1. aciEmulatorQuery
  • Exposes queries that can be made against the service
2. aciQuery
  • Exposes queries that can be made against the service
3. agentHubQuery
  • Exposes queries that can be made against the service
4. aliasingQuery
  • Root query exposing types from the Aliasing web service
5. archiveQuery
  • Exposes queries that can be made against the services
6. archiveReferenceClientQuery
  • Exposes queries that can be made against the services
7. coordinateConversionQuery
  • Root query exposing types from the CoordinateConversion web service
8. inventoryQuery
  • Root query exposing types from the Inventory web service
9. logHubQuery
  • Root query exposing types from the LogHub web service
10. mapQuery
  • Root query exposing types from the Map web service
11. seegridEmulatorQuery
  • Exposes queries that can be made against the service
12. seegridQuery
  • Exposes queries that can be made against the service
13. taskAssignmentQuery
  • Defines the types which can be queried by the task assignment api
14. tdaProxyCommunicatorQuery
  • Exposes queries that can be made against the service
15. tdaProxyEmulatorQuery
  • Exposes queries that can be made against the services

Return to top

SeegridEmulatorQuery

Object

Exposes queries that can be made against the service

Methods:

1. deadLetterQuery
  • Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type
2. getAgentSettings
  • Get the details of the Agent Settings stored in the Emulated Agent service
3. getAgentSettingsById

  • Get the details of an Agent Settings by agent id stored in the Emulated Agent service

  • Arguments:

Name Description Type
agentId The id of the agent who's agent settings to retrieve
4. getSwitchById

  • Get the details of a switch by switch name stored in the Emulated Agent service

  • Arguments:

Name Description Type
switchName The name of the switch to retrieve
5. getSwitches
  • Get the details of the switches stored in the Emulated Agent service
6. queueProcessorQuery
  • Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Return to top

SeegridQuery

Object

Exposes queries that can be made against the service

Methods:

1. deadLetterQuery
  • Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type
2. getActiveTask

  • Gets the active task for the specified agent

  • Arguments:

Name Description Type
agentId The id of the agent whose active task to query for
3. queueProcessorQuery
  • Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Return to top

TaskAssignmentQuery

Object

Defines the types which can be queried by the task assignment api

Methods:

1. deadLetterQuery
  • Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type
2. getAssignedTasks

  • Returns the tasks currently assigned to the specified agent

  • Arguments:

Name Description Type
agentId The id of the agent whose assigned tasks to get
3. getFeatureFlags
  • Gets the current configuration of feature flags
4. getTaskAssignmentConfig
  • Returns the current task assignment configuration
5. getTaskAssignmentRunLoopMetrics
  • Returns the metrics from the task assignment run loop.
6. getTaskAssignments

  • Returns the output of the task assignment algorithm for the given task bids. Please note that in order for this command to work properly, you must ensure that the task assignment configuration is correctly set up, and you must ensure that the dates, agent types, agent ids for the task in the bid exist (however, the task themselves do NOT actually need to be created and added to TaskAssignment).

  • Arguments:

Name Description Type
taskBids The list of task bids to use for the assignment algorithm
7. getTaskBidMetrics

  • Returns the bid metrics for the tasks currently eligible for assignment

  • Arguments:

Name Description Type
taskNameAndGroups An optional filter of used to specify which task's bid metrics to return
8. getTasks

  • Gets pages of tasks that match the specified input parameters. All parameters are optional and combinable.

  • Arguments:

Name Description Type
after Only look at connected edges with cursors greater than the value of after.
first Specifies the number of edges to return starting from after or the first entry if after is not specified.
before Only look at connected edges with cursors smaller than the value of before.
last Specifies the number of edges to return counting reversely from before, or the last entry if before is not specified.
getTasksInput Get or set the parameters to filter tasks.
9. getTaskUpdateSubscribers
  • Returns the list of subscribers to task updates
10. missionTasks
  • NonNull
  • Type:
  • Returns the child tasks associated with the specified mission task.

This operation returns a flat list of tasks intended for consumption by agent services. If any of the missions child tasks have children of their own, those children are substituted for their parent.

The operation respects predecessor/successor links between tasks. Successor tasks appear after their predecessors in the result set.

  • Arguments:
Name Description Type
missionName The name of the mission task to return child tasks for.
11. queueProcessorQuery
  • Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type
12. task

  • Returns the task with the specified id.

  • Arguments:

Name Description Type
taskName The name of the task
13. taskGroup

  • Returns the task group with the specified id.

  • Arguments:

Name Description Type
taskGroupName The name of the task group
14. taskGroups
  • NonNull
  • Type:

  • Returns task groups which meet the criteria provided in the argument

  • Arguments:

Name Description Type
queryTaskGroupInput The criteria describing how to filter the results
15. tasks

  • Returns a list of tasks with the specified ids. Optionally in a specific task group.

  • Arguments:

Name Description Type
tasksNames The name of the tasks
  • NonNull
  • Type:
    • List
    • Type:
taskGroupName The name of the task group
16. tasksByAgentId
  • NonNull
  • Type:

  • Returns the tasks with the specified agent id.

  • Arguments:

Name Description Type
agentId The ID of the agent performing the tasks
isNotCompleted Should the query return only non-completed tasks?

Return to top

TdaProxyCommunicatorQuery

Object

Exposes queries that can be made against the service

Methods:

1. deadLetterQuery
  • Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type
2. getActiveMissionOverride
  • Gets the Id and status of active mission override for all agents.
3. getActiveTask

  • Gets the active task for the specified agent

  • Arguments:

Name Description Type
agentId The id of the agent whose active task to query for
4. getAgentData

  • Gets the latest data for the specified agent

  • Arguments:

Name Description Type
agentId The id of the agent whose data to query for
5. getAgentsData
  • Gets the latest data for every agent in the service
6. getTdaProxyConfig
  • Gets the current configuration settings for the TdaProxy services.
7. queueProcessorQuery
  • Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type
8. sendGetMissionsStatusRequest
  • Send a GetMissionsStatusRequest to the TdaProxyServer
9. sendGetMissionStatusRequest

  • Send a GetMissionStatusRequest to the TdaProxyServer

  • Arguments:

Name Description Type
missionId The id of the mission whose details to get
  • NonNull
  • Type:
10. sendGetVehiclesStatusRequest
  • Send a GetVehiclesStatusRequest to the TdaProxyServer

Return to top

TdaProxyEmulatorQuery

Object

Exposes queries that can be made against the services

Methods:

1. deadLetterQuery
  • Defines operations for getting information about dead letter collections hosted in the service targeted by the parent graph type
2. getActiveTask

  • Gets the active task for the specified emulated agent

  • Arguments:

Name Description Type
agentId The id of the agent whose active task to query for
  • NonNull
  • Type:
3. getAgentData

  • Gets the latest data for the specified emulated agent

  • Arguments:

Name Description Type
agentId The id of the agent whose data to query for
  • NonNull
  • Type:
4. getAgentEmulatorActors
  • Gets the details of all of the agent emulator ActorServices in the system
5. queueProcessorQuery
  • Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Return to top

Mutation

AciEmulatorMutation

Object

Exposes changes that can be made to the services

Methods:

1. clearAllState
  • Clear all of the state from the emulator and restart the stateful service. Restarting causes the emulator to re-load the Agent & AgentType data from AgentHub as well as Restart the AciServer
2. clearTaskExecutionError

  • Clear any task execution errors for the specified agents. If no agents are specified, clears all task execution errors

  • Arguments:

Name Description Type
agentIds The ids of the agents whose errors to clear
3. deadLetterMutation
  • Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type
4. queueProcessorMutation
  • Defines operations on reliable queue processors hosted in the service targeted by the parent mutation
5. setAgentProperties

  • Manually set properties on the specified emulated agent. Returns the names of the properties that were successfully updated, or error messages indicating which ones failed

  • Arguments:

Name Description Type
agentId The id of the agents whose properties to update
updatedProperties The mapping of property names to property values
6. setEmulatorConfig

  • Configure how the emulator processes task execution

  • Arguments:

Name Description Type
emulatorConfig The possible emulator config settings to update
7. setTaskExecutionError

  • Set a task execution error for the specified agent. When an emulated agent has a task execution error, the emulator pauses that agent's task execution and reports the associated error codes

  • Arguments:

Name Description Type
input The task execution error to set

Return to top

AciMutation

Object

Exposes changes that can be made to the services

Methods:

1. clearActiveTask

  • Clear the active task for the specified agents. If no agents are specified, no active tasks are cleared. Returns the ids of the agents whose active tasks were successfully cleared, or error messages indicating which ones failed

  • Arguments:

Name Description Type
agentIds The ids of the agents whose active tasks to clear. If no agents are specified, no active tasks are cleared
  • NonNull
  • Type:
    • List
    • Type:
2. deadLetterMutation
  • Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type
3. queueProcessorMutation
  • Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Return to top

AgentHubMutation

Object

Exposes changes that can be made to the service

Methods:

1. addAgent

  • Registers a new agent with the service

  • Arguments:

Name Description Type
agentInput The properties of the agent to register
2. addAgentType

  • Registers a new AgentType with the service

  • Arguments:

Name Description Type
agentTypeInput The properties of the AgentType to register
customCapabilities The custom capabilities of the AgentType
coordinatePoseTransform The coordinate conversion configuration of the AgentType
payloadPositionTypes The payload position types that exist for this AgentType
3. addOrUpdateAgentTypeCapability

  • Add to or update the custom capabilites of an AgentType registered with the AgentHub Service

  • Arguments:

Name Description Type
agentTypeId The Id of the AgentType whose capability to add or update
agentTypeCapabilityInput The properties of the AgentTypeCapability to add to the specified AgentType
4. beginUpdateAgentProperties

  • Add new properties or update existing properties for the specified agent

  • Arguments:

Name Description Type
agentId The Id of the agent whose properties are being added to or updated
agentProperties The properties of the specified agent to be added or updated
5. clearAgentPayloadPositions

  • Clear any payloads from the specified agent's payload position(s)

  • Arguments:

Name Description Type
agentId The Id of the agent whose positions to clear
agentTypeId Optional. The Id of the type of the agent whose positions to clear
taskName Optional. The name of the task associated with this clear operation
taskGroupName Optional. The name of the group of the task associated with this clear operation
6. clearAllState
  • Clear all reliable state from the service
7. deadLetterMutation
  • Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type
8. deleteAgent

  • Delete the specified agent from the AgentHub service

  • Arguments:

Name Description Type
agentId The id of the agent to delete
agentTypeId The id of the AgentType of the agent to delete. Optional, but improves the efficiency of the mutation
9. deleteAgentProperties

  • Removes all properties specified from the specified Agent in the AgentHub service

  • Arguments:

Name Description Type
agentId The id of the agent whose properties shall be removed
agentPropertyKeys The keys of the agent properties to removes
10. deleteAgentType

  • Deletes the specified AgentType from the AgentHub service

  • Arguments:

Name Description Type
agentTypeId The id of the AgentType to delete
11. deleteAgentTypeCapability

  • Removes an AgentTypeCapability from an AgentType in the AgentHub service

  • Arguments:

Name Description Type
agentTypeCapabilityId The id of the capability to remove
agentTypeId The id of the AgentType to remove the capability from
12. queueProcessorMutation
  • Defines operations on reliable queue processors hosted in the service targeted by the parent mutation
13. setAgentPayloadPositions

  • Override the details of the agents payload positions. Note that positions can only be added or removed by updating the AgentType

  • Arguments:

Name Description Type
agentId The Id of the agent whose positions to update
agentTypeId The Id of the type of the agent whose positions to update
payloadPositions The updated details of the agent's payload positions
14. updateCoordinatePoseTransform

  • Update the coordinate pose transform configuration for the specified agent type

  • Arguments:

Name Description Type
agentTypeId The id of the AgentType whose transform to update
coordinatePoseTransform The updated coordinate conversion configuration of the AgentType

Return to top

AliasingMutation

Object

Exposes changes that can be made to Aliasing Service

Methods:

1. addAlias

  • Adds an Alias to the Aliasing Service.

  • Arguments:

Name Description Type
sourceAliasType The type of value to be aliased.
aliasValue The value to be aliased.
aliasAlternatives The other aliases that can be used to access the alias value.
2. addAliasBatch

  • Adds a batch of aliases to the Aliasing Service.

  • Arguments:

Name Description Type
aliasTypes The header to the batch which details the types in order that match the values.
aliasValues The other aliases that can be used to access the alias value.
3. addAliasType

  • Adds an alias type to the Aliasing Service.

  • Arguments:

Name Description Type
aliasType The type of alias to be added.
4. addAliasTypesBatch

  • Adds alias types to the Aliasing Service.

  • Arguments:

Name Description Type
aliasTypes The types of alias to be added.
  • NonNull
  • Type:
5. clearAllState
  • Removes all aliases from the Aliasing Service.
6. removeAlias

  • Removes an Alias to the Aliasing Service.

  • Arguments:

Name Description Type
sourceAliasType The type of value that is aliased.
aliasValue The value that is aliased.
7. removeAliasType

  • Removes an Alias Type from the Aliasing Service.

  • Arguments:

Name Description Type
aliasType The type of alias to be removed.

Return to top

ArchiveMutation

Object

Exposes changes that can be made to the services

Methods:

1. addArchivableService

  • Register the new archivable service for collection according to the specified schedule

  • Arguments:

Name Description Type
archivableService The details of the service to register
2. addOrUpdateSchedule

  • Adds the specified shedule, or updates the schedule with the specified scheduleId

  • Arguments:

Name Description Type
scheduleId The id of the schedule to add or update
datesOfTheMonth The dates of the month to request the collection of archivable data
  • List
  • Type:
daysOfTheWeek The days of the week to request the collection of archivable data
timesOfTheDay The times of the day to request the collection of archivable data. Default = 12:00am
3. addRecords

  • Adds the specified records to the archive. Returns the ids of all of the records that were added

  • Arguments:

Name Description Type
archiveRecords The records to add to the archive
4. addRecordTags

  • Adds the specified tags to every record in the archive that passes the filter. Returns the ids of all of the records that the tag was added to

  • Arguments:

Name Description Type
tags The tags to add
recordFilter The filter used to determine which records to add the tags to
5. deleteArchivableServices

  • Unregister the ArchivableServices with the specified serviceIds that are registered with the specified schedules

  • Arguments:

Name Description Type
scheduleIds The ids of the schedules of the services to unregister. If serviceIds is null, unregisters all of the services with the specified scheduleIds. If serviceIds and scheduleIds are both null, unregisters all of the registered services
serviceIds The ids of the services to unregisters. If scheduleIds is null, unregisters all of the specified serviceIds regardless of schedule. If serviceIds and scheduleIds are both null, unregisters all of the registered services
6. deleteRecords

  • Removes every record from the archive that passes the filter. Returns the ids of all of the records that were deleted

  • Arguments:

Name Description Type
recordFilter The filter used to determine which records to delete
7. deleteRecordTags

  • Removes the specified tags to every record in the archive that passes the filter. Returns the ids of all of the records that the tag was removed from

  • Arguments:

Name Description Type
tags The tags to remove
recordFilter The filter used to determine which records to remove the tags from
8. deleteSchedules

  • Remove the specified schedules from the system, including their record collector actor services

  • Arguments:

Name Description Type
scheduleIds The ids of the schedules to delete. If null or empty, deletes all schedules
9. toggleRecordCollection

  • Toggle whether or not record collection is paused for the specified serviceIds that are registered with the specified schedules

  • Arguments:

Name Description Type
pauseCollection Whether or not collection should be paused for the specified serviceIds that are registered with the specified schedules
scheduleId The ids of the schedules to toggle collection for. If serviceIds is null, toggles collection for all of the services with the specified scheduleIds. If serviceIds and scheduleIds are both null, toggles collection for all of the registered services
serviceIds The ids of the services to toggle collection for. If scheduleIds is null, toggles collection for all of the specified serviceIds regardless of schedule. If serviceIds and scheduleIds are both null, toggles collection for all of the registered services
10. tryRestoreRecords

  • Restores every record from the archive that passes the filter back into the service that archived it. Returns the ids of all of the records that were restored

  • Arguments:

Name Description Type
recordFilter The filter used to determine which records to restore
11. updateServiceArchiveTriggers

  • Update the triggers for the specified ArchivableService to reflect the updated trigger data. Returns the ids of all of the schedules that that service was updated for

  • Arguments:

Name Description Type
serviceId The id of the service whose triggers to update
scheduleId The id of the schedule that the service is registered under. If null, updates the triggers for every instance of the ServiceId
archiveTriggers The ArchiveTriggers used by the service to determine whether or not data should be archived

Return to top

ArchiveReferenceClientMutation

Object

Exposes changes that can be made to the services

Methods:

1. clearAllState
  • Remove all of the service state
2. updateTaskSimulationSettings

  • Update the settings for how the TaskSimulationLoop should work

  • Arguments:

Name Description Type
simulateTasks Whether or not the task simulator should be running
maxNumTasks The maximum number of tasks that should be created
  • NonNull
  • Type:
delayInSeconds The amount of time, in seconds, to wait between each run of the task simulation loop
  • NonNull
  • Type:
ageInSecondsToCompleteTask How old the task should be, in seconds, before it gets set to complete
  • NonNull
  • Type:

Return to top

CoordinateConversionMutation

Object

Exposes changes that can be made to Coordinate Conversion

Methods:

1. addOrUpdateConversion

  • Adds or updates a Conversion in the Coordinate Transforms Reliable Collection.

  • Arguments:

Name Description Type
agentType
facilityId
vector3Transform
2. removeConversion

  • Removes a Conversion in the Coordinate Transforms Reliable Collection.

  • Arguments:

Name Description Type
agentType
facilityId

Return to top

DeadLetterMutationOfIAciEmulatorStatelessService

Object

Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearDeadLetters

  • Clears all letters from the dead letters dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. retryDeadLetter

  • Returns a letter to its sender to retry processing. If the sender acknowledges the retry, the letter is removed from the dead items collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterPayload An optional modified payload to use when retrying a dead letter. If null or empty, the original payload of the letter will be used
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
4. tryRemoveDeadLetter

  • Removes a dead letter from the dead letter collection. After this operation the letter can no longer be retried - it has been dropped.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterMutationOfIAciStatelessService

Object

Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearDeadLetters

  • Clears all letters from the dead letters dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. retryDeadLetter

  • Returns a letter to its sender to retry processing. If the sender acknowledges the retry, the letter is removed from the dead items collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterPayload An optional modified payload to use when retrying a dead letter. If null or empty, the original payload of the letter will be used
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
4. tryRemoveDeadLetter

  • Removes a dead letter from the dead letter collection. After this operation the letter can no longer be retried - it has been dropped.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterMutationOfIAgentHubWebService

Object

Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearDeadLetters

  • Clears all letters from the dead letters dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. retryDeadLetter

  • Returns a letter to its sender to retry processing. If the sender acknowledges the retry, the letter is removed from the dead items collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterPayload An optional modified payload to use when retrying a dead letter. If null or empty, the original payload of the letter will be used
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
4. tryRemoveDeadLetter

  • Removes a dead letter from the dead letter collection. After this operation the letter can no longer be retried - it has been dropped.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterMutationOfISeegridEmulatorStatelessService

Object

Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearDeadLetters

  • Clears all letters from the dead letters dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. retryDeadLetter

  • Returns a letter to its sender to retry processing. If the sender acknowledges the retry, the letter is removed from the dead items collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterPayload An optional modified payload to use when retrying a dead letter. If null or empty, the original payload of the letter will be used
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
4. tryRemoveDeadLetter

  • Removes a dead letter from the dead letter collection. After this operation the letter can no longer be retried - it has been dropped.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterMutationOfISeegridStatelessService

Object

Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearDeadLetters

  • Clears all letters from the dead letters dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. retryDeadLetter

  • Returns a letter to its sender to retry processing. If the sender acknowledges the retry, the letter is removed from the dead items collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterPayload An optional modified payload to use when retrying a dead letter. If null or empty, the original payload of the letter will be used
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
4. tryRemoveDeadLetter

  • Removes a dead letter from the dead letter collection. After this operation the letter can no longer be retried - it has been dropped.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterMutationOfITaskAssignmentWebService

Object

Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearDeadLetters

  • Clears all letters from the dead letters dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. retryDeadLetter

  • Returns a letter to its sender to retry processing. If the sender acknowledges the retry, the letter is removed from the dead items collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterPayload An optional modified payload to use when retrying a dead letter. If null or empty, the original payload of the letter will be used
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
4. tryRemoveDeadLetter

  • Removes a dead letter from the dead letter collection. After this operation the letter can no longer be retried - it has been dropped.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterMutationOfITdaProxyCommunicatorWebService

Object

Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearDeadLetters

  • Clears all letters from the dead letters dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. retryDeadLetter

  • Returns a letter to its sender to retry processing. If the sender acknowledges the retry, the letter is removed from the dead items collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterPayload An optional modified payload to use when retrying a dead letter. If null or empty, the original payload of the letter will be used
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
4. tryRemoveDeadLetter

  • Removes a dead letter from the dead letter collection. After this operation the letter can no longer be retried - it has been dropped.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

DeadLetterMutationOfITdaProxyEmulatorWebService

Object

Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearDeadLetters

  • Clears all letters from the dead letters dictionary for the specified letter sender.

  • Arguments:

Name Description Type
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
3. retryDeadLetter

  • Returns a letter to its sender to retry processing. If the sender acknowledges the retry, the letter is removed from the dead items collection.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterPayload An optional modified payload to use when retrying a dead letter. If null or empty, the original payload of the letter will be used
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
4. tryRemoveDeadLetter

  • Removes a dead letter from the dead letter collection. After this operation the letter can no longer be retried - it has been dropped.

  • Arguments:

Name Description Type
deadLetterId The id of a dead letter to target with this operation
deadLetterSenderId The id of the dead letter sender to target with this operation. This will be the id of a reliable queue processor.
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:

Return to top

InventoryMutation

Object

Exposes changes that can be made to Inventory Service

Methods:

1. addLocations

  • Adds location(s) to the service

  • Arguments:

Name Description Type
request
2. addLocationScheme

  • Adds a location scheme to the service

  • Arguments:

Name Description Type
request
3. clearAllReservations
  • Clears the Reservation reliable collection and unoccupies all locations
4. clearAllState
  • Clears the LocationScheme, Location, and Reservation reliable collections
5. deleteLocation

  • Deletes a location from the service

  • Arguments:

Name Description Type
request
6. deleteLocationScheme

  • Deletes a location scheme from the service

  • Arguments:

Name Description Type
request
7. reserveLocation

  • Reserves a location for a future pick/put

  • Arguments:

Name Description Type
request
8. storeContainer

  • Stores a container in a location in the system

  • Arguments:

Name Description Type
request
9. transferContainer

  • Removes a container for transfer in the system

  • Arguments:

Name Description Type
request
10. unreserveLocation

  • Removes a reservation from the system

  • Arguments:

Name Description Type
request
11. updateLocation

  • Updates a location with given parameters. This is for admin use only and should NOT be put in normal consumption

  • Arguments:

Name Description Type
location
12. updateLocations

  • Updates a batch of locations with given parameters. This is for admin use only and should NOT be put in normal consumption

  • Arguments:

Name Description Type
request

Return to top

LogHubMutation

Object

Exposes changes that can be made to LogHub Service

Methods:

1. clearBlockList
  • Clear the entire block list. This allows all logs to reach the database.
2. configureLogChannel

  • Configure a single log channel.

  • Arguments:

Name Description Type
request The log channel configuration.
3. logMultiple

  • Creates a batch of log entries to the service.

  • Arguments:

Name Description Type
request The log entries to be created.
4. removeBlockListEntry

  • Remove a single block list entry from the block list. This allows all logs matching the event provider/name pair in the block entry to reach the database.

  • Arguments:

Name Description Type
request The block list entry to be removed.

Return to top

MapMutation

Object

Exposes changes that can be made to Map Service

Methods:

1. clearNodeReservation

  • Manually clear the reservations from the specified nodes

  • Arguments:

Name Description Type
request The filter used to determine which node reservations to clear
2. setMaestroMapConfiguration

  • Get the current configuration for the map service

  • Arguments:

Name Description Type
request
3. startRoute

  • An endpoint to inform the map service that an agent is ready to start route execution

  • Arguments:

Name Description Type
startRouteInput The Agent And Task to start route on.
4. stopRoute

  • An endpoint to inform the map service that an agent has finished route traversal.

  • Arguments:

Name Description Type
stopRouteInput The Agent to stop route on.
5. taskBidEnricherMutation
  • Defines operations on TaskBidEnrichers hosted in the service targeted by the parent mutation
6. updateReservation

  • Update a reservation by adding or removing nodes from the reservation.

  • Arguments:

Name Description Type
updateRouteReservationInput The reservation id and nodes to reserve and/or unreserve.
7. updateRoute

  • An endpoint to inform the map service that an agent is updating the route.

  • Arguments:

Name Description Type
updateRouteInput The agent and task to update a route on.

Return to top

Mutation

Object

Contains field from the following sub-queries: AciMutation: Exposes changes that can be made to the services AciEmulatorMutation: Exposes changes that can be made to the services TdaProxyCommunicatorMutation: Exposes changes that can be made to the service TdaProxyEmulatorMutation: Exposes changes that can be made to the services SeegridMutation: Exposes changes that can be made to the services SeegridEmulatorMutation: Exposes changes that can be made to the services AgentHubMutation: Exposes changes that can be made to the service AliasingMutation: Exposes changes that can be made to Aliasing Service ArchiveMutation: Exposes changes that can be made to the services ArchiveReferenceClientMutation: Exposes changes that can be made to the services CoordinateConversionMutation: Exposes changes that can be made to Coordinate Conversion InventoryMutation: Exposes changes that can be made to Inventory Service TaskAssignmentMutation: Defines the objects that can be created or changed through the task assignment API LogHubMutation: Exposes changes that can be made to LogHub Service MapMutation: Exposes changes that can be made to Map Service

Methods:

1. aciEmulatorMutation
  • Exposes changes that can be made to the services
2. aciMutation
  • Exposes changes that can be made to the services
3. agentHubMutation
  • Exposes changes that can be made to the service
4. aliasingMutation
  • Exposes changes that can be made to Aliasing Service
5. archiveMutation
  • Exposes changes that can be made to the services
6. archiveReferenceClientMutation
  • Exposes changes that can be made to the services
7. coordinateConversionMutation
  • Exposes changes that can be made to Coordinate Conversion
8. inventoryMutation
  • Exposes changes that can be made to Inventory Service
9. logHubMutation
  • Exposes changes that can be made to LogHub Service
10. mapMutation
  • Exposes changes that can be made to Map Service
11. seegridEmulatorMutation
  • Exposes changes that can be made to the services
12. seegridMutation
  • Exposes changes that can be made to the services
13. taskAssignmentMutation
  • Defines the objects that can be created or changed through the task assignment API
14. tdaProxyCommunicatorMutation
  • Exposes changes that can be made to the service
15. tdaProxyEmulatorMutation
  • Exposes changes that can be made to the services

Return to top

QueueProcessorMutationOfIAciEmulatorStatelessService

Object

Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearAllQueueProcessorsItems

  • Dequeues all items from all processors without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
3. clearQueueProcessorItems

  • Dequeues all items from the specified processor without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
4. pauseAllQueueProcessors

  • Temporarily pauses processing items for all queue processors. This is a best-effort process - some items may be process while this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
5. pauseQueueProcessor

  • Temporarily pauses processing items for the specified queue processor. This is a best-effort process - some items may be processed while this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
6. resumeAllQueueProcessors

  • Resumes processing items for all queue processors. Has no effect on queue processors which are not currently paused.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
7. resumeQueueProcessor

  • Resumes processing items for the specified queue processor. Has no effect if the queue is not currently paused.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
8. setReliableQueueProcessorConfig

  • Set the current configuration for this service's reliable queue processors

  • Arguments:

Name Description Type
config The updated configuration for this service's reliable queue processors. If a property is not specified, its data is not overwritten

Return to top

QueueProcessorMutationOfIAciStatelessService

Object

Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearAllQueueProcessorsItems

  • Dequeues all items from all processors without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
3. clearQueueProcessorItems

  • Dequeues all items from the specified processor without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
4. pauseAllQueueProcessors

  • Temporarily pauses processing items for all queue processors. This is a best-effort process - some items may be process while this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
5. pauseQueueProcessor

  • Temporarily pauses processing items for the specified queue processor. This is a best-effort process - some items may be processed while this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
6. resumeAllQueueProcessors

  • Resumes processing items for all queue processors. Has no effect on queue processors which are not currently paused.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
7. resumeQueueProcessor

  • Resumes processing items for the specified queue processor. Has no effect if the queue is not currently paused.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
8. setReliableQueueProcessorConfig

  • Set the current configuration for this service's reliable queue processors

  • Arguments:

Name Description Type
config The updated configuration for this service's reliable queue processors. If a property is not specified, its data is not overwritten

Return to top

QueueProcessorMutationOfIAgentHubWebService

Object

Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearAllQueueProcessorsItems

  • Dequeues all items from all processors without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
3. clearQueueProcessorItems

  • Dequeues all items from the specified processor without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
4. pauseAllQueueProcessors

  • Temporarily pauses processing items for all queue processors. This is a best-effort process - some items may be process while this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
5. pauseQueueProcessor

  • Temporarily pauses processing items for the specified queue processor. This is a best-effort process - some items may be processed while this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
6. resumeAllQueueProcessors

  • Resumes processing items for all queue processors. Has no effect on queue processors which are not currently paused.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
7. resumeQueueProcessor

  • Resumes processing items for the specified queue processor. Has no effect if the queue is not currently paused.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
8. setReliableQueueProcessorConfig

  • Set the current configuration for this service's reliable queue processors

  • Arguments:

Name Description Type
config The updated configuration for this service's reliable queue processors. If a property is not specified, its data is not overwritten

Return to top

QueueProcessorMutationOfISeegridEmulatorStatelessService

Object

Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearAllQueueProcessorsItems

  • Dequeues all items from all processors without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
3. clearQueueProcessorItems

  • Dequeues all items from the specified processor without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
4. pauseAllQueueProcessors

  • Temporarily pauses processing items for all queue processors. This is a best-effort process - some items may be process while this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
5. pauseQueueProcessor

  • Temporarily pauses processing items for the specified queue processor. This is a best-effort process - some items may be processed while this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
6. resumeAllQueueProcessors

  • Resumes processing items for all queue processors. Has no effect on queue processors which are not currently paused.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
7. resumeQueueProcessor

  • Resumes processing items for the specified queue processor. Has no effect if the queue is not currently paused.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
8. setReliableQueueProcessorConfig

  • Set the current configuration for this service's reliable queue processors

  • Arguments:

Name Description Type
config The updated configuration for this service's reliable queue processors. If a property is not specified, its data is not overwritten

Return to top

QueueProcessorMutationOfISeegridStatelessService

Object

Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearAllQueueProcessorsItems

  • Dequeues all items from all processors without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
3. clearQueueProcessorItems

  • Dequeues all items from the specified processor without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
4. pauseAllQueueProcessors

  • Temporarily pauses processing items for all queue processors. This is a best-effort process - some items may be process while this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
5. pauseQueueProcessor

  • Temporarily pauses processing items for the specified queue processor. This is a best-effort process - some items may be processed while this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
6. resumeAllQueueProcessors

  • Resumes processing items for all queue processors. Has no effect on queue processors which are not currently paused.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
7. resumeQueueProcessor

  • Resumes processing items for the specified queue processor. Has no effect if the queue is not currently paused.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
8. setReliableQueueProcessorConfig

  • Set the current configuration for this service's reliable queue processors

  • Arguments:

Name Description Type
config The updated configuration for this service's reliable queue processors. If a property is not specified, its data is not overwritten

Return to top

QueueProcessorMutationOfITaskAssignmentWebService

Object

Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearAllQueueProcessorsItems

  • Dequeues all items from all processors without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
3. clearQueueProcessorItems

  • Dequeues all items from the specified processor without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
4. pauseAllQueueProcessors

  • Temporarily pauses processing items for all queue processors. This is a best-effort process - some items may be process while this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
5. pauseQueueProcessor

  • Temporarily pauses processing items for the specified queue processor. This is a best-effort process - some items may be processed while this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
6. resumeAllQueueProcessors

  • Resumes processing items for all queue processors. Has no effect on queue processors which are not currently paused.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
7. resumeQueueProcessor

  • Resumes processing items for the specified queue processor. Has no effect if the queue is not currently paused.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
8. setReliableQueueProcessorConfig

  • Set the current configuration for this service's reliable queue processors

  • Arguments:

Name Description Type
config The updated configuration for this service's reliable queue processors. If a property is not specified, its data is not overwritten

Return to top

QueueProcessorMutationOfITdaProxyCommunicatorWebService

Object

Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearAllQueueProcessorsItems

  • Dequeues all items from all processors without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
3. clearQueueProcessorItems

  • Dequeues all items from the specified processor without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
4. pauseAllQueueProcessors

  • Temporarily pauses processing items for all queue processors. This is a best-effort process - some items may be process while this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
5. pauseQueueProcessor

  • Temporarily pauses processing items for the specified queue processor. This is a best-effort process - some items may be processed while this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
6. resumeAllQueueProcessors

  • Resumes processing items for all queue processors. Has no effect on queue processors which are not currently paused.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
7. resumeQueueProcessor

  • Resumes processing items for the specified queue processor. Has no effect if the queue is not currently paused.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
8. setReliableQueueProcessorConfig

  • Set the current configuration for this service's reliable queue processors

  • Arguments:

Name Description Type
config The updated configuration for this service's reliable queue processors. If a property is not specified, its data is not overwritten

Return to top

QueueProcessorMutationOfITdaProxyEmulatorWebService

Object

Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Methods:

1. cancel
  • Signals cancellation for any currently executing queue processor GraphQL operations.
2. clearAllQueueProcessorsItems

  • Dequeues all items from all processors without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
3. clearQueueProcessorItems

  • Dequeues all items from the specified processor without processing them. This is a best-effort process - some items may be processed before this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
4. pauseAllQueueProcessors

  • Temporarily pauses processing items for all queue processors. This is a best-effort process - some items may be process while this operation completes.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
5. pauseQueueProcessor

  • Temporarily pauses processing items for the specified queue processor. This is a best-effort process - some items may be processed while this operation completes.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
6. resumeAllQueueProcessors

  • Resumes processing items for all queue processors. Has no effect on queue processors which are not currently paused.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
7. resumeQueueProcessor

  • Resumes processing items for the specified queue processor. Has no effect if the queue is not currently paused.

  • Arguments:

Name Description Type
queueProcessorId The id of the queue processor to target with this operation
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
8. setReliableQueueProcessorConfig

  • Set the current configuration for this service's reliable queue processors

  • Arguments:

Name Description Type
config The updated configuration for this service's reliable queue processors. If a property is not specified, its data is not overwritten

Return to top

SeegridEmulatorMutation

Object

Exposes changes that can be made to the services

Methods:

1. addOrUpdateAgentSettings

  • Adds emulation settings for the emulated agent

  • Arguments:

Name Description Type
agentSettingsInput The emulated agent along with its settings
2. addOrUpdateSwitch

  • Adds a switch to the emulator

  • Arguments:

Name Description Type
switchInput The switch and its properties
3. clearAllState
  • Clears the state of the entire service
4. deadLetterMutation
  • Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type
5. deleteAgentSettings

  • Deletes emulation settings for the emulated agent

  • Arguments:

Name Description Type
agentId The id of the emulated agent who's settings to delete
6. deleteSwitch

  • Deletes switch in the emulator

  • Arguments:

Name Description Type
switchName The name of the switch to delete
7. queueProcessorMutation
  • Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Return to top

SeegridMutation

Object

Exposes changes that can be made to the services

Methods:

1. clearActiveTask

  • Clears the active task of the agent specified by the AgentId

  • Arguments:

Name Description Type
agentId The Id of the agent whose active task to clear
2. clearAllState
  • Clears the state of the entire service
3. deadLetterMutation
  • Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type
4. queueProcessorMutation
  • Defines operations on reliable queue processors hosted in the service targeted by the parent mutation

Return to top

TaskAssignmentMutation

Object

Defines the objects that can be created or changed through the task assignment API

Methods:

1. activateTaskGroup

  • Activates a task group, allowing the task assignment service to assign its tasks to agents for execution.

  • Arguments:

Name Description Type
taskGroupName The task group to activate
2. beginCancelTask
  • Queues a task cancellation. When the request is dequeued, Task Assignment responds based on the task's status:

  • If the task is not assigned, the task is cancelled immediately.

  • If the task is already ended, nothing happens.

  • If the task is assigned, Task Assignment cancels the task, removes it from the agent's assigned tasks queue, and alerts the assigned agent's service so that it can cleanup any associated state.

  • If the task is dispatched, Task Assignment messages the assigned agent's service to cancel the task with the agent.

    • Arguments:
Name Description Type
beginCancelTaskInput Describes the task to cancel
3. beginCompleteTask
  • Queues a task completion. When the request is dequeued, Task Assignment responds based on the task's status:

  • If the task is not assigned, the task is completed immediately.

  • If the task is already ended, nothing happens.

  • If the task is assigned, Task Assignment completes the task, removes it from the agent's assigned tasks queue, and alerts the assigned agent's service so that it can cleanup any associated state.

  • If the task is dispatched, Task Assignment messages the assigned agent's service to complete the task with the agent.

    • Arguments:
Name Description Type
beginCompleteTaskInput Describes the task to complete
4. beginDispatchTasks
  • Queues a task dispatch to one or more agents. When the request is dequeued, Task Assignment observes each agent's assigned task list and acts according to the ReDispatchCurrentTask flag:

  • If ReDispatchCurrentTask is true, and the agent has a dispatched task, Task Assignment re-dispatches the agent's current task.

  • If ReDispatchCurrentTask is false, and the agent does NOT have a dispatched task, Task Assignment dispatches the agent's next assigned task, if any.

    • Arguments:
Name Description Type
beginDispatchTasksInput Describes which agents to dispatch tasks to.
5. beginFaultTask
  • Queues a task fault. When the request is dequeued, Task Assignment responds based on the task's status:

  • If the task is not assigned, the task is faulted immediately.

  • If the task is already ended, nothing happens.

  • If the task is assigned, Task Assignment faults the task, removes it from the agent's assigned tasks queue, and alerts the assigned agent's service so that it can cleanup any associated state.

  • If the task is dispatched, Task Assignment messages the assigned agent's service to fault the task with the agent.

    • Arguments:
Name Description Type
beginFaultTaskInput Describes the task to fault
6. beginReAssignTasks
  • NonNull
  • Type:

  • Queues a batch of tasks for re-assignment from their current agents to new agents. When the request is dequeued for each task, if the task is not found; is not Assigned or Dispatched; or is not assigned to the specified OldAgentId, then an error will be logged and nothing will happen for that task. WARNING: This is an admin operation. It moves the task from the old agent's assigned task queue into the new agent's assigned task queue and also changes the AgentId on the task model. This operation does not reach out to the Maestro Agent Service or attempt to communicate with the physical agent / agent proxy. If the response indicates sucess, that only means that the operation was successfully queued for processing and does not guarantee that the operation actually succeeded at processing

  • Arguments:

Name Description Type
beginReAssignTasks Describes the tasks to re-assign, including each of the task's OldAgentIds and NewAgentIds
7. beginUnassignTask
  • Queues a batch of tasks for unassignment. When the request is dequeued, Task Assignment responds based on the task's status:

  • If the task is not assigned, nothing happens.

  • If the task is assigned, Task Assignment handles unassigning it.

  • If the task is already ended, nothing happens.

    • Arguments:
Name Description Type
beginUnassignTasksInput Describes the tasks to queue for unassignment
8. clearAllState
  • Clears all reliable state from the service
9. clearAssignedTasks

  • Clears the queue of assigned tasks for the specified agent. WARNING: This is an admin operation and therefore should not be used unless nothing else worked to fix the state (like BeginUnassign, BeginCancel, etc)

  • Arguments:

Name Description Type
agentId The id of the agent whose queue of assigned tasks to clear
10. createMissionTask

  • Creates a new mission task on the specified task group

  • Arguments:

Name Description Type
createTaskInput The mission task to create
11. createPalletPickTask

  • Creates a new pallet pick task on the specified task group

  • Arguments:

Name Description Type
createTaskInput The pallet pick task to create
12. createPalletPlaceTask

  • Creates a new pallet place task on the specified task group

  • Arguments:

Name Description Type
createTaskInput The pallet place task to create
13. createProductPickTask

  • Creates a new product pick task on the specified task group

  • Arguments:

Name Description Type
createTaskInput The product pick task to create
14. createTaskGroup

  • Creates a new, empty task group.

  • Arguments:

Name Description Type
createTaskGroupInput The task group to create
15. createTransferTask

  • Creates a new transfer task on the specified task group

  • Arguments:

Name Description Type
createTaskInput The transfer task to create
16. deadLetterMutation
  • Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type
17. endTask

  • Marks a task as ended in a successful or failed state

  • Arguments:

Name Description Type
endTaskInput Describes the final state in which to end the task, and other metadata related to the task's completion.
18. pauseTaskGroup

  • Pauses the specified TaskGroups which temporarily removes them from the task assignment process. Returns the ids of the TaskGroups that were paused as well as error messages regarding the TaskGroups that could not be paused

  • Arguments:

Name Description Type
taskGroupNames The names of the task groups to try to pause
  • NonNull
  • Type:
19. queueProcessorMutation
  • Defines operations on reliable queue processors hosted in the service targeted by the parent mutation
20. registerForTaskUpdates

  • Registers a subscriber to receive updates whenever tasks of the specified types get updated.

  • Arguments:

Name Description Type
registrationInput The details of the subscriber and the task types to subscribe to
21. removeTaskGroups

  • Removes empty task groups with names matching the specified values. If a group cannot be found, or if a group has tasks associated with it, then it will not be removed.

  • Arguments:

Name Description Type
taskGroupNames The names of the task groups to remove
22. removeTasks

  • Removes tasks with the given names from the Task Assignment Service. This is an admin operation which does not affect assigned tasks.

  • Arguments:

Name Description Type
taskGroupName The name of the task group that these tasks belong to.
tasksNames The names of the tasks to be removed from the service.
23. resumeTaskGroup

  • Re-activates the specified TaskGroups back into the task assignment process. Returns the ids of the TaskGroups that were resumed as well as error messages regarding the TaskGroups that could not be resumed

  • Arguments:

Name Description Type
taskGroupNames The names of the task groups to try to resume
  • NonNull
  • Type:
24. setTaskAssignmentConfig

  • Updates the task assignment configuration with the values specified, then returns the new configuration if there are no errors. At least one argument must be non-null.

  • Arguments:

Name Description Type
priorityComponentWeights The weights of the components for task priority
taskBidCostComponentWeights The weights of the components for task bidding
transformableTaskTypes Obsolete: task transformation is now configured on the TaskTypes configuration. This value was used to define the task types that are transformable
taskTypes Configuration for the individual task types, including aliasing and task transformation
runLoopMonitorMaxRecords The maximum amount of records to save from a run loop
taskBidEnrichers The services capable of enriching task bids
taskBatchConfiguration The defined task batch settings
taskExpirationTimeSpan An Optional Configuration setting that describes how long before tasks are auto canceled in HH:MM:SS format.
taskAssignmentRunLoopDelayInMilliseconds An optional configuration setting that sets the task assignment run loop delay duration between loops in milliseconds.
25. unregisterForTaskUpdates

  • Unregisters a subscriber from updates whenever tasks of the subscribed types get updated.

  • Arguments:

Name Description Type
subscriberName The name of the subscriber to unregister
26. updateTasks

  • Updates select properties on the specified tasks, provided they have not yet been assigned.

  • Arguments:

Name Description Type
updateTaskBatchInput Specifies which properties of the task should be updated.

Return to top

TaskBidEnricherMutationOfIMapStatelessService

Object

Defines mutations on TaskBidEnrichers hosted in the service targeted by the parent mutation

Return to top

TdaProxyCommunicatorMutation

Object

Exposes changes that can be made to the service

Methods:

1. abortMissionRequest

  • Send an AbortMissionRequest to the TdaProxyServer

  • Arguments:

Name Description Type
missionId The id of the mission to abort
  • NonNull
  • Type:
abortReason The reason for aborting the mission
2. appendMissionTasksRequest

  • Send the AppendMissionTasksRequest to the TdaProxyServer

  • Arguments:

Name Description Type
missionId The id of the mission to append the tasks to
  • NonNull
  • Type:
tasks The tasks to append to the mission
3. clearActiveTask

  • Clears the active task for the specified agent

  • Arguments:

Name Description Type
agentId The id of the agent whose active task clear
4. completeMissionTaskRequest

  • Send a CompleteMissionTaskRequest to the TdaProxyServer

  • Arguments:

Name Description Type
missionId The id of the mission to complete
  • NonNull
  • Type:
taskId The id of the task to complete
  • NonNull
  • Type:
5. createMissionRequest

  • Send a CreateMissionRequest to the TdaProxyServer

  • Arguments:

Name Description Type
agentId The id of the agent to create the mission for
  • NonNull
  • Type:
missionId The id of the mission to create
6. deadLetterMutation
  • Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type
7. deleteMissionTasksRequest

  • Send a DeleteMissionTasksRequest to the TdaProxyServer

  • Arguments:

Name Description Type
missionId The id of the mission to delete the tasks from
  • NonNull
  • Type:
tasks The ids of the tasks to delete
  • NonNull
  • Type:
    • List
    • Type:
8. dispatchMessage

  • Send a DispatchMessage to the TdaProxyServer

  • Arguments:

Name Description Type
agentId The id of the agent to send the message to
  • NonNull
  • Type:
message The message to send to the agent (max 4 bytes)
9. endMissionTasksRequest

  • Send a EndMissionTasksRequest to the TdaProxyServer

  • Arguments:

Name Description Type
missionId The id of the mission to end
  • NonNull
  • Type:
10. queueProcessorMutation
  • Defines operations on reliable queue processors hosted in the service targeted by the parent mutation
11. removeVehicleRequest

  • Send a RemoveVehicleRequest to the TdaProxyServer

  • Arguments:

Name Description Type
agentId The id of the agent to remove
  • NonNull
  • Type:
12. setActiveMissionOverride

  • Sets for the specified agents whether or not active missions should be overriden when a new mission is commissioned. If no agents are specified, the setting is applied to all agents in the service

  • Arguments:

Name Description Type
agentIds The ids of the agents whose ActiveMissionOverride setting to set. If no agents are specified, the setting is applied to all agents in the service
value Whether to set ActiveMissionOverride to true or to false
13. setTdaProxyConfig

  • Updates the current TdaProxy configuration with the provided argument. Returns the updated configuration

  • Arguments:

Name Description Type
newTdaProxyConfig Sets the current configuration settings for the TdaProxy services.
14. signalVehicleRequest

  • Send a SignalVehicleRequest to the TdaProxyServer

  • Arguments:

Name Description Type
agentId The id of the agent to signal
  • NonNull
  • Type:
pauseVehicle Whether to pause or resume the vehicle

Return to top

TdaProxyEmulatorMutation

Object

Exposes changes that can be made to the services

Methods:

1. clearAllState
  • Remove all of the agent emulator ActorServices and clear all of the DataService state
2. createAgent

  • Create a new agent emulator ActorService

  • Arguments:

Name Description Type
agentId The id of the agent to emulate (also known as the Machine Number)
  • NonNull
  • Type:
3. deadLetterMutation
  • Defines operations that can be used to change the state of a dead letter collection hosted in the service targeted by the parent type
4. queueProcessorMutation
  • Defines operations on reliable queue processors hosted in the service targeted by the parent mutation
5. removeAgent

  • Delete the specified agent emulator ActorService and clear all of its associated DataService state

  • Arguments:

Name Description Type
agentId The id of the agent to remove (also known as the Machine Number)
  • NonNull
  • Type:

Return to top

Object

__Directive

Object

A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.

Fields:

1. args
2. description
3. locations
4. name

Return to top

__EnumValue

Object

One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.

Fields:

1. deprecationReason
2. description
3. isDeprecated
4. name

Return to top

__Field

Object

Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.

Fields:

1. args
2. deprecationReason
3. description
4. isDeprecated
5. name
6. type

Return to top

__InputValue

Object

Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.

Fields:

1. defaultValue
  • A GraphQL-formatted string representing the default value for this input value.
2. description
3. name
4. type

Return to top

__Schema

Object

A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.

Fields:

1. directives
  • A list of all directives supported by this server.
2. mutationType
  • If this server supports mutation, the type that mutation operations will be rooted at.
3. queryType
  • The type that query operations will be rooted at.
4. subscriptionType
  • If this server supports subscription, the type that subscription operations will be rooted at.
5. types
  • NonNull
  • Type:
    • List
    • Type:
  • A list of all types supported by this server.

Return to top

__Type

Object

The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the __TypeKind enum.

Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.

Fields:

1. description
2. enumValues

  • Arguments:

Name Description Type
includeDeprecated
3. fields
  • List
  • Type:

  • Arguments:

Name Description Type
includeDeprecated
4. inputFields
5. interfaces
  • List
  • Type:
6. kind
7. name
8. ofType
9. possibleTypes
  • List
  • Type:

Return to top

AciActiveTask

Object

The details of the active task for an AciCarrier

Fields:

1. agentId
  • The id of the agent
2. carrierId
  • The id of the agent as a UShort
3. dispatchedTask
  • The details of the task at the time it was dispatched
4. finalTaskExecutionStatus
  • NonNull
  • Type:
  • What the final TaskExecution status should be if ForceEndTask has been requested
5. forceEndTaskRequested
  • Whether or not the task should be force ending
6. iKey
  • The unique id passed to System Manager during order creation
7. orderIndex
  • The unique id of the order according to System Manager
8. orderPhase
  • The current phase of the order
9. orderStatus
  • The current status of the order
10. picked
  • Whether or not inventory has been picked for this task
11. placed
  • Whether or not inventory has been placed for this task
12. taskType
  • The type of transport task

Return to top

AciCarrier

Object

The details of an AciCarrier

Fields:

1. acknowledgedSegment
  • The currently acknowledged segment
2. action
  • The latest action
3. agvType
  • The type of the AGV
4. angle
  • The AGV orientation, relative to the X/Y coordinate system
5. carrierId
  • The id of the agent
6. currentSegment
  • The id of the current segment. 0 if AGV in manual mode
7. currentSegmentDistance
  • The distance on the current segment in millimeters. Bit 0: (0 = EvenDistance, not on point. 1 = OddDistance, on segment endpoint)
8. errorCode
  • The last received OP error code
9. eStopped
  • Whether or not the agent is emergency stopped
10. etaSeconds
  • The estimated time of arrival in seconds. A negative value indicates a too late arrival
11. lastUpdateTimestamp
  • The UTC time that the last update was received
12. loaded
  • Whether or not the agent has a container on its forks
13. lowBattery
  • Whether or not the agent has low battery
14. mainStatus
  • The main status of the AGV
15. manualMode
  • Whether or not the agent is in manual mode
16. moveState
  • The movement state of the AGV
17. operation
  • The latest sent operation code
18. orderIndex
  • The index of the current order
19. plcParameterOne
  • The first PLC parameter
20. plcParameterTwo
  • The second PLC parameter
21. point
  • The point ID if CmvPnt instruction, else 0
22. result
  • The last receieved result value
23. rotationW
  • The W value of the rotation as a quaternion
24. rotationX
  • The X value of the rotation as a quaternion
25. rotationY
  • The Y value of the rotation as a quaternion
26. rotationZ
  • The Z value of the rotation as a quaternion
27. safetySensorObstructed
  • Whether or not the agent's safety sensor is obstructed
28. stationId
  • The current station ID
29. taskCancellationReason
  • The reason why the task is getting cancelled
30. taskExecutionError
  • The reason why the agent is not capable of continuing with the mission
31. xCoordinate
  • The x coordinate of the AGV in millimeters. Only used when position is not given correctly by segment and distance.
32. yCoordinate
  • The y coordinate of the AGV in millimeters

Return to top

ActiveMissionOverrideStatus

Object

The ActiveMissionOverride data of an Agent.

Fields:

1. agentId
  • The Id of the agent whose status is being returned.
2. isEnabled
  • Boolean value representing whether or not this agent is set to override active missions.

Return to top

ActiveRouteObject

Object

Details about an active route

Fields:

1. agentId
  • The agent id
2. agentProfile
  • The profile of the agent
3. agentTypeId
  • The agent type
4. route
  • The route summary
5. routeId
  • The route id of the active route
6. taskGroup
  • The task group of the route
7. taskId
  • The task id of the route
8. waypoints
  • The list of waypoints to traverse

Return to top

AddLocationFailure

Object

The response from the AddLocation mutation, received when adding a location fails

Fields:

1. locationName
  • The name of the location that failed to be added
2. reason
  • The reason why the location failed to be added

Return to top

AddLocationsResponse

Object

The response from an AddLocations mutation, containing the failures if any were experienced

Fields:

1. addLocationFailures
  • The list of locations that failed to be added including the reason why each one failed

Return to top

Agent

Object

The properties of an agent registered with the Maestro AgentHub service

Fields:

1. communicationStack
  • The communication stack used to communicate with the agent
2. endpointAddress
  • The address of the endpoint that can be used to connect to the agent
3. id
  • The id of the agent
4. payloadPositions
  • The current details of the agent's payload position(s)
5. payloadPositionsProjection
  • The projected details of the agent's payload position(s) after it completes any and all assigned tasks
6. properties
  • A set of any additional properties that describe the agent
7. type
  • The type of the agent

Return to top

AgentEmulatorActor

Object

The details of an agent emulator ActorService

Fields:

1. actorId
  • The ActorId of the agent emulator ActorService
2. agentId
  • NonNull
  • Type:

Return to top

AgentIdAndType

Object

Describes a simplified agent data model containing just the identifying information

Fields:

1. agentId
  • The id of the agent
2. agentTypeId
  • The type of the agent

Return to top

AgentPayloadPosition

Object

The details of the payload position on an agent used to execute a task

Fields:

1. positionId
  • The id of the payload position on the agent

Return to top

AgentPayloadPositionCriteria

Object

The criteria for the payload position on an agent that should be used to execute a task

Fields:

1. positionId
  • The id of the payload position on the agent

Return to top

AgentSettings

Object

The properties of an agent's settings registered in the Seegrid Emulator service

Fields:

1. agentFaultSetting
  • The failure rates for the different stages of a task
2. agentId
  • The id of the agent
3. agentTaskResult
  • The end states that a task can end in (Cancelled, Complete, and Faulted)
4. batteryCharge
  • Flag to toggle battery messages
5. eventCode
  • Flag to toggle event code messages
6. maximumCompletionTime
  • The maximum amount of time to elapse before completion of a task
7. minimumCompletionTime
  • The minimum amount of time to elapse prior to completion of a task
8. obstructed
  • Flag to toggle obstructed messages
9. state
  • Flag to toggle state messages

Return to top

AgentType

Object

The properties of an AgentType registered with the Maestro AgentHub service

Fields:

1. activeTaskOverrideEnabled
  • Whether or not the AgentType supports overriding of active tasks
2. agentServiceUri
  • The address of the service that manages the AgentType
3. agentVelocity
  • The average velocity of the agent in meters per second
4. allowActiveTaskCancellation
  • Whether or not the AgentType supports cancellation of active tasks
5. allowTrafficControl
  • Whether or not the AgentType supports Maestro traffic control
6. coordinatePoseTransform
  • The coordinate conversion configuration of the agent type
7. customCapabilities
  • The custom capabilities supported by the AgentType
8. id
  • The id of the AgentType
9. maxNumAssignedTasks
  • NonNull
  • Type:
  • The maximum number of tasks that can be assigned to each individual agent, including any dispatched tasks
10. payloadPositionTypes
  • The payload position types that exist for this AgentType
11. taskOverrideState
  • Possible end states for an overridden task. Disabled (if the feature is not enabled), Completed, Cancelled, and Faulted
12. taskTypes
  • NonNull
  • Type:
    • List
    • Type:
  • The collection of task types that the AgentType is capable of handling

Return to top

AgentTypeAndProfileType

Object

Input type describing an agent type and profile

Fields:

1. agentProfile
2. agentType

Return to top

AgentTypeCapability

Object

The properties of a custom capability of an AgentType registered with the Maestro AgentHub service

Fields:

1. defaultValue
  • The default value of the capability
2. id
  • The id of the capability

Return to top

AliasBatchObject

Object

The Aliasing response sent back from a GetAliasBatch query.

Fields:

1. key
2. value

Return to top

AliasBatchObjectConnection

Object

A connection from an object to a list of objects of type AliasBatchObject.

Fields:

1. edges
  • Information to aid in pagination.
2. items
  • A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for "{ edges { node } }" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the "cursor" field on the edge to enable efficient pagination, this shortcut cannot be used, and the full "{ edges { node } } " version should be used instead.
3. pageInfo
  • Information to aid in pagination.
4. totalCount
  • A count of the total number of objects in this connection, ignoring pagination. This allows a client to fetch the first five objects by passing "5" as the argument to first, then fetch the total count so it could display "5 of 83", for example. In cases where we employ infinite scrolling or don't have an exact count of entries, this field will return null.

Return to top

AliasBatchObjectEdge

Object

An edge in a connection from an object to another object of type AliasBatchObject.

Fields:

1. cursor
  • A cursor for use in pagination
2. node
  • The item at the end of the edge

Return to top

AliasConfig

Object

The configuration for how a single property should be aliased

Fields:

1. isEnabled
  • Whether or not the property value should get aliased
2. property
  • The name of the property to alias

Return to top

AliasObject

Object

An object detailing an alias' type and value.

Fields:

1. aliasType
2. aliasValue

Return to top

AliasObjectConnection

Object

A connection from an object to a list of objects of type AliasObject.

Fields:

1. edges
  • Information to aid in pagination.
2. items
  • A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for "{ edges { node } }" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the "cursor" field on the edge to enable efficient pagination, this shortcut cannot be used, and the full "{ edges { node } } " version should be used instead.
3. pageInfo
  • Information to aid in pagination.
4. totalCount
  • A count of the total number of objects in this connection, ignoring pagination. This allows a client to fetch the first five objects by passing "5" as the argument to first, then fetch the total count so it could display "5 of 83", for example. In cases where we employ infinite scrolling or don't have an exact count of entries, this field will return null.

Return to top

AliasObjectEdge

Object

An edge in a connection from an object to another object of type AliasObject.

Fields:

1. cursor
  • A cursor for use in pagination
2. node
  • The item at the end of the edge

Return to top

AliasRecord

Object

An object providing a flat view of a single source value and one of its aliases.

Fields:

1. aliasType
2. aliasValue
3. sourceType
4. sourceValue

Return to top

AliasRecordConnection

Object

A connection from an object to a list of objects of type AliasRecord.

Fields:

1. edges
  • Information to aid in pagination.
2. items
  • A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for "{ edges { node } }" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the "cursor" field on the edge to enable efficient pagination, this shortcut cannot be used, and the full "{ edges { node } } " version should be used instead.
3. pageInfo
  • Information to aid in pagination.
4. totalCount
  • A count of the total number of objects in this connection, ignoring pagination. This allows a client to fetch the first five objects by passing "5" as the argument to first, then fetch the total count so it could display "5 of 83", for example. In cases where we employ infinite scrolling or don't have an exact count of entries, this field will return null.

Return to top

AliasRecordEdge

Object

An edge in a connection from an object to another object of type AliasRecord.

Fields:

1. cursor
  • A cursor for use in pagination
2. node
  • The item at the end of the edge

Return to top

AliasType

Object

An object detailing an alias' type

Fields:

1. name

Return to top

ArchivableService

Object

The details of a service registered with the archive for scheduled record collection

Fields:

1. archiveScheduleId
  • The id of the schedule that this service is registered with
2. archiveTriggers
  • The ArchiveTriggers used by the service to determine whether or not data should be archived
3. collectionPaused
  • Whether or not this service should get requests for archivable data according to its archive schedule
4. serviceAddress
  • The address used to communicate with the service
5. serviceId
  • The id of the service

Return to top

ArchiveRecord

Object

The details of a data record in the archive

Fields:

1. collectionName
  • The name of the collection that stored the record in production
2. data
  • The actual archived data, serialized to a string
3. dataType
  • The assembly qualified namespace of the data model, which contains the full namespace as well as the version
4. description
  • A brief description of the data type and why it needs to be archived
5. id
  • The unique Id of the record
6. partitionId
  • The id of the partition that archived the data
7. sourceAddress
  • The address of the WebService used to communicate with the service that created the record
8. tags
  • NonNull
  • Type:
    • List
    • Type:
  • The collection of tags used to filter for the record
9. timeStamp
  • The UTC time that the data was archived

Return to top

ArchiveSchedule

Object

The properties of a schedule of when and how often to request the collection of records from services

Fields:

1. datesOfTheMonth
  • NonNull
  • Type:
    • List
    • Type:
      • NonNull
      • Type:
  • The dates of the month to request the collection of archivable data
2. daysOfTheWeek
  • The days of the week to request the collection of archivable data
3. scheduleId
  • The id of the schedule
4. serviceIds
  • NonNull
  • Type:
    • List
    • Type:
  • The ids of the services registered with the schedule
5. timesOfTheDay
  • The times of the day to request the collection of archivable data

Return to top

ArchiveTrigger

Object

Triggers used by archivable services to determine what data is ready to be archived

Fields:

1. metrics
  • The inclusive collection of metrics used to determine if the targeted data is ready to be archived
2. targetedData
  • The type of data targeted by the trigger (Ex: "Tasks")

Return to top

ArchiveTriggerMetric

Object

The part of an ArchiveTrigger that maps metrics of data to the value required for that data to be ready to be archived

Fields:

1. metricName
  • The metric used to determine whether or not the associated data is ready to be archived (Ex: "AgeInDays" or "Status")
2. value
  • The values for the metric that make the associated data ready to be archived (Ex: "30", "Completed", or "Completed, Cancelled, Faulted")

Return to top

BastianServiceIdentifierType

Object

Fields:

1. applicationName
  • the name of the application hosting the service.
2. serviceName
  • the name of the service.
3. serviceUri
  • the Uri of the service.

Return to top

BlockList

Object

The SQL database block list composed of event provider/event name pairs.

Fields:

1. blockListEntries
  • The list of all block list entries in the SQL database block list.

Return to top

BlockListEntry

Object

An object providing details about a single entry in the SQL database block list.

Fields:

1. eventName
  • The event name of an event provider/event name pair of a block list entry.
2. providerName
  • The provider name of an event provider/event name pair of a block list entry.
3. timeStamp
  • The timestamp at which the block list entry was added to the block list.

Return to top

BooleanResponse

Object

The boolean response sent back denoting success or failure.

Fields:

1. isSuccessful

Return to top

CollectionResult

Object

A collection of results indicating success or failure of an operation, each tied to a specified identifier and including an error message for failure

Fields:

1. results
  • The collection of results

Return to top

Container

Object

An arbitrary container which must be handled to fulfill a task. This can be a box, pallet, tote... anything which can be said to contain other materials.

Fields:

1. dimensions
  • The physical dimensions of the container in millimeters where X is Width, Y is Depth, and Z is height.
2. id
  • The id of the container
3. type
  • The type of the container

Return to top

CoordinatePoseTransform

Object

Data model used to configure the coordinate conversion transforms to appy to a pose

Fields:

1. axisSwaps
  • The sequence of axis swaps to perform on the position
2. invertRotation
  • Whether or not to invert the direction of rotation, useful for ensuring the object rotates in the correct direction
3. offset
  • The offset to subtract from the position coordinates, useful for moving the position of the origin
4. pivotOffset
  • The offset of the pivot, useful for ensuring the object rotates around the correct pivot
5. rotationAxisSwaps
  • The sequence of axis swaps to perform on the rotation
6. rotationOffset
  • The offset of the rotation, useful for ensuring the object is looking the correct direction
7. scale
  • The scale to multiply to the position coordinates

Return to top

createMissionResponseType

Object

The payload returned by the TdaProxyServer in response to a CreateMissionRequest

Fields:

1. missionId
  • The id of the newly created mission
2. returnCode
  • The code returned by the TdaProxyServer in response to the request

Return to top

Curve

Object

Details about to traverse the edge.

Fields:

1. circleCenter
  • The center of the circle the arc lies on
2. entryPoint
  • The angle at which all agents begin traversing this edge
3. exitPoint
  • The angle at which all agents will exit this edge traversal
4. isClockwise
  • A boolean for if the traversal is clockwise or not.
5. radius
  • The radius of the arc this curve describes

Return to top

DeadLetter

Object

Represents a message which has repeatedly failed processing. It has been declared dead by its sender - the message must now be dropped or retried manually.

Fields:

1. correlationId
  • A correlation id which can be used to trace a letter or group of letters through the processing pipeline. This may originate from the letter itself.
2. letterCreationTimeStamp
  • A UTC timestamp describing when the letter was originally created for processing.
3. letterId
  • A unique id for the dead letter. This may originate from the letter itself if the letter contains a unique id.
4. letterSenderName
  • The name of the dead letter's sender. This will most likely be the id of a reliable queue processor.
5. payload
  • A payload representing the contents of the letter. This will be used to retry the letter.
6. processingAttempts
  • NonNull
  • Type:
  • The number of processing attempts the letter underwent prior to being added to the dead letter dictionary.
7. processingErrors
  • A list of errors which occurred while attempting to process the letter.

Return to top

DeadLetterConnection

Object

A connection from an object to a list of objects of type DeadLetter.

Fields:

1. edges
  • Information to aid in pagination.
2. items
  • A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for "{ edges { node } }" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the "cursor" field on the edge to enable efficient pagination, this shortcut cannot be used, and the full "{ edges { node } } " version should be used instead.
3. pageInfo
  • Information to aid in pagination.
4. totalCount
  • A count of the total number of objects in this connection, ignoring pagination. This allows a client to fetch the first five objects by passing "5" as the argument to first, then fetch the total count so it could display "5 of 83", for example. In cases where we employ infinite scrolling or don't have an exact count of entries, this field will return null.

Return to top

DeadLetterEdge

Object

An edge in a connection from an object to another object of type DeadLetter.

Fields:

1. cursor
  • A cursor for use in pagination
2. node
  • The item at the end of the edge

Return to top

DeletedService

Object

An archivable service that got unregistered from regular record collection

Fields:

1. scheduleId
2. serviceId

Return to top

Dictionary_Key_AgentTypeAndProfileType_Value_String

Object

GraphQL representation of a dictionary.

Fields:

1. pairs
  • The list of key value pairs.

Return to top

Dictionary_Key_RichKey_Value_String

Object

GraphQL representation of a dictionary.

Fields:

1. pairs
  • The list of key value pairs.

Return to top

Dictionary_Key_String_Value_Boolean

Object

GraphQL representation of a dictionary.

Fields:

1. pairs
  • The list of key value pairs.

Return to top

Dictionary_Key_String_Value_Float

Object

GraphQL representation of a dictionary.

Fields:

1. pairs
  • The list of key value pairs.

Return to top

Dictionary_Key_String_Value_String

Object

GraphQL representation of a dictionary.

Fields:

1. pairs
  • The list of key value pairs.

Return to top

Dictionary_Key_String_Value_TaskBidCustomCost

Object

GraphQL representation of a dictionary.

Fields:

1. pairs
  • The list of key value pairs.

Return to top

Dictionary_Key_String_Value_TaskBidEnrichmentData

Object

GraphQL representation of a dictionary.

Fields:

1. pairs
  • The list of key value pairs.

Return to top

Dictionary_Key_TaskBidRejectionCodeEnum_Value_ListOf_AgentIdAndType

Object

GraphQL representation of a dictionary.

Fields:

1. pairs
  • The list of key value pairs.

Return to top

EdgeResponse

Object

Information about a edge

Fields:

1. weight
  • The weight to traverse an edge, direction is always source node to edge node
2. weight
  • The weight to traverse an edge, direction is always source node to edge node

Return to top

EmulatedActiveTask

Object

The details of an emulated task

Fields:

1. carrierId
  • The id of the agent assigned to the order
2. iKey
  • A unique id of the order
3. orderIndex
  • The id of the order
4. orderPhase
  • The current phase of the order
5. orderStatus
  • The current status of the order
6. transportStructure
  • The type of the transport task

Return to top

EmulatedAgent

Object

The details of an emulated AciCarrier

Fields:

1. aciCarrierData
  • The details of the emulated AciCarrier agent
2. agentHubData
  • The AgentHub details of the emulated agent according to the agent emulator

Return to top

EmulatorConfig

Object

The current configuration of the emulator

Fields:

1. freezeBeforeLoadHandling
  • Used with FreezeDuringPicking or FreezeDuringDropping to test task deletion during the PICKING or DROPPING order phase either before or after the vehicle reaches the point-of-no-return of the pick or drop load handling operation
2. freezeDuringDropping
  • Whether or not the emulator should temporarily freeze during the DROPPING order phase. Used with FreezeBeforeLoadHandling to test task deletion during the DROPPING order phase either before or after the vehicle reaches the point-of-no-return of the drop load handling operation
3. freezeDuringPicking
  • Whether or not the emulator should temporarily freeze during the PICKING order phase. Used with FreezeBeforeLoadHandling to test task deletion during the PICKING order phase either before or after the vehicle reaches the point-of-no-return of the pick load handling operation
4. sendSyncMessages
  • Whether or not the emulator should enable Sync messaging delays in task execution

Return to top

EnrichTaskBidsResponse

Object

Response containing enriched bids and bid rejections from the TaskBidEnricher

Fields:

1. taskBidRejections
  • The collection of bid rejections after enrichment
2. taskBids
  • NonNull
  • Type:
  • The enriched task bids

Return to top

GetLogSummariesResponse

Object

The response sent back from a GetLogSummaries query.

Fields:

1. criticalCount
  • The count of critical events after applying filters.
2. errorCount
  • The count of error events after applying filters.
3. informationalCount
  • The count of informational events after applying filters.
4. logSummaries
  • The list of log summaries retrieved.
5. totalCount
  • The total count of events after applying filters.
6. verboseCount
  • The count of verbose events after applying filters.
7. warningCount
  • The count of warning events after applying filters.

Return to top

getMissionsStatusResponseType

Object

The payload returned by the TdaProxyServer in response to a GetMissionsStatusRequest

Fields:

1. activeMissions
  • The details of every active mission in the TdaProxyServer
2. returnCode
  • The code returned by the TdaProxyServer in response to the request

Return to top

getMissionStatusResponseType

Object

The payload returned by the TdaProxyServer in response to a GetMissionStatusRequest

Fields:

1. mission
  • The details of the specified mission in the TdaProxyServer
2. returnCode
  • The code returned by the TdaProxyServer in response to the request

Return to top

GetTaskAssignmentsResponseType

Object

Fields:

1. taskAssignmentCosts
2. taskBidCosts

Return to top

GetTaskBidsResponse

Object

Response containing the bids and bid rejections for a collection of tasks

Fields:

1. taskBidRejections
  • The collection of bid rejections for the tasks
2. taskBids
  • The collection of bids for the tasks

Return to top

GetTasksByNameResponseType

Object

Fields:

1. foundTasks
  • NonNull
  • Type:
  • A list of all the tasks that were found.
2. missingTasks
  • NonNull
  • Type:
    • List
    • Type:
  • A list of the names of all the tasks that could not be found.

Return to top

getVehiclesStatusResponseType

Object

The payload returned by the TdaProxyServer in response to a GetVehiclesStatusRequest

Fields:

1. returnCode
  • The code returned by the TdaProxyServer in response to the request
2. vehicles
  • The details of every agent registered with the TdaProxyServer

Return to top

InventoryLocation

Object

A location in the Inventory System

Fields:

1. containerDimensions
  • The demensional size of a container if present
2. containerId
  • If the location is occupied, contains the name of the container
3. customProperties
  • Any custom properties required by any specific agent type
4. dimensions
  • The dimensional size of the location
5. isControlled
  • Whether or not Maestro is the system of record for this location. If true, stricter validations are performed during transfer, storage, and reservation operations to ensure the state of the location is valid for the request.
6. locationCoordinate
  • The location coordinates in physical space
7. occupied
  • Whether or not this location is occupied with a container
8. originalString
  • The name of the inventory location
9. reservationId
  • If the location is reserved, the id token associated with that reservation
10. scheme
  • The scheme that this location belongs to
11. type
  • The type of the location

Return to top

InventoryLocationConnection

Object

A connection from an object to a list of objects of type InventoryLocation.

Fields:

1. edges
  • Information to aid in pagination.
2. items
  • A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for "{ edges { node } }" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the "cursor" field on the edge to enable efficient pagination, this shortcut cannot be used, and the full "{ edges { node } } " version should be used instead.
3. pageInfo
  • Information to aid in pagination.
4. totalCount
  • A count of the total number of objects in this connection, ignoring pagination. This allows a client to fetch the first five objects by passing "5" as the argument to first, then fetch the total count so it could display "5 of 83", for example. In cases where we employ infinite scrolling or don't have an exact count of entries, this field will return null.

Return to top

InventoryLocationEdge

Object

An edge in a connection from an object to another object of type InventoryLocation.

Fields:

1. cursor
  • A cursor for use in pagination
2. node
  • The item at the end of the edge

Return to top

KVP_Key_AgentTypeAndProfileType_Value_String

Object

GraphQL representation of a key value pair.

Fields:

1. key
  • The key of the key value pair.
2. value
  • The value associated with the key.

Return to top

KVP_Key_RichKey_Value_String

Object

GraphQL representation of a key value pair.

Fields:

1. key
  • The key of the key value pair.
2. value
  • The value associated with the key.

Return to top

KVP_Key_String_Value_Boolean

Object

GraphQL representation of a key value pair.

Fields:

1. key
  • The key of the key value pair.
2. value
  • The value associated with the key.

Return to top

KVP_Key_String_Value_Float

Object

GraphQL representation of a key value pair.

Fields:

1. key
  • The key of the key value pair.
2. value
  • The value associated with the key.

Return to top

KVP_Key_String_Value_String

Object

GraphQL representation of a key value pair.

Fields:

1. key
  • The key of the key value pair.
2. value
  • The value associated with the key.

Return to top

KVP_Key_String_Value_TaskBidCustomCost

Object

GraphQL representation of a key value pair.

Fields:

1. key
  • The key of the key value pair.
2. value
  • The value associated with the key.

Return to top

KVP_Key_String_Value_TaskBidEnrichmentData

Object

GraphQL representation of a key value pair.

Fields:

1. key
  • The key of the key value pair.
2. value
  • The value associated with the key.

Return to top

KVP_Key_TaskBidRejectionCodeEnum_Value_ListOf_AgentIdAndType

Object

GraphQL representation of a key value pair.

Fields:

1. key
  • The key of the key value pair.
2. value
  • The value associated with the key.

Return to top

LocationScheme

Object

A location in the Inventory System

Fields:

1. description
  • The description of the scheme
2. name
  • The name of the location scheme
3. regex
  • The string that defines the regex for this scheme

Return to top

LogChannel

Object

An object providing details about a single log channel's configuration.

Fields:

1. eventSeverities
  • The event severities that this log channel subscribes to.
2. maxRecordAgeInHours
  • NonNull
  • Type:
  • The max age that logs will persist in the log channel before archiving.
3. name
  • The name of the log channel to configure.
4. providerCriteriaList
  • A list of event providers and associated event names that a log channel subscribes to.

Return to top

LogChannelConfigs

Object

The configurations of all log channels.

Fields:

1. configList
  • The list of log channel configurations.

Return to top

LogEntry

Object

An object providing details about an event log entry.

Fields:

1. agentId
  • The agent id that generated the event, if applicable.
2. keywords
  • NonNull
  • Type:
  • The keywords of an event log entry.
3. level
  • The level of an event log entry.
4. message
  • The message of an event log entry.
5. name
  • The name of an event log entry.
6. payload
  • The payload of an event log entry.
7. providerName
  • The provider name of an event log entry.
8. subsystemEventId
  • If the event originates from a third party system, this field holds the third party system's event ID.
9. subsystemEventName
  • If the event originates from a third party system, this field holds the third party system's event name.
10. timestamp
  • The timestamp of an event log entry.

Return to top

LogEntryConnection

Object

A connection from an object to a list of objects of type LogEntry.

Fields:

1. edges
  • Information to aid in pagination.
2. items
  • A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for "{ edges { node } }" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the "cursor" field on the edge to enable efficient pagination, this shortcut cannot be used, and the full "{ edges { node } } " version should be used instead.
3. pageInfo
  • Information to aid in pagination.
4. totalCount
  • A count of the total number of objects in this connection, ignoring pagination. This allows a client to fetch the first five objects by passing "5" as the argument to first, then fetch the total count so it could display "5 of 83", for example. In cases where we employ infinite scrolling or don't have an exact count of entries, this field will return null.

Return to top

LogEntryEdge

Object

An edge in a connection from an object to another object of type LogEntry.

Fields:

1. cursor
  • A cursor for use in pagination
2. node
  • The item at the end of the edge

Return to top

LogSummary

Object

An object providing details about a single log summary.

Fields:

1. eventCount
  • NonNull
  • Type:
  • The number of log entries returned for this provider and event name.
2. eventName
  • The distince event name of a log summary.
3. providerName
  • The distinct provider name of a log summary.

Return to top

MaestroMapConfiguration

Object

Input type describing a Maestro Map configuration

Fields:

1. taskLocationToMapIdRegexMap

Return to top

MapEdge

Object

Details about an edge in the map node

Fields:

1. blockedNodes
  • NonNull
  • Type:
    • List
    • Type:
  • The list of nodes that traversing this edge blocks (from all submaps)
2. curves
  • The curve object that describes how to traverse the edge to agents
3. distEstimate
  • The estimated distance of the edge
4. edgeId
  • The id of the edge
5. metadata
  • A dictionary of metadata information about this edge.
6. nodeId
  • The id of the node this edge traverses to

Return to top

MapVersionResponse

Object

Fields:

1. id
  • The id of the map file
2. isActive
  • A boolean indicating if this is the current active map (true) or not (false).
3. version
  • The version of the map file

Return to top

mission

Object

The details of a TdaProxy Mission

Fields:

1. machineNumber
  • NonNull
  • Type:
2. missionId
  • NonNull
  • Type:
3. status
  • The current status of the mission
4. taskId
  • NonNull
  • Type:
5. taskStatus
  • The status of the mission's current task
6. wMSAssignmentId

Return to top

MissionChildTask

Object

Provides summary detail about a task executed as part of a mission

Fields:

1. name
  • The name of the child task
2. type
  • The child task's type.

Return to top

MissionTask

Object

A task which aggregates multiple child tasks for sequential execution by a single agent.

Fields:

1. agentId
  • The id of the agent assigned to this task.
2. agentTypeId
  • The id of the agent type of the agent assigned to the task.
3. assignmentStatus
  • Describes if the task has been assigned to an agent or if it is eligible for assignment.
4. creatingUserId
  • The user id who created the task.
5. creationDate
  • The datetime at which this task was created.
6. dispatchDate
  • The datetime in UTC at which the task was dispatched to an agent.
7. dueDate
  • The datetime by which this task must be complete.
8. endDate
  • The datetime in UTC at which this task completed, failed, or was cancelled
9. endingUserId
  • The user id who ended the task.
10. endReason
  • The reason a task was ended.
11. executionStatus
  • Describes the execution status of the task. This encompasses whether or not the assigned agent has started the task, if the task has been completed, or if the task has failed for some reason.
12. id
  • The id of the task.
13. missionName
  • If this task belongs to a mission, this field contains the mission's name. If only the mission name is needed, this is a less expensive alternative to querying the mission task field.
14. missionTask
  • If this task belongs to a mission, this field contains the details about the mission task.
15. name
  • The name of the task.
16. onHold
  • If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
17. predecessorTasks
  • The set of tasks which must be completed before this task can execute. This field is not yet implemented.
18. priority
  • NonNull
  • Type:
  • The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority. Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
19. repairStatus
  • If this task faulted and is repairable, describes the execution status of the repair task.
20. repairType
  • If this task faulted and is repairable, describes the type of repair used.
21. requiredAgentId
  • Optional. Specifies an agent that MUST be assigned to this task.
22. taskCriteriaPayload
  • Contains data required to generate work for the mission task.
23. taskDuration
  • The amount of time in milliseconds it took to complete the task.
24. taskGroup
  • The task group this task belongs to.
25. taskGroupName
  • The name of the task group this task belongs to.
26. taskInstructionPayload
  • Summarizes additional details about the child tasks on this mission. Available once task is eligible for execution.
27. taskType
  • The task type of the task.

Return to top

MissionTaskCriteriaPayload

Object

Criteria for a task which combines a set of child tasks for sequential execution by a single agent

Fields:

1. taskNames
  • NonNull
  • Type:
    • List
    • Type:
  • The names of tasks to execute as part of the mission. The tasks will be executed in the order they are defined. The tasks may or may not exist at the time of the mission's creation. The mission, however, will not be eligible for assignment until all its tasks exist.

Return to top

MissionTaskInstructionPayload

Object

Instructions for a task which combines a set of child tasks for sequential execution by a single agent

Fields:

1. childTasks
  • Summarizes the child tasks belonging to this mission
2. taskTypes
  • NonNull
  • Type:
    • List
    • Type:
  • Lists the distinct set of task types which appear in this mission

Return to top

NamedResult

Object

A result indicating success or failure of an operation, tied to a specified identifier, including an error message for failure

Fields:

1. error
  • The error message, if this result failed
2. id
  • The id of the result
3. isSuccess
  • Indicates whether or not the result is successful

Return to top

NodeResponse

Object

Node information for a node on the graph

Fields:

1. actions
  • The string names of the actions that can be performed at this node if any
2. agentProfiles
  • NonNull
  • Type:
    • List
    • Type:
  • The Agent Profile(s) that this node exits in.
3. agentTypes
  • NonNull
  • Type:
    • List
    • Type:
  • The agent type(s) string that this node belongs to
4. edges
  • The edges that this node connects to
5. label
  • A helpful string to describe the purpose a node serves.
6. location
  • The Vector3 point that describes this nodes cartesian position.
7. locationIds
  • The WMS/WCS Location id's this node is attached to (if available).
8. nodeId
  • The id used within the system (this is not related to inventory or location id's)
9. type
  • A string that determines the type of a node. 'Shared' means that the node exists in several graphs, and is usually tied to a location or physical resource. 'Node' indicated it is a standard node and should have a unique id
10. zones
  • The zones this node appears in (if any)

Return to top

NodeResponseConnection

Object

A connection from an object to a list of objects of type NodeResponse.

Fields:

1. edges
  • Information to aid in pagination.
2. items
  • A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for "{ edges { node } }" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the "cursor" field on the edge to enable efficient pagination, this shortcut cannot be used, and the full "{ edges { node } } " version should be used instead.
3. pageInfo
  • Information to aid in pagination.
4. totalCount
  • A count of the total number of objects in this connection, ignoring pagination. This allows a client to fetch the first five objects by passing "5" as the argument to first, then fetch the total count so it could display "5 of 83", for example. In cases where we employ infinite scrolling or don't have an exact count of entries, this field will return null.

Return to top

NodeResponseEdge

Object

An edge in a connection from an object to another object of type NodeResponse.

Fields:

1. cursor
  • A cursor for use in pagination
2. node
  • The item at the end of the edge

Return to top

PageInfo

Object

Information about pagination in a connection.

Fields:

1. endCursor
  • When paginating forwards, the cursor to continue.
2. hasNextPage
  • When paginating forwards, are there more items?
3. hasPreviousPage
  • When paginating backwards, are there more items?
4. startCursor
  • When paginating backwards, the cursor to continue.

Return to top

PalletPickTask

Object

A task which removes a pallet from a location.

Fields:

1. agentId
  • The id of the agent assigned to this task.
2. agentTypeId
  • The id of the agent type of the agent assigned to the task.
3. assignmentStatus
  • Describes if the task has been assigned to an agent or if it is eligible for assignment.
4. creatingUserId
  • The user id who created the task.
5. creationDate
  • The datetime at which this task was created.
6. dispatchDate
  • The datetime in UTC at which the task was dispatched to an agent.
7. dueDate
  • The datetime by which this task must be complete.
8. endDate
  • The datetime in UTC at which this task completed, failed, or was cancelled
9. endingUserId
  • The user id who ended the task.
10. endReason
  • The reason a task was ended.
11. executionStatus
  • Describes the execution status of the task. This encompasses whether or not the assigned agent has started the task, if the task has been completed, or if the task has failed for some reason.
12. id
  • The id of the task.
13. missionName
  • If this task belongs to a mission, this field contains the mission's name. If only the mission name is needed, this is a less expensive alternative to querying the mission task field.
14. missionTask
  • If this task belongs to a mission, this field contains the details about the mission task.
15. name
  • The name of the task.
16. onHold
  • If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
17. predecessorTasks
  • The set of tasks which must be completed before this task can execute. This field is not yet implemented.
18. priority
  • NonNull
  • Type:
  • The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority. Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
19. repairStatus
  • If this task faulted and is repairable, describes the execution status of the repair task.
20. repairType
  • If this task faulted and is repairable, describes the type of repair used.
21. requiredAgentId
  • Optional. Specifies an agent that MUST be assigned to this task.
22. taskCriteriaPayload
  • Contains data required to generate work for the pallet pick task.
23. taskDuration
  • The amount of time in milliseconds it took to complete the task.
24. taskGroup
  • The task group this task belongs to.
25. taskGroupName
  • The name of the task group this task belongs to.
26. taskInstructionPayload
  • Contains concrete details about how the pallet pick task should be executed. Generated close to when the task is executed.
27. taskType
  • The task type of the task.

Return to top

PalletPickTaskCriteraPayload

Object

Criteria for a task which removes a full pallet from a location.

Fields:

1. locationId
  • The id of the location hosting the pallet.

Return to top

PalletPickTaskInstructionPayload

Object

Final instructions for a task which removes a full pallet from a location.

Fields:

1. locationId
  • The id of the location hosting the pallet.

Return to top

PalletPlaceTask

Object

A task which places a pallet at a location.

Fields:

1. agentId
  • The id of the agent assigned to this task.
2. agentTypeId
  • The id of the agent type of the agent assigned to the task.
3. assignmentStatus
  • Describes if the task has been assigned to an agent or if it is eligible for assignment.
4. creatingUserId
  • The user id who created the task.
5. creationDate
  • The datetime at which this task was created.
6. dispatchDate
  • The datetime in UTC at which the task was dispatched to an agent.
7. dueDate
  • The datetime by which this task must be complete.
8. endDate
  • The datetime in UTC at which this task completed, failed, or was cancelled
9. endingUserId
  • The user id who ended the task.
10. endReason
  • The reason a task was ended.
11. executionStatus
  • Describes the execution status of the task. This encompasses whether or not the assigned agent has started the task, if the task has been completed, or if the task has failed for some reason.
12. id
  • The id of the task.
13. missionName
  • If this task belongs to a mission, this field contains the mission's name. If only the mission name is needed, this is a less expensive alternative to querying the mission task field.
14. missionTask
  • If this task belongs to a mission, this field contains the details about the mission task.
15. name
  • The name of the task.
16. onHold
  • If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
17. predecessorTasks
  • The set of tasks which must be completed before this task can execute. This field is not yet implemented.
18. priority
  • NonNull
  • Type:
  • The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority. Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
19. repairStatus
  • If this task faulted and is repairable, describes the execution status of the repair task.
20. repairType
  • If this task faulted and is repairable, describes the type of repair used.
21. requiredAgentId
  • Optional. Specifies an agent that MUST be assigned to this task.
22. taskCriteriaPayload
  • Contains data required to generate work for the pallet place task.
23. taskDuration
  • The amount of time in milliseconds it took to complete the task.
24. taskGroup
  • The task group this task belongs to.
25. taskGroupName
  • The name of the task group this task belongs to.
26. taskInstructionPayload
  • Contains concrete details about how the pallet place task should be executed. Generated close to when the task is executed.
27. taskType
  • The task type of the task.

Return to top

PalletPlaceTaskCriteraPayload

Object

Criteria for a task which places a full pallet at a location.

Fields:

1. locationId
  • The id of the location to place the pallet at.

Return to top

PalletPlaceTaskInstructionPayload

Object

Final instructions for a task which places a full pallet at a location.

Fields:

1. locationId
  • The id of the location to place the pallet at.

Return to top

Payload

Object

The payload contained in the specified log.

Fields:

1. key
  • The key of the payload.
2. value
  • The value of the payload.

Return to top

PayloadPosition

Object

Information about a payload position on an Agent.

Fields:

1. id
  • The id of the payload position
2. payload
  • Null when empty, the payload currently stored at the payload position
3. taskGroupName
  • The name of the group of the task that most recently interacted with this payload position
4. taskName
  • The name of the task that most recently interacted with this payload position

Return to top

PayloadPositionType

Object

Describes a single payload position type that can be configured for an AgentType

Fields:

1. id
  • The unique id of the payload position type

Return to top

ProcessingError

Object

Represents an error which occurred while attempting to process a message

Fields:

1. attemptIndex
  • NonNull
  • Type:
  • The index of the processing attempt which produced this error.
2. error
  • Description of the error encountered while processing the message.
3. timeStamp
  • UTC time stamp reflecting when the processing error occurred.

Return to top

ProductPickTask

Object

A task which removes some amount of individual product from a container.

Fields:

1. agentId
  • The id of the agent assigned to this task.
2. agentTypeId
  • The id of the agent type of the agent assigned to the task.
3. assignmentStatus
  • Describes if the task has been assigned to an agent or if it is eligible for assignment.
4. creatingUserId
  • The user id who created the task.
5. creationDate
  • The datetime at which this task was created.
6. dispatchDate
  • The datetime in UTC at which the task was dispatched to an agent.
7. dueDate
  • The datetime by which this task must be complete.
8. endDate
  • The datetime in UTC at which this task completed, failed, or was cancelled
9. endingUserId
  • The user id who ended the task.
10. endReason
  • The reason a task was ended.
11. executionStatus
  • Describes the execution status of the task. This encompasses whether or not the assigned agent has started the task, if the task has been completed, or if the task has failed for some reason.
12. id
  • The id of the task.
13. missionName
  • If this task belongs to a mission, this field contains the mission's name. If only the mission name is needed, this is a less expensive alternative to querying the mission task field.
14. missionTask
  • If this task belongs to a mission, this field contains the details about the mission task.
15. name
  • The name of the task.
16. onHold
  • If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
17. predecessorTasks
  • The set of tasks which must be completed before this task can execute. This field is not yet implemented.
18. priority
  • NonNull
  • Type:
  • The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority. Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
19. repairStatus
  • If this task faulted and is repairable, describes the execution status of the repair task.
20. repairType
  • If this task faulted and is repairable, describes the type of repair used.
21. requiredAgentId
  • Optional. Specifies an agent that MUST be assigned to this task.
22. taskCriteriaPayload
  • Contains data required to generate work for the product pick task.
23. taskDuration
  • The amount of time in milliseconds it took to complete the task.
24. taskGroup
  • The task group this task belongs to.
25. taskGroupName
  • The name of the task group this task belongs to.
26. taskInstructionPayload
  • Contains concrete details about how the product pick task should be executed. Generated close to when the task is executed.
27. taskType
  • The task type of the task.

Return to top

ProductPickTaskCriteraPayload

Object

Criteria for a task which removes some amount of individual product from a container.

Fields:

1. locationId
  • The id of the location hosting the container which holds the product.
2. quantity
  • The amount of product to pick.

Return to top

ProductPickTaskInstructionPayload

Object

Final instructions for a task which removes some amount of individual product from a container.

Fields:

1. locationId
  • The id of the location hosting the container which holds the product.
2. quantity
  • The amount of product to pick.

Return to top

ProviderCriteria

Object

The event providers and specific events from them that are subscribed to by a log channel.

Fields:

1. eventNames
  • The list of event names from the specified provider that a log channel subscribes to. An emptylist signifies subscribing to all events from the provider.
2. providerName
  • An event provider name that a log channel subscribes to.

Return to top

QueueProcessor

Object

Representation of a reliable queue processor running in the current service

Fields:

1. faults
  • Recent faults which stopped the queue from running
2. id
  • Uniquely identifies the queue.
3. isPaused
  • Indicates whether or not the queue is temporarily paused and not processing items.
4. isRunning
  • Indicates whether or not the queue has completed startup and is running normally. This will be true after startup and will remain true until the run loop shuts down, even when the queue is paused.
5. itemCount
  • NonNull
  • Type:
  • Gets the number of items currently in the queue
6. itemTypeFullName
  • The full, assembly qualified name of the .NET type processed by the queue
7. itemTypeName
  • The unqualified type name of the .NET type processed by the queue
8. lastDequeue
  • The UTC time of the last successful dequeue from the queue.
9. lastEnqueue
  • The UTC time of the last successful enqueue to the queue queue.
10. lastRun
  • The UTC time of the last run of the queue's loop.
11. lastStartup
  • The UTC time of the queue's last startup.
12. processingErrors
  • Recent errors which prevented an item in the queue from being processed, but which did not stop the queue

Return to top

QueueProcessorFault

Object

Represents a fault which stopped a reliable queue processor from running

Fields:

1. message
  • Description of the error which stopped the queue
2. timeStamp
  • The UTC datetime at which the fault occurred

Return to top

QueueProcessorOfIAciEmulatorStatelessService

Object

Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Fields:

1. getQueueProcessors

  • Gets descriptive models of the queue processors hosted in the service targeted by the parent graph type.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. getReliableQueueProcessorConfig
  • Get the current configuration for this service's reliable queue processors

Return to top

QueueProcessorOfIAciStatelessService

Object

Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Fields:

1. getQueueProcessors

  • Gets descriptive models of the queue processors hosted in the service targeted by the parent graph type.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. getReliableQueueProcessorConfig
  • Get the current configuration for this service's reliable queue processors

Return to top

QueueProcessorOfIAgentHubWebService

Object

Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Fields:

1. getQueueProcessors

  • Gets descriptive models of the queue processors hosted in the service targeted by the parent graph type.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. getReliableQueueProcessorConfig
  • Get the current configuration for this service's reliable queue processors

Return to top

QueueProcessorOfISeegridEmulatorStatelessService

Object

Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Fields:

1. getQueueProcessors

  • Gets descriptive models of the queue processors hosted in the service targeted by the parent graph type.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. getReliableQueueProcessorConfig
  • Get the current configuration for this service's reliable queue processors

Return to top

QueueProcessorOfISeegridStatelessService

Object

Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Fields:

1. getQueueProcessors

  • Gets descriptive models of the queue processors hosted in the service targeted by the parent graph type.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. getReliableQueueProcessorConfig
  • Get the current configuration for this service's reliable queue processors

Return to top

QueueProcessorOfITaskAssignmentWebService

Object

Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Fields:

1. getQueueProcessors

  • Gets descriptive models of the queue processors hosted in the service targeted by the parent graph type.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. getReliableQueueProcessorConfig
  • Get the current configuration for this service's reliable queue processors

Return to top

QueueProcessorOfITdaProxyCommunicatorWebService

Object

Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Fields:

1. getQueueProcessors

  • Gets descriptive models of the queue processors hosted in the service targeted by the parent graph type.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. getReliableQueueProcessorConfig
  • Get the current configuration for this service's reliable queue processors

Return to top

QueueProcessorOfITdaProxyEmulatorWebService

Object

Defines operations for getting information about reliable queue processors hosted in the service targeted by the parent graph type

Fields:

1. getQueueProcessors

  • Gets descriptive models of the queue processors hosted in the service targeted by the parent graph type.

  • Arguments:

Name Description Type
millisecondsTimeout The maximum time to wait, in milliseconds, before failing the operation with a timeout
  • NonNull
  • Type:
2. getReliableQueueProcessorConfig
  • Get the current configuration for this service's reliable queue processors

Return to top

ReliableQueueProcessorConfig

Object

Configuration used to control the operation of the reliable queue processors

Fields:

1. deadLetterDeletionBatchSize
  • NonNull
  • Type:
  • The number of dead letters to attempt to delete per batch of the deletion run loop
2. deadLetterExpirationTimeDays
  • NonNull
  • Type:
  • The number of days a letter should stay in the dead letter queue before expiring
3. errorDataDeletionLoopDelayMinutes
  • NonNull
  • Type:
  • The minimum number of minutes to delay between each attempt to trim excess error data
4. errorDataDeletionLoopTimeoutSeconds
  • NonNull
  • Type:
  • The number of seconds to attempt to trim excess error data before the operation should timeout
5. maxNumDeadLettersPerCollection
  • NonNull
  • Type:
  • The maximum number of dead letters that should exist in each dead letter collection

Return to top

RemoveTaskGroupsResponse

Object

Contains a response to removing task groups containing task groups that were deleted, and those that were not deleted.

Fields:

1. deletedTaskGroups
  • The task groups that were successfully removed
2. undeletedTaskGroups
  • The task groups that were unable to be removed

Return to top

Reservation

Object

A reservation id and the nodes associated with it

Fields:

1. reservationId
  • The id of the reservation
2. reservedNodes
  • The nodes associated with the reservation id

Return to top

ReserveLocationResponse

Object

The response from the ReserveLocation mutation, containing the name of the reserved location and the associated reservation token

Fields:

1. locationName
  • The name of the inventory location that was reserved
2. reservationTokenId
  • NonNull
  • Type:
  • The id token associated with this reservation, required when storing a container in the location or unreserving the location

Return to top

Result

Object

A result indicating success or failure of an operation, including an error message for failures

Fields:

1. error
  • The error message, if the result indicates failure
2. isSuccess
  • Indicates whether or not the result is successful

Return to top

Result_ActiveRouteObject

Object

A result indicating success or failure of an operation, including a value for success and an error message for failure

Fields:

1. error
  • The error message, if the result indicates failure
2. isSuccess
  • Indicates whether or not the result is successful
3. value
  • The value returned, if the result indicates success

Return to top

Result_ListOf_ActiveRouteObject

Object

A result indicating success or failure of an operation, including a value for success and an error message for failure

Fields:

1. error
  • The error message, if the result indicates failure
2. isSuccess
  • Indicates whether or not the result is successful
3. value
  • The value returned, if the result indicates success

Return to top

Result_StartRouteResponse

Object

A result indicating success or failure of an operation, including a value for success and an error message for failure

Fields:

1. error
  • The error message, if the result indicates failure
2. isSuccess
  • Indicates whether or not the result is successful
3. value
  • The value returned, if the result indicates success

Return to top

Result_UpdateRouteReservationResponse

Object

A result indicating success or failure of an operation, including a value for success and an error message for failure

Fields:

1. error
  • The error message, if the result indicates failure
2. isSuccess
  • Indicates whether or not the result is successful
3. value
  • The value returned, if the result indicates success

Return to top

RichKey

Object

GraphQL representation of a Rich Key

Fields:

1. name
  • The name of the Rich Key.
2. section
  • The sections of the Rich Key.
3. tags
  • The dictionary of tags of the Rich Key.
4. type
  • The type of the Rich Key.

Return to top

RouteSegment

Object

Details about a segment of a route

Fields:

1. edge
  • Edge id of the edge within the segment
2. nodeId
  • Node id of the node within the segment

Return to top

RouteSummary

Object

Details about a route

Fields:

1. routeCost
  • The cost of traversing the route
2. routeDistance
  • The distance in meters of the route
3. segments
  • The list of route segments to traverse

Return to top

StartRouteResponse

Object

The Route ID and route that are assigned to a provided agent

Fields:

1. route
  • The route summary of the route plan
2. routeId
  • The unique ID assigned to specific route plan

Return to top

Switch

Object

The properties of a switch registered in the Seegrid Emulator service

Fields:

1. name
  • The name of the switch
2. state
  • The state of the switch

Return to top

TaskAssignmentConfig

Object

Defines a task assignment configuration

Fields:

1. priorityComponentWeights
  • The weights of the components for task priority
2. runLoopMonitorMaxRecords
  • The maximum amount of records to save from a run loop
3. taskAssignmentRunLoopDelayInMilliseconds
  • An optional setting to specify the task assignment run loop delay in milliseconds.
4. taskBatchConfiguration
  • The configuration related to task batching
5. taskBidCostComponentWeights
  • The weights of the components for task bidding
6. taskBidEnrichers
  • The services capable of enriching task bids
7. taskExpirationTimeSpan
  • An Optional setting that will auto cancel any task after the set timespan for archive. Format is HH:MM:SS
8. taskTypes
  • The configuration related to the unique task types

Return to top

TaskAssignmentCostType

Object

Fields:

1. agentId
2. cost
3. taskAssignmentProcessingId
4. taskBidId
5. taskBidId

Return to top

TaskAssignmentRunLoopMetrics

Object

Metrics pertaining to a Task Assignment run loop

Fields:

1. assignments
  • The ids of the tasks that were assigned
2. assignmentsFailed
  • The tasks that failed to assign
3. endTime
  • The time that the run ended.
4. error
  • The error that ended the run loop, if one occured.
5. exception
  • The exception that ended the run loop, if one occured.
6. numRunsWithoutBidOrBidRejection
  • The number of run loops that have occured since receiving a bid or bid rejection
7. runLoopDurationMilliseconds
  • The amount of time in milliseconds that the run loop took.
8. startTime
  • The time that the run started.
9. taskAssignmentRunId
  • The id of the run that these metrics correspond to.
10. taskBidCosts
  • The task bid costs included in this run.
11. taskBidRejections
  • The task bid rejections returned by the agent services during the run.
12. taskBidRejectionsCount
  • The number of task bid rejections returned by the agent services during the run.
13. taskBidRequests
  • The task bid requests that were included in the run.
14. taskBidRequestsCount
  • The number of task bid requests that were included in the run.
15. taskBids
  • All of the task bids returned by the agent services during the run.
16. taskBidsCount
  • The number of task bids returned by the agent services during the run.
17. taskCommissionAcceptances
  • All of the task commission acceptances returned by the agent services during the run.
18. taskCommissionAcceptancesCount
  • The number of task commission acceptances returned by the agent services during the run.
19. taskCommissionRejections
  • All of the task commission rejections returned by the agent services during the run.
20. taskCommissionRejectionsCount
  • The number of task commission rejections returned by the agent services during the run.
21. taskCommissions
  • All of the tasks that were attempted to be commissioned during the run.
22. taskCommissionsCount
  • The number of tasks that were attempted to be commissioned during the run.

Return to top

TaskBatchConfiguration

Object

Defines the task batch portion of task assignment configuration

Fields:

1. batchOperationIntervalInMilliseconds
  • NonNull
  • Type:
  • The duration, in milliseconds, between batch operations
2. criteria
  • Array of all of the defined batching criteria

Return to top

TaskBatchCriteria

Object

Defines a single task assignment batching criteria

Fields:

1. expectedAgentTypeIds
  • The agent types capable of of completing tasks under this batch criteria
2. name
  • The name of the batch criteria
3. taskTypes
  • The types of tasks that are covered by this batch criteria

Return to top

TaskBid

Object

Descriptions of a task bid.

Fields:

1. customCosts
  • Additional unweighted cost data attached to the bid
2. distanceToTaskInMeters
  • The agent's distance from the task's starting location in meters.
3. enrichmentData
  • Additional data attached to the bid
4. estimatedTimeToTaskCompletion
  • The time span from now until the proposed agent will complete the task under ideal conditions.
5. estimatedTimeToTaskStart
  • The time span from now until the proposed agent can start the task.
6. proposedAgentId
  • The id of the agent who would handle the task.
7. proposedAgentTypeId
  • The id of the agent type of the agent who would handle the task.
8. task
  • The task bid to bid on.
9. taskAssignmentProcessingId
  • A unique id used to track a task's attempted assignment throughout the task assignment lifecycle.
10. taskBidId
  • A unique id for the task bid.
11. taskBidPayload
  • A payload of optional, arbitrary JSON describing additional information about the task provider's bid.

Return to top

TaskBidCostComponentWeights

Object

Defines Task bid cost component weights

Fields:

1. assignedTaskComponent
  • The weight of the assigned task component
2. commissionAttemptComponent
  • The weight of the commission attempt component
3. creationDateComponent
  • The weight of the creation date component
4. distanceComponent
  • The weight of the distance component
5. dueDateComponent
  • The weight of the due date component
6. priorityComponent
  • The weight of the priority component

Return to top

TaskBidCostType

Object

Fields:

1. agentId
2. componentBatches
3. cost
4. taskAssignmentProcessingId
5. taskBidId
6. taskId
7. taskName

Return to top

TaskBidCustomCost

Object

Defines a custom cost attached to a task bid

Fields:

1. cost
  • The unweighted value of the custom cost
2. name
  • The name of the custom cost

Return to top

TaskBidEnricherOfIMapStatelessService

Object

Defines queries on TaskBidEnrichers hosted in the service targeted by the parent mutation

Fields:

1. enrichTaskBids

  • Integration testing endpoint used to get enriched task bids from the service

  • Arguments:

Name Description Type
input The command used to request the enrichment of task bids

Return to top

TaskBidEnricherType

Object

Defines the properties of a services capable of enriching task bids

Fields:

1. applicationName
  • The name of the ServiceFabric Application containing the service that hosts the remoting endpoint
2. customCostWeights
  • The collection mapping the name of an enricher's custom cost to the configurable weight of that cost
3. serviceName
  • The name of the singleton partitioned ServiceFabric service hosting the remoting endpoint

Return to top

TaskBidEnrichmentData

Object

Defines custom data attached to the task bid

Fields:

1. data
  • The custom task bid data
2. name
  • The name of the custom task bid data

Return to top

TaskBidMetrics

Object

Metrics used to monitor and optimize task bidding

Fields:

1. biddingAgents
  • The list of agents that bid on the task.
2. biddingAgentsCount
  • The number of agents that bid on the task.
3. incorrectAgentTypes
  • NonNull
  • Type:
    • List
    • Type:
  • The list of agent types that reported that their service will never be able to handle the task.
4. lastTaskAssignmentRunId
  • The id of the last run loop in which these metrics were updated.
5. numBidRejections
  • NonNull
  • Type:
  • The number of bid rejections that have been returned for the task.
6. numBids
  • NonNull
  • Type:
  • The number of bids that have been returned for the task.
7. numRunLoops
  • NonNull
  • Type:
  • The number of run loops where the task was sent out for bid requests.
8. numRunLoopsWithoutAcceptance
  • NonNull
  • Type:
  • The number of run loops where the task was sent out for bid requests and only received rejections.
9. rejectionReasons
  • The map of each rejection code to the list of agents that reported that code.
10. taskId
  • The id of the task to which these metrics relate.
11. taskNameAndGroup
  • The details of the task to which these metrics relate.
12. timestamp
  • The time that these metrics were last updated.

Return to top

TaskBidRejection

Object

Describes a location at which some portion of a task must be completed

Fields:

1. agentId
  • The id of the agent who rejected the task bid, if it was related to a single agent
2. agentTypeIds
  • The ids of the agent types who rejected the task bid
3. faultTaskReason
  • If the task should be faulted, the reason why
4. rejectingApplication
  • The name of the application that created this rejection
5. rejectingService
  • The name of the service that created this rejection
6. rejectionCode
  • The code for the rejection which the task assignment service understands.
7. rejectionReason
  • An optional description of the rejection.
8. taskAssignmentProcessingId
  • A unique id to track a task's attempted assignment throughout the assignment lifecycle.
9. taskGroupName
  • The name of the TaskGroup of the rejected task
10. taskId
  • The id of the rejected task
11. taskName
  • The name of the rejected task

Return to top

TaskBidRequest

Object

Represents a request from the task assignment service to a task executer to make a bid on a task.

Fields:

1. task
  • The task to bid on.
2. taskAssignmentProcessingId
  • An id to track the task's attempted assignment throughout the task assignment lifecycle.

Return to top

TaskCommission

Object

Represents an attempt to commit an agent to a task. This message is sent from task assignment to a task executer.

Fields:

1. agentId
  • The id of the agent who should execute the task.
2. proposedAgentTypeId
  • The id of the agent type that should be excuting the task.
3. task
  • The task which is being committed to an agent.
4. taskAssignmentProcessingId
  • A unique id used to track a task's attempted assignment throughout the assignment lifecycle.
5. taskBidId
  • The task bid id which resulted in this commission.
6. taskCommissionId
  • A unique identifier for the task commission.

Return to top

TaskCommissionAcceptance

Object

Represents the acceptance of a task commission from the task assignment service by a task executer

Fields:

1. agentId
  • The id of the agent committed to the task.
2. identifier
  • The identifier of the entity that accepted the task commission.
3. taskAssignmentProcessingId
  • A unique id used to track a task's attempted assignment throughout the assignment lifecycle
4. taskGroupName
  • The name of the task group the commited task belongs to.
5. taskName
  • The name of the task which was committed.

Return to top

TaskCommissionRejection

Object

Represents a task commission which was rejected by a task executer.

Fields:

1. agentId
  • The id of the agent which was expected to commit to the task.
2. agentTypeId
  • The id of the agent type of the agent which was expected to commit to the task.
3. identifier
  • The identifier of the entity that rejected the task commission.
4. rejectionCode
  • A rejection code describing why the commission was rejected which the task assignment service understands.
5. rejectionReason
  • A description for why the commission was rejected.
6. taskAssignmentProcessingId
  • A unique id used to track a task's attempted assignment throughout the assignment lifecycle.
7. taskGroupName
  • The name of the task group the rejected task belongs to.
8. taskName
  • The name of the task whose commission was rejected.

Return to top

TaskCostComponentBatchMetricsModelType

Object

Fields:

1. name
  • The name of the Task Cost Component
2. unweightedCost
  • The unweighted cost of this component, as calculated by GetNormalizedCost
3. weight
  • The weight of this component

Return to top

TaskExecutionErrorType

Object

An error that can be attached to a specific agent. When an emulated agent has a task execution error, the emulator pauses that agent's task execution and reports the associated error codes

Fields:

1. agentId
  • The Id of the agent that has the task execution error
2. errorHostActionCode
  • The code used to specify whether the error is related to a Raymond or Kollmorgen carrier error
3. errorHostActionCodeValue
  • The code used to specify whether the error is related to a Raymond or Kollmorgen carrier error
4. kollmorgenCarrierErrorCode
  • The exact Kollmorgen error code when the ErrorHostActionCode indicates a Kollmorgen carrier error
5. kollmorgenCarrierErrorCodeValue
  • The exact Kollmorgen error code when the ErrorHostActionCode indicates a Kollmorgen carrier error
6. raymondCarrierErrorCode
  • The exact Raymond error code when the ErrorHostActionCode indicates a Raymond carrier error
7. raymondCarrierErrorCodeValue
  • The exact Raymond error code when the ErrorHostActionCode indicates a Raymond carrier error

Return to top

TaskGroup

Object

A group of tasks to complete. The meaning of the grouping is specific to the client.

Fields:

1. dateCreated
  • The UTC date the task group was created.
2. id
  • The id of the task group. This must be globally unique.
3. name
  • The name of the task group.
4. taskGroupMetrics
  • Metrics tracked about the task group
5. taskGroupState
  • The current state of the task group.
6. tasks
  • The set of tasks to complete for this group.

Return to top

TaskGroupMetrics

Object

Metrics pertaining to a Task Group

Fields:

1. numberOfAssignedTasks
  • NonNull
  • Type:
  • The number of assigned tasks in a task group.
2. numberOfCancelledTasks
  • NonNull
  • Type:
  • The number of cancelled tasks in a task group.
3. numberOfCompletedTasks
  • NonNull
  • Type:
  • The number of completed tasks in a task group.
4. numberOfDispatchedTasks
  • NonNull
  • Type:
  • The number of dispatched tasks in a task group.
5. numberOfFaultedTasks
  • NonNull
  • Type:
  • The number of faulted tasks in a task group.
6. numberOfTasks
  • NonNull
  • Type:
  • The number of tasks in a task group.

Return to top

TaskInterfaceConnection

Object

A connection from an object to a list of objects of type TaskInterface.

Fields:

1. edges
  • Information to aid in pagination.
2. items
  • A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for "{ edges { node } }" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the "cursor" field on the edge to enable efficient pagination, this shortcut cannot be used, and the full "{ edges { node } } " version should be used instead.
3. pageInfo
  • Information to aid in pagination.
4. totalCount
  • A count of the total number of objects in this connection, ignoring pagination. This allows a client to fetch the first five objects by passing "5" as the argument to first, then fetch the total count so it could display "5 of 83", for example. In cases where we employ infinite scrolling or don't have an exact count of entries, this field will return null.

Return to top

TaskInterfaceEdge

Object

An edge in a connection from an object to another object of type TaskInterface.

Fields:

1. cursor
  • A cursor for use in pagination
2. node
  • The item at the end of the edge

Return to top

TaskNameAndGroup

Object

Pair of a task name with its associated task group and other high level information.

Fields:

1. agentId
  • The Id of the agent that the task is assigned to
2. taskGroupName
  • The name of the group that the task belongs to.
3. taskName
  • The name of the task.

Return to top

TaskPriorityComponentWeights

Object

Defines Task priority cost component weights

Fields:

1. orderCreationDateWeight
  • The weight of the order creation date component
2. orderDueDateWeight
  • The weight of the order due date component
3. orderNumRunLoopsUnnacceptedWeight
  • The weight of the number of unnaccepted run loops component
4. orderPriorityWeight
  • The weight of the order priority component

Return to top

TaskTransformConfig

Object

The configuration for task transformation for one or more task types

Fields:

1. isEnabled
  • Whether or not task transformation is enabled for tasks of the types. If enabled, TaskAssignment will attempt to communicate with a custom Maestro task transform service during task creation, using a URI based on the TaskType

Return to top

TaskTypeConfig

Object

The configuration for one or more types of tasks

Fields:

1. aliasConfig
  • The configuration for how tasks of the type should be aliased
2. names
  • The names of the types of the tasks that this configuration applies to
3. taskTransformConfig
  • The configuration for how tasks of the type should go through task transformation

Return to top

TaskUpdateSubscriber

Object

A subscriber to task updates

Fields:

1. endpoint
  • The endpoint address that the subscriber listens on.
2. subscriberName
  • The name of the subscriber
3. taskTypes
  • NonNull
  • Type:
    • List
    • Type:
  • The list of task types that the subscriber is subscribed to

Return to top

TdaProxyAgent

Object

The data of a TdaProxy Agent

Fields:

1. agentTypeId
  • The id of the type of the agent
2. currentAisle
  • The aisle that the vehicle most recently reported being in.
3. forkDirection
  • The direction of the agent's forks
4. lastLeftPalletPosition
  • The position of the pallet on the left side. Empty if vehicle is not in any aisle
5. lastPositionAtLeftPalletPosition
  • Whether or not the agent is still located at the reported position on left side
6. lastPositionAtRightPalletPosition
  • Whether or not the agent is still located at the reported position on right side
7. lastRightPalletPosition
  • The position of the pallet on the right side. Empty if vehicle is not in any aisle
8. machineNumber
  • NonNull
  • Type:
  • The id of the agent
9. missionId
  • NonNull
  • Type:
  • The id of the current mission. 0 if none
10. status
  • The current status of the agent
11. warehouse
  • The name of the warehouse
12. wMSAssignmentID
  • The WMS system's Id of the agent's current mission. Empty if none

Return to top

TdaProxyAgentExtended

Object

The data of a TdaProxy Agent extended with custom information from Maestro's TdaProxy Communicator service

Fields:

1. agentTypeId
  • The id of the type of the agent
2. cachedLocationId
3. cachedLocationTime
4. cacheSet
5. currentAisle
  • The aisle that the vehicle most recently reported being in.
6. forkDirection
  • The direction of the agent's forks
7. lastLeftPalletPosition
  • The position of the pallet on the left side. Empty if vehicle is not in any aisle
8. lastPositionAtLeftPalletPosition
  • Whether or not the agent is still located at the reported position on left side
9. lastPositionAtRightPalletPosition
  • Whether or not the agent is still located at the reported position on right side
10. lastRightPalletPosition
  • The position of the pallet on the right side. Empty if vehicle is not in any aisle
11. machineNumber
  • NonNull
  • Type:
  • The id of the agent
12. missionId
  • NonNull
  • Type:
  • The id of the current mission. 0 if none
13. status
  • The current status of the agent
14. warehouse
  • The name of the warehouse
15. wMSAssignmentID
  • The WMS system's Id of the agent's current mission. Empty if none

Return to top

TdaProxyConfig

Object

The dynamic TdaProxy service configuration settings.

Fields:

1. aisleParsingRegex
2. exitAisleAlgorithm
3. locationCacheValidityInSeconds
4. locationIdToMapIdRegex
5. maxIdleAgentTimeInSeconds
  • a time in seconds that represents how long we'll allow an agent to stay idle before manually requesting a dispatch of tasks for the agent. 0 implies we will never force a dispatch to the agent just because it is idle.

Return to top

TransferTask

Object

A task which requires the movement of a container from one location to another

Fields:

1. agentId
  • The id of the agent assigned to this task.
2. agentTypeId
  • The id of the agent type of the agent assigned to the task.
3. assignmentStatus
  • Describes if the task has been assigned to an agent or if it is eligible for assignment.
4. creatingUserId
  • The user id who created the task.
5. creationDate
  • The datetime at which this task was created.
6. dispatchDate
  • The datetime in UTC at which the task was dispatched to an agent.
7. dueDate
  • The datetime by which this task must be complete.
8. endDate
  • The datetime in UTC at which this task completed, failed, or was cancelled
9. endingUserId
  • The user id who ended the task.
10. endReason
  • The reason a task was ended.
11. executionStatus
  • Describes the execution status of the task. This encompasses whether or not the assigned agent has started the task, if the task has been completed, or if the task has failed for some reason.
12. id
  • The id of the task.
13. missionName
  • If this task belongs to a mission, this field contains the mission's name. If only the mission name is needed, this is a less expensive alternative to querying the mission task field.
14. missionTask
  • If this task belongs to a mission, this field contains the details about the mission task.
15. name
  • The name of the task.
16. onHold
  • If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
17. predecessorTasks
  • The set of tasks which must be completed before this task can execute. This field is not yet implemented.
18. priority
  • NonNull
  • Type:
  • The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority. Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
19. repairStatus
  • If this task faulted and is repairable, describes the execution status of the repair task.
20. repairType
  • If this task faulted and is repairable, describes the type of repair used.
21. requiredAgentId
  • Optional. Specifies an agent that MUST be assigned to this task.
22. taskCriteriaPayload
  • Contains data required to generate work for the transfer task.
23. taskDuration
  • The amount of time in milliseconds it took to complete the task.
24. taskGroup
  • The task group this task belongs to.
25. taskGroupName
  • The name of the task group this task belongs to.
26. taskInstructionPayload
  • Contains concrete details about how the transfer task should be executed. Generated close to when the task is executed.
27. taskType
  • The task type of the task.

Return to top

TransferTaskCriteriaPayload

Object

Contains criteria about how a transfer task should be executed. The criteria will be used to resolve concrete instructions close to when the task is executed.

Fields:

1. agentPayloadPosition
  • The criteria for the payload position on the agent to use when executing the task
2. container
  • The container to transfer between locations for this task
3. destinationLocationQuery
  • A query object which can resolve the location at which the container targeted by this task will be placed.
4. sourceLocationQuery
  • A query object which can resolve the location from which the container targeted by this task will be picked up.

Return to top

TransferTaskInstructionPayload

Object

Contains concrete details about how a transfer task should be executed

Fields:

1. agentPayloadPosition
  • The details of the payload position on the agent to use when executing the task
2. container
  • The container to transfer between locations for this task
3. destinationLocationId
  • Identifies the destination location at which the container targeted by this task will be dropped off. Null implies the assigned agent will hold the container.
4. destinationReservationToken
  • The token which identifies the reservation against the destination location, if any.
5. sourceLocationId
  • Identifies the source location from which the container targeted by this task will be picked up. Null implies the assigned agent already has the container.

Return to top

UpdateLocationsFailure

Object

The response from the UpdateLocations mutation, received when updating a location fails

Fields:

1. locationName
  • The name of the location that failed to be updateed
2. reason
  • The reason why the location failed to be updateed

Return to top

UpdateLocationsResponse

Object

The response from an UpdateLocations mutation, containing the failures if any were experienced

Fields:

1. updateLocationFailures
  • The list of locations that failed to be updateed including the reason why each one failed

Return to top

UpdateRouteReservationResponse

Object

Response to a reservation request

Fields:

1. nodeReservationResults
  • The the results for node reservation
2. nodeUnreservationResults
  • The the results for node unreservation

Return to top

UpdateTaskBatchResponse

Object

Describes the results of a batch update to tasks

Fields:

1. errors
  • Identifies which tasks failed to updated, and why.
2. updatedTaskNames
  • NonNull
  • Type:
    • List
    • Type:
  • The names of tasks which were successfully updated

Return to top

Vector2

Object

Details about a point on a 2d cartesian point in space

Fields:

1. x
  • The x coordinate
2. y
  • The y coordinate

Return to top

Vector3

Object

Represents a point in 3D space as a vector with 3 single-precision floating point values

Fields:

1. x
2. y
3. z

Return to top

Vector3Transform

Object

Represents a transformation specification from one coordinate system to another system.

Fields:

1. axisSwap
2. offset
3. pivotOffset
4. scale

Return to top

Vector4

Object

Represents a rotation in 3D space as a quaternion with 4 single-precision floating point values

Fields:

1. w
2. x
3. y
4. z

Return to top

ZoneResponse

Object

Zone information for a graph zone

Fields:

1. enclosedNodes
  • A list of node id's for the nodes this zone surrounds
2. id
  • The zone id used withing the graph.
3. metadata
  • A dictionary of metadata information about this edge.
4. polygonPoints
  • A list of points that define the polygon of the zone
5. zoneActions
  • A list of actions that can be performed in this zone

Return to top

InputObject

AddAliasBatchHeaderInput

InputObject

The Aliasing object that defines the types corresponding to the records' values.

Input Fields:

Name Description Type
aliasTypeIds The alias types that match the records given in order.
  • NonNull
  • Type:

Return to top

AddAliasBatchRecordInput

InputObject

The Aliasing object that defines the values of the aliases corresponding to the header's types.

Input Fields:

Name Description Type
aliasValues The alias values that match the header's types given in order.
  • NonNull
  • Type:

Return to top

AddLocationRequestType

InputObject

The details of a location to add to the reliable collection

Input Fields:

Name Description Type
name The name of the location
dimensions The dimensional size of the location
locationCoordinate The coordinates of the location in physical space
customProperties A dictionary containing any custom properties required by a agent service

Return to top

AddLocationSchemeRequest

InputObject

Adds a location scheme to the reliable collection

Input Fields:

Name Description Type
name The name of the new scheme to add
description A discription of which sorts of locations are expected under this scheme
patternString The regex pattern that describes this scheme

Return to top

AddLocationsRequestInput

InputObject

Adds a collection of locations to the reliable collection

Input Fields:

Name Description Type
schemeName The name of the scheme that the locations belong to
isControlled Whether or not Maestro is the system of record for this location. If true, stricter validations are performed for store, transfer, and reservation operations at this location.
addLocationRequests The details of the locations to add

Return to top

AgentIdAndTypeInput

InputObject

Identifies an agent by its id and type.

Input Fields:

Name Description Type
agentId The agent's id.
agentTypeId The agent's type id.

Return to top

agentInput

InputObject

An agent to register with Maestro

Input Fields:

Name Description Type
id The unique id of the agent
type The type of the agent. Ex. RaymondSRT9600, ManualForklift, cvc600
endpointAddress The optional address of the endpoint that can be used to connect to the agent
communicationStack The communication stack used to communicate with the agent. Ex. rosbridge or rabbitmq
properties A set of any additional properties that describe the agent

Return to top

AgentPayloadPositionCriteriaInput

InputObject

The criteria for the payload position on an agent that should be used to execute a task

Input Fields:

Name Description Type
positionId The id of the payload position on the agent

Return to top

agentSettingsInput

InputObject

Sets the agent settings for the specified agent

Input Fields:

Name Description Type
agentId The id of the agent
minimumCompletionTime The smallest amount of time in seconds that must elapse before a task is complete
maximumCompletionTime The largest amount of time in seconds that can elapse before a task is complete
agentTaskResult Possible end states for a task. Completed, Cancelled, and Faulted
batteryCharge Toggles if the battery state is tracked and updates are sent to agent service
eventCode Toggles if the emulator will send event codes to the agent service
state Toggles if the emulator vehicle state is tracked and updates are sent to agent service
obstructed Toggles if the emulator will send obstructed updates to the agent service
agentFaultSetting Configures the fault rate for the different stages of a task

Return to top

AgentTypeAndProfileInputType

InputObject

Input type describing an agent type and profile

Input Fields:

Name Description Type
agentProfile
agentType

Return to top

agentTypeCapabilityInput

InputObject

A custom capability that can be added to an AgentType

Input Fields:

Name Description Type
id The unique id of the AgentTypeCapability
defaultValue The default value for the capability

Return to top

agentTypeInput

InputObject

An AgentType to register with Maestro

Input Fields:

Name Description Type
id The unique id of the AgentType
agentServiceUri The address of the WebService used to communicate with this AgentType
agentVelocity The average velocity of the agent in meters per second
allowActiveTaskCancellation Whether or not this AgentType supports the cancellation of an active task
allowTrafficControl Whether or not this AgentType supports traffic control
taskTypes The task types that this AgentType is capable of executing
maxNumAssignedTasks The maximum number of tasks that can be assigned to each individual agent, including any dispatched tasks
  • NonNull
  • Type:
taskOverrideState Possible end states for an overridden task. Disabled (if the feature is not enabled), Completed, Cancelled, and Faulted

Return to top

AliasConfigInput

InputObject

The configuration for how a single property should be aliased

Input Fields:

Name Description Type
property The name of the property whose aliasing to configure
isEnabled Whether or not the property value should get aliased

Return to top

AliasObjectInput

InputObject

The Aliasing object that defines an Alias' type and value.

Input Fields:

Name Description Type
aliasType The aliasing scheme that this object fits into. e.g. HOST_SYSTEM_INVENTORY_LOCATION
aliasValue The value of the alias of the given type. e.g Rack_3

Return to top

ArchivableServiceInputType

InputObject

The details of a service registered with the archive for scheduled record collection

Input Fields:

Name Description Type
serviceId The id of the service
serviceAddress The address used to interact with the service
  • NonNull
  • Type:
archiveScheduleId The id of the schedule that this service is registered with
archiveTriggers The ArchiveTriggers used by the service to determine whether or not data should be archived
collectionPaused Whether or not this service should get requests for archivable data according to its archive schedule

Return to top

ArchiveRecordInputType

InputObject

The properties of a record in the archive

Input Fields:

Name Description Type
collectionName The name of the collection that stored the record in production
data The actual archived data, serialized to a string
dataType The assembly qualified namespace of the data model, which contains the full namespace as well as the version
description A brief description of the data type and why it needs to be archived
id The unique Id of the record
partitionId The id of the partition that archived the data
sourceAddress The address of the WebService used to communicate with the service that created the record
tags The collection of tags used to filter for the record
  • NonNull
  • Type:
    • List
    • Type:
timeStamp The UTC time that the data was archived

Return to top

ArchiveTriggerInputType

InputObject

Triggers used by archivable services to determine what data is ready to be archived

Input Fields:

Name Description Type
targetedData The type of data targeted by the trigger (Ex: "Tasks")
metrics The inclusive collection of metrics used to determine if the targeted data is ready to be archived

Return to top

ArchiveTriggerMetricInputType

InputObject

Triggers used by archivable services to determine what data is ready to be archived

Input Fields:

Name Description Type
metricName The metric used to determine whether or not the associated data is ready to be archived (Ex: "AgeInDays" or "Status")
value The values for the metric that make the associated data ready to be archived (Ex: "30", "Completed", or "Completed, Cancelled, Faulted")

Return to top

AssignedTaskIdInputType

InputObject

Input type describing an agent id and task name combination

Input Fields:

Name Description Type
agentId The name of the agent assigned to the task
taskName The name of the task the agent is assigned to.

Return to top

BeginCancelTaskInput

InputObject

Input type which describes a task to cancel

Input Fields:

Name Description Type
taskGroupName The name of the task group for the task to cancel.
taskName The name of the task to cancel.
endingUserId The user id of who is canceling the task
endReason The reason the task is being canceled
customDetails Custom details of the task to end.
Examples: InventoryPicked, InventoryPlaced, HoldPlaceReservation

Return to top

BeginCompleteTaskInput

InputObject

Input type which describes a task to complete

Input Fields:

Name Description Type
taskGroupName The name of the task group for the task to complete.
taskName The name of the task to complete.
endingUserId The user id of who is completing the task
endReason The reason the task is being completed
customDetails Custom details of the task to end.
Examples: InventoryPicked, InventoryPlaced, HoldPlaceReservation

Return to top

BeginDispatchTasksInput

InputObject

Describes which agents to dispatch tasks to.

Input Fields:

Name Description Type
agentIdsAndTypes Identifies the agents to dispatch tasks to by their id and type.
reDispatchCurrentTask If true, and if the agent already has a dispatched task, Task Assignment will re-dispatch the agent's current task. If false, and if the agent does NOT have a dispatched task, Task Assignment will dispatch the agent's next assigned task, if any.

Return to top

BeginFaultTaskInput

InputObject

Input type which describes a task to fault

Input Fields:

Name Description Type
taskGroupName The name of the task group for the task to fault
taskName The name of the task to fault
endingUserId The user id of who is faulting the task
endReason The reason the task is being faulted
customDetails Custom details of the task to end.
Examples: InventoryPicked, InventoryPlaced, HoldPlaceReservation

Return to top

BeginReAssignTaskInput

InputObject

Input type which describes a task to re-assign from one agent to another

Input Fields:

Name Description Type
taskName The name of the task
taskGroupName The name of the task group for the task
oldAgentId The id of the agent currently assigned to the task
newAgentId The id of the agent to re-assign the task to
newAgentTypeId The id of the type of agent to re-assign the task to

Return to top

BeginUnassignTasksInput

InputObject

Input type which describes tasks to unassign

Input Fields:

Name Description Type
tasks The tasks to be queued for unassignment

Return to top

BlockListEntryInput

InputObject

An object providing details about a single entry in the SQL database block list.

Input Fields:

Name Description Type
providerName The provider name of an event provider/event name pair of a block list entry.
eventName The event name of an event provider/event name pair of a block list entry.

Return to top

ClearNodeReservationCommand

InputObject

Command used to determine which node reservations to clear

Input Fields:

Name Description Type
agentIds Optional. If specified, clears all reserved nodes associated with the specified agents, except those specified in 'NodesToExclude'
assignedTaskId Optional. If specified, clears all reserved nodes associated with the specified task, except those specified in 'NodesToExclude'
clearAll Optional. If specified, clears all reserved nodes, except those specified in 'NodesToExclude', regardless of any other properties
nodeIds Optional. If specified, clears the reservations from all of the specified nodes
nodesToExclude Optional. The ids of the nodes whose reservations to exclude. Not used when clearing by 'NodeIds'

Return to top

ContainerInput

InputObject

A model of a container which will be visited while completing a task

Input Fields:

Name Description Type
id The id of the container
type The type of the container
dimensions The physical dimensions of the container in millimeters where X is Width, Y is Depth, and Z is height.

Return to top

CoordinatePoseTransformInputType

InputObject

Data model used to configure the coordinate conversion transforms to appy to a pose

Input Fields:

Name Description Type
axisSwaps The sequence of axis swaps to perform on the position
offset The offset to subtract from the position coordinates, useful for moving the position of the origin
scale The scale to multiply to the position coordinates
pivotOffset The offset of the pivot, useful for ensuring the object rotates around the correct pivot
rotationAxisSwaps The sequence of axis swaps to perform on the rotation
rotationOffset The offset of the rotation, useful for ensuring the object is looking the correct direction
invertRotation Whether or not to invert the direction of rotation, useful for ensuring the object rotates in the correct direction

Return to top

DeleteLocationRequest

InputObject

Deletes a location from the reliable collection

Input Fields:

Name Description Type
name The name of the location to delete

Return to top

DeleteLocationSchemeRequest

InputObject

Deletes a location scheme from the reliable collection

Input Fields:

Name Description Type
schemeName The name of the location scheme to delete

Return to top

DictionaryInput_Key_AgentTypeAndProfileInputType_Value_String

InputObject

GraphQL representation of a dictionary.

Input Fields:

Name Description Type
pairs The list of key value pairs.

Return to top

DictionaryInput_Key_RichKeyInput_Value_String

InputObject

GraphQL representation of a dictionary.

Input Fields:

Name Description Type
pairs The list of key value pairs.

Return to top

DictionaryInput_Key_String_Value_Float

InputObject

GraphQL representation of a dictionary.

Input Fields:

Name Description Type
pairs The list of key value pairs.

Return to top

DictionaryInput_Key_String_Value_ListOf_TaskModelInputType

InputObject

GraphQL representation of a dictionary.

Input Fields:

Name Description Type
pairs The list of key value pairs.

Return to top

DictionaryInput_Key_String_Value_String

InputObject

GraphQL representation of a dictionary.

Input Fields:

Name Description Type
pairs The list of key value pairs.

Return to top

DictionaryInput_Key_String_Value_TaskBidCustomCostInputType

InputObject

GraphQL representation of a dictionary.

Input Fields:

Name Description Type
pairs The list of key value pairs.

Return to top

DictionaryInput_Key_String_Value_TaskBidEnrichmentDataInputType

InputObject

GraphQL representation of a dictionary.

Input Fields:

Name Description Type
pairs The list of key value pairs.

Return to top

EmulatorConfigInputType

InputObject

The model used to optionally set the different emulator config properties

Input Fields:

Name Description Type
sendSyncMessages If set, controls whether or not the emulator should enable sync messaging delays in task execution
freezeDuringPicking If set, controls whether or not task execution should temporarily freeze during the PICKING order phase. Used with FreezeBeforeLoadHandling to test task deletion during the PICKING order phase either before or after the vehicle reaches the point-of-no-return of the pick load handling operation
freezeDuringDropping If set, controls whether or not task execution should temporarily freeze during the DROPPING order phase. Used with FreezeBeforeLoadHandling to test task deletion during the DROPPING order phase either before or after the vehicle reaches the point-of-no-return of the drop load handling operation
freezeBeforeLoadHandling Used with FreezeDuringPicking or FreezeDuringDropping to test task deletion during the PICKING or DROPPING order phase either before or after the vehicle reaches the point-of-no-return of the pick or drop load handling operation

Return to top

EndTaskInput

InputObject

Input type which describes the parameters used to end a task in the task assignment service

Input Fields:

Name Description Type
agentId The id of the agent assigned to the task when it ended
endDate The UTC datetime the task ended
taskDuration The total runtime of the task, in milliseconds, from the agent's perspective.
finalTaskExecutionStatus The execution status in which the task ended.
taskGroupName The name of the task group in which the ending task resides.
taskName The name of the task to end.
endReason Describes the reason a task was ended.
endingUserId The user id of who ended the task.

Return to top

EnrichTaskBidsCommandInputType

InputObject

Request used to get the enriched bids and bid rejections from the TaskBidEnricher

Input Fields:

Name Description Type
taskBids The task bids to enrich
missionChildTasksMap The dictionary containing all of the child tasks for each mission

Return to top

GetActiveRouteInput

InputObject

A request listing the nodes to route between

Input Fields:

Name Description Type
assignedTaskId The combination of an agent id and task name that represent the key a stored route

Return to top

GetAgentsInput

InputObject

A query object describing how to filter the agents returned by the AgentHub service

Input Fields:

Name Description Type
agentTypes An optional collection of agent types used to filter the result set. Ex. RaymondSRT9600, ManualForklift, cvc600
communicationStacks An optional collection of communication stacks used to filter the result set. Ex. rosbridge or rabbitmq

Return to top

GetAliasesByRegexRequestInput

InputObject

Gets the alias(es) that contains the given regex

Input Fields:

Name Description Type
regexString The regular expression matching the Aliases to be retrieved
aliasType The type of aliases to be retrieved

Return to top

GetGraphNodePagedRequest

InputObject

The Request Object to get paged sets of nodes with the given filters. Empty filters defaults to select all

Input Fields:

Name Description Type
agentTypes The Agent types to include in this query
agentProfiles The profile types to include in this query
nodeIds The node id's to specifically select.
zoneIds The Zone id's to filter nodes by (only include nodes that exist in the provided zones)

Return to top

GetLocationByContainerIdRequestInput

InputObject

Gets the inventory location that contains the given

Input Fields:

Name Description Type
containerId The name of the container whose location is to be retrieved

Return to top

GetLocationByLocationNameRequestInput

InputObject

Gets an inventory location by it name

Input Fields:

Name Description Type
locationName The location name for the location to be retrieved

Return to top

GetLocationsByRegexRequestInput

InputObject

Gets the inventory location that contains the given regex

Input Fields:

Name Description Type
regexString The regular expression matching the locations to be retrieved

Return to top

GetLocationSchemesRequestInput

InputObject

Gets the inventory location schemes

Input Fields:

Name Description Type
schemeName If specified, gets the location scheme with this name, otherwise returns all

Return to top

GetLocationsPagedQueryInput

InputObject

Gets the inventory locations that match a given set of filters

Input Fields:

Name Description Type
locationIds A list of location ids to filter on
locationIdPatterns A list of regex patterns to filter on
containerIds A list of container ids to filter on
isOccupied Filters based on whether a location is occupied or not
isReserved Filters based on whether a location is reserved or not
reservationIds A list of reservation ids to filter on
  • List
  • Type:
schemes A list of location schemes to filter on
types A list of location types to filter based on

Return to top

GetLocationsRequestInput

InputObject

Gets the inventory locations

Input Fields:

Name Description Type
schemeName If specified, gets the locations filtered by this scheme

Return to top

GetLogsQueryInput

InputObject

Gets the log entries that match a given set of filters

Input Fields:

Name Description Type
channel The name of the channel to query events from
eventProviders A list of event providers to filter on
eventNames A list of event names to filter on
eventSeverities A list of event severities to filter on
eventMessage Filters based on whether an event's message contains the given text
agentNames A list of agent names to filter on
subsystemEventIds A list of event ids from third party systems to filter on.
subsystemEventNames A list of event names from third party systems to filter on.
minEventDate Filters based on if the event occurred on or after the date
maxEventDate Filters based on if the event occurred on or before the date

Return to top

GetLogSummariesQueryInput

InputObject

Retrieves log summaries after applying given set of filters.

Input Fields:

Name Description Type
channel The name of the channel to query events from
eventProviders A list of event providers to filter on.
eventNames A list of event names to filter on.
eventSeverities A list of event severities to filter on.
eventMessage Filters based on whether an event's message contains the given text.
agentNames A list of agent names to filter on.
subsystemEventIds A list of event ids from third party systems to filter on.
subsystemEventNames A list of event names from third party systems to filter on.
minEventDate Filters based on if the event occurred on or after the date
maxEventDate Filters based on if the event occurred on or before the date

Return to top

GetMapVersions

InputObject

A request to get a list of map versions

Input Fields:

Name Description Type
getAll A boolean indicating if the user wants all versions available (true) or just the current active version (false)

Return to top

GetRouteExecution

InputObject

A request listing the nodes to route between

Input Fields:

Name Description Type
agentId The agent id associated with the reserved route
routeId The route id of the reserved route

Return to top

GetRouteQuery

InputObject

A request listing the nodes to route between

Input Fields:

Name Description Type
waypoints A list of nodes to traverse in order, min size 2.
agent The agent type you wish to traverse the route
agentProfile The profile that is currently active for the agent
excludeNodes A list of nodes to exclude from route planning
transformNodeIds When specified, indicates that routes should be calculated using transformed node ids rather than the raw node ids provided in 'Waypoints'.

Return to top

GetTaskBidsQueryInputType

InputObject

Request used to get the bids or bid rejections for multiple tasks

Input Fields:

Name Description Type
taskBidRequests The bid requests for each individual task
missionChildTasksMap The dictionary containing all of the child tasks for each mission

Return to top

GetTasksInput

InputObject

Input type which describes the parameters to match when searching for specific tasks. All parameters are optional, and can be combined.

Input Fields:

Name Description Type
agentIds Ids of the agents who tasks are assigned to.
assignmentStatuses Assignment statuses of the tasks.
  • List
  • Type:
creatingUserId The user that created the tasks.
endingUserId The user that ended the tasks.
executionStatuses Execution statuses of the tasks.
  • List
  • Type:
maxCreatedDate Maximum date for which the tasks were created.
maxDueDate Maximum date for which the tasks were due.
maxEndDate Maximum date for which the tasks were ended.
maxPriority Maximum priority for the tasks.
minCreatedDate Minimum date for which the tasks were created.
minDueDate Minimum date for which the tasks were due.
minEndDate Minimum date for which the tasks were ended.
minPriority Minimum priority for the tasks.
missionNameRegex Regular expression which specifies which mission names to match.
taskGroupNameRegex Regular expression which specifies which task group names to match.
taskNameRegex Regular expression which specifies which task names to match.
taskTypes Types of the tasks
taskSortCriteria Optional criteria for sorting tasks.

Return to top

GetZoneQuery

InputObject

A request to get a list of zones.

Input Fields:

Name Description Type
zoneIds A list of zone id's to get, or empty if you want all zones.

Return to top

InventoryLocationInput

InputObject

A location in the Inventory System

Input Fields:

Name Description Type
name The name of the inventory location
scheme The scheme that this location belongs to
type The type of the location
dimensions The dimensional size of the location
locationCoordinate The coordinates of the location in physical space
isControlled Whether or not Maestro is the system of record for this location. If true, stricter validations are applied during store, transfer, and reservation operations.
occupied Whether or not this location is occupied with a container
containerId If the location is occupied, contains the name of the container
containerDimensions The dimensional size of the container if one is present
reservationId If the location is reserved, the id token associated with that reservation
customProperties A dictionary containing any custom properties required by a agent service

Return to top

KVPInput_Key_AgentTypeAndProfileInputType_Value_String

InputObject

GraphQL representation of a key value pair.

Input Fields:

Name Description Type
key The key of the key value pair.
value The value associated with the key.

Return to top

KVPInput_Key_RichKeyInput_Value_String

InputObject

GraphQL representation of a key value pair.

Input Fields:

Name Description Type
key The key of the key value pair.
value The value associated with the key.

Return to top

KVPInput_Key_String_Value_Float

InputObject

GraphQL representation of a key value pair.

Input Fields:

Name Description Type
key The key of the key value pair.
value The value associated with the key.

Return to top

KVPInput_Key_String_Value_ListOf_TaskModelInputType

InputObject

GraphQL representation of a key value pair.

Input Fields:

Name Description Type
key The key of the key value pair.
value The value associated with the key.

Return to top

KVPInput_Key_String_Value_String

InputObject

GraphQL representation of a key value pair.

Input Fields:

Name Description Type
key The key of the key value pair.
value The value associated with the key.

Return to top

KVPInput_Key_String_Value_TaskBidCustomCostInputType

InputObject

GraphQL representation of a key value pair.

Input Fields:

Name Description Type
key The key of the key value pair.
value The value associated with the key.

Return to top

KVPInput_Key_String_Value_TaskBidEnrichmentDataInputType

InputObject

GraphQL representation of a key value pair.

Input Fields:

Name Description Type
key The key of the key value pair.
value The value associated with the key.

Return to top

LocationQueryInput

InputObject

A query object which can be used to resolve a location using one of several criteria.

Input Fields:

|Name | Description | Type| |--- | --- | ---| |locationId | The id of the location |

| |locationPattern | A regular expression which identifies one or more locations by their id. | | |locationPatterns | Container of regular expressions to identify one or more locations by their id. | | |excludedLocations | The collection of locations that should not be reserved. Only used when reserving with LocationPattern | | |containerId | The id of a container. Resolves the location at which the container is currently held. | | |occupied | Optional. If true, specifies only locations occupied by a container should be returned in the query results. If false, specifies only locations NOT occupied by a container should be returned in the query results. If null, no filtering is done on the basis of container occupation. | |

Return to top

LogChannelInput

InputObject

A single log channel's configuration.

Input Fields:

Name Description Type
name The name of the log channel to configure.
maxRecordAgeInHours The max age that logs will persist in the log channel before archiving. Optional - the default max age is 12.
providerCriteriaList A list of event providers and associated event names that a log channel subscribes to. Optional.
eventSeverities The event severities that this log channel subscribes to. Optional.

Return to top

LogEntryInput

InputObject

An object providing details about an event log entry.

Input Fields:

Name Description Type
id The id of an event log entry
  • NonNull
  • Type:
level The level of an event log entry.
payload The payload of an event log entry.
keywords The keywords of an event log entry.
  • NonNull
  • Type:
providerName The provider name of an event log entry.
timestamp The timestamp of an event log entry.
message The message of an event log entry.
name The name of an event log entry.
agentId The agent id that generated the event, if applicable.

Return to top

LogMultipleRequestInput

InputObject

Create a batch of log entries.

Input Fields:

Name Description Type
logEntries The batch of log entries to create.

Return to top

MaestroMapConfigurationInput

InputObject

Input type describing a Maestro Map configuration

Input Fields:

Name Description Type
taskLocationToMapIdRegexMap

Return to top

MissionTaskInput

InputObject

Input for a task which aggregates a set of child tasks for sequential execution by a single agent.

Input Fields:

Name Description Type
jackpotsTaskNames Optional. The names of faulted tasks which are jackpotted if this task completes successfully. Jackpot means the system is moved into a controlled error state from which it can recover autonomously or with operator assistance.
  • List
  • Type:
name The name of the task to create. This must be globally unique
missionName Optional. The name of the mission task associated with this task. If used, this task is exempt from the task assignment process. The associated mission participates in the bid process; tasks on the mission are assigned as a unit.
onHold If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
predecessorTasks The ids of any tasks which must be completed before this task can be executed.
  • NonNull
  • Type:
    • List
    • Type:
priority The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority.Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
  • NonNull
  • Type:
repairsTaskNames Optional. The names of faulted tasks which are repaired if this task completes successfully. Repaired implies the system looks as if the original faulted tasks had succeeded.
  • List
  • Type:
requiredAgentId Optional. The id of an agent which MUST be assigned to the task
dueDate The date by which this task must be completed
taskGroupName The name of the task group this task belongs to.
creatingUserId The user id of who created the task.
customTaskType Optional. Override the task type with a custom task type
taskNames The names of tasks to execute as part of the mission. The tasks will be executed in the order they are defined. The tasks may or may not exist at the time of the mission's creation. The mission, however, will not be eligible for assignment until all its tasks exist.
  • NonNull
  • Type:
    • List
    • Type:

Return to top

MissionTaskInputType

InputObject

The details of a Task in a TdaProxy Mission

Input Fields:

Name Description Type
action The action to perform at the location
horizontalOffset
  • NonNull
  • Type:
locationAlias
locationPalletPosition
locationWarehouse
message
recommendedAisleExit The optional recommended way of exiting the aisle
taskId
  • NonNull
  • Type:
verticalOffset
  • NonNull
  • Type:

Return to top

PalletPickTaskInput

InputObject

Input type which describes a task to remove a pallet from a location.

Input Fields:

Name Description Type
jackpotsTaskNames Optional. The names of faulted tasks which are jackpotted if this task completes successfully. Jackpot means the system is moved into a controlled error state from which it can recover autonomously or with operator assistance.
  • List
  • Type:
name The name of the task to create. This must be globally unique
missionName Optional. The name of the mission task associated with this task. If used, this task is exempt from the task assignment process. The associated mission participates in the bid process; tasks on the mission are assigned as a unit.
onHold If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
predecessorTasks The ids of any tasks which must be completed before this task can be executed.
  • NonNull
  • Type:
    • List
    • Type:
priority The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority.Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
  • NonNull
  • Type:
repairsTaskNames Optional. The names of faulted tasks which are repaired if this task completes successfully. Repaired implies the system looks as if the original faulted tasks had succeeded.
  • List
  • Type:
requiredAgentId Optional. The id of an agent which MUST be assigned to the task
dueDate The date by which this task must be completed
taskGroupName The name of the task group this task belongs to.
creatingUserId The user id of who created the task.
customTaskType Optional. Override the task type with a custom task type
locationId The id of the location hosting the pallet.

Return to top

PalletPlaceTaskInput

InputObject

Input type which describes a task to place a pallet at a location.

Input Fields:

Name Description Type
jackpotsTaskNames Optional. The names of faulted tasks which are jackpotted if this task completes successfully. Jackpot means the system is moved into a controlled error state from which it can recover autonomously or with operator assistance.
  • List
  • Type:
name The name of the task to create. This must be globally unique
missionName Optional. The name of the mission task associated with this task. If used, this task is exempt from the task assignment process. The associated mission participates in the bid process; tasks on the mission are assigned as a unit.
onHold If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
predecessorTasks The ids of any tasks which must be completed before this task can be executed.
  • NonNull
  • Type:
    • List
    • Type:
priority The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority.Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
  • NonNull
  • Type:
repairsTaskNames Optional. The names of faulted tasks which are repaired if this task completes successfully. Repaired implies the system looks as if the original faulted tasks had succeeded.
  • List
  • Type:
requiredAgentId Optional. The id of an agent which MUST be assigned to the task
dueDate The date by which this task must be completed
taskGroupName The name of the task group this task belongs to.
creatingUserId The user id of who created the task.
customTaskType Optional. Override the task type with a custom task type
locationId The id of the location to place the pallet at.

Return to top

PayloadInput

InputObject

The details of a payload stored on an agent

Input Fields:

Name Description Type
id The unique id of the payload

Return to top

PayloadPositionInput

InputObject

The details of an agent's payload position

Input Fields:

Name Description Type
id The unique id of the payload position
payload Optional. The payload stored at this payload position
taskName Optional. The id of the task that last interacted with this payload position
taskGroupName Optional. The id of the group of the task that last interacted with this payload position

Return to top

PayloadPositionTypeInput

InputObject

Describes a single payload position type that can be configured for an AgentType

Input Fields:

Name Description Type
id The unique id of the payload position type

Return to top

ProductPickTaskInput

InputObject

Input type which describes a task to remove some amount of individual product from a container.

Input Fields:

Name Description Type
jackpotsTaskNames Optional. The names of faulted tasks which are jackpotted if this task completes successfully. Jackpot means the system is moved into a controlled error state from which it can recover autonomously or with operator assistance.
  • List
  • Type:
name The name of the task to create. This must be globally unique
missionName Optional. The name of the mission task associated with this task. If used, this task is exempt from the task assignment process. The associated mission participates in the bid process; tasks on the mission are assigned as a unit.
onHold If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
predecessorTasks The ids of any tasks which must be completed before this task can be executed.
  • NonNull
  • Type:
    • List
    • Type:
priority The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority.Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
  • NonNull
  • Type:
repairsTaskNames Optional. The names of faulted tasks which are repaired if this task completes successfully. Repaired implies the system looks as if the original faulted tasks had succeeded.
  • List
  • Type:
requiredAgentId Optional. The id of an agent which MUST be assigned to the task
dueDate The date by which this task must be completed
taskGroupName The name of the task group this task belongs to.
creatingUserId The user id of who created the task.
customTaskType Optional. Override the task type with a custom task type
locationId The id of the location to pick from.
quantity The quantity to pick

Return to top

ProviderCriteriaInput

InputObject

The event providers and specific events from them that are subscribed to by a log channel.

Input Fields:

Name Description Type
providerName An event provider name that a log channel subscribes to.
eventNames The list of event names from the specified provider that a log channel subscribes to. An emptylist signifies subscribing to all events from the provider.

Return to top

RecordFilterInputType

InputObject

The properties of a filter used to specify a collection of records

Input Fields:

Name Description Type
recordIds If the record Id matches one of these ids, then it passes the filter. If null, any id passes this filter
matchAnyTags If the record has at least one of these tags or all of the MatchAllTags, and none of the ExcludeAnyTags, then it passes the filter. If null, any tags pass this filter
matchAllTags If the record has all of these tags or any of the MatchAnyTags, and none of the ExcludeAnyTags, then it passes the filter. If null, any tags pass this filter
excludeAnyTags If the record has any of these tags then it gets filtered out. If null, any tags pass this filter
maxNumTags If the record has less than or equal to this number of tags then it passes the filter. If null, any amount of tags pass this filter
minNumTags If the record has more than or equal to this number of tags then it passes the filter. If null, any amount of tags pass this filter
beginTimestamp If the record's timestamp is after this, then it passes the filter. If null, any timestamp passes this filter
endTimestamp If the record's timestamp is before this, then it passes the filter. If null, any timestamp passes this filter
dataRegexes If the record data matches at least one of these regex then it passes the filter. If null, any amount of tags pass this filter
dataTypeRegexes If the record data type matches at least one of these regex then it passes the filter. If null, any amount of tags pass this filter
sourceAddressRegexes If the record source address matches at least one of these regexes then it passes the filter. If null, any sources pass this filter
collectionNames If the record has at least one of these collection names then it passes the filter. If null, any collection names pass this filter

Return to top

registrationInput

InputObject

The parameters required to register a subscriber to receive updates whenever tasks of the specified types get updated

Input Fields:

Name Description Type
subscriberName The name of the subscriber
endpoint The TCP URI to send updates to
taskTypes The list of task types to subscribe to updates for
  • NonNull
  • Type:
    • List
    • Type:

Return to top

ReliableQueueProcessorConfigInput

InputObject

Configuration used to control the operation of the reliable queue processors

Input Fields:

Name Description Type
deadLetterDeletionBatchSize Optional. Overwrite the number of dead letters to attempt to delete per batch of the deletion run loop
deadLetterExpirationTimeDays Optional. Overwrite the number of days a letter should stay in the dead letter queue before expiring
errorDataDeletionLoopDelayMinutes Optional. Overwrite the minimum number of minutes to delay between each attempt to trim excess error data
errorDataDeletionLoopTimeoutSeconds Optional. Overwrite the number of seconds to attempt to trim excess error data before the operation should timeout
maxNumDeadLettersPerCollection Optional. Overwrite the maximum number of dead letters that should exist in each dead letter collection

Return to top

ReserveLocationRequest

InputObject

The parameters required for attempting to reserve an inventory location. Either specify the exact location name or a location pattern scheme.

Input Fields:

Name Description Type
name In order to attempt to reserve a specific inventory location, provide the name of the location and leave the LocationNamePatternStrings empty.
locationNamePatternStrings In order to reserve one of a type of inventory locations, provide the LocationNamePatternStrings and leave the location name empty.
excludedLocations The collection of locations that should not be reserved. Only used when reserving with LocationNamePatternStrings

Return to top

RichKeyInput

InputObject

GraphQL representation of a Rich Key

Input Fields:

Name Description Type
name The name of the Rich Key.
section The sections of the Rich Key.
tags The dictionary of tags of the Rich Key.
type The type of the Rich Key.

Return to top

startRouteInput

InputObject

Inform the map that agents are ready to start route execution

Input Fields:

Name Description Type
agentId The Agent's Unique ID
agentProfile The Agent Map Profile
agentTypeId The Agent Type ID
taskId The Task Id of the task to start
taskGroup The Task Group the task is in

Return to top

stopRouteInput

InputObject

A request to stop a route's execution.

Input Fields:

Name Description Type
routeId The route id for the route to stop traversing, a single route ID will identify the route
agentId The Agent ID of the agent that is halting route execution. Both Agent ID and Task ID are required to identify the route.
taskId The Task ID of the task that is halting route execution. Both Agent ID and Task ID are required to identify the route.

Return to top

StoreContainerRequest

InputObject

Request object for storing a container in an already reserved location

Input Fields:

Name Description Type
agentId The id of the agent who stored the container
containerId The id of the container that was stored
locationName The name of the location that the container was stored at
reservationTokenId The token used to validate that the location was reserved for this storage
  • NonNull
  • Type:
containerDimensions The physical dimensions of the container to be stored.

Return to top

switchInput

InputObject

Sets the state of a switch

Input Fields:

Name Description Type
name The name of the switch
state The state of the switch

Return to top

TaskBatchConfigurationInput

InputObject

Defines the task batch portion of task assignment configuration

Input Fields:

Name Description Type
batchOperationIntervalInMilliseconds The duration, in milliseconds, between batch operations
  • NonNull
  • Type:
criteria Array of all of the defined batching criteria

Return to top

TaskBatchCriteriaInput

InputObject

Defines a single task assignment batching criteria

Input Fields:

Name Description Type
name The name of the batch criteria
expectedAgentTypeIds The agent types capable of of completing tasks under this batch criteria
taskTypes The types of tasks that are covered by this batch criteria

Return to top

TaskBidCostComponentWeightsInput

InputObject

Defines Task bid cost component weights

Input Fields:

Name Description Type
assignedTaskComponent The weight of the assigned task component
commissionAttemptComponent The weight of the commission attempt component
creationDateComponent The weight of the creation date component
distanceComponent The weight of the distance component
dueDateComponent The weight of the due date component
priorityComponent The weight of the priority component

Return to top

TaskBidCustomCostInputType

InputObject

A custom unweighted cost attached to a task bid

Input Fields:

Name Description Type
name The name of the custom cost
cost The unweighted value of the custom cost

Return to top

TaskBidEnricherInputType

InputObject

Defines the properties used to configure services capable of enriching task bids

Input Fields:

Name Description Type
applicationName The name of the ServiceFabric Application containing the service that hosts the remoting endpoint
serviceName The name of the singleton partitioned ServiceFabric service hosting the remoting endpoint
customCostWeights The collection mapping the name of an enricher's custom cost to the configurable weight of that cost

Return to top

TaskBidEnrichmentDataInputType

InputObject

A custom data attached to a task bid

Input Fields:

Name Description Type
name The name of the custom data
data The value of the custom data

Return to top

TaskBidInputType

InputObject

The details of a task bid as a GraphQL input object

Input Fields:

Name Description Type
distanceToTaskInMeters The agent's distance from the task's starting location in meters.
estimatedTimeToTaskCompletion The total seconds from task bid creation until the proposed agent will complete the task under ideal conditions.
estimatedTimeToTaskStart The total seconds from task bid creation until the proposed agent should have started the task.
proposedAgentId The id of the agent who would handle the task.
proposedAgentTypeId The id of the agent type of the agent who would handle the task.
task The actual task that is bid on
taskAssignmentProcessingId A unique id used to track a task's attempted assignment throughout the task assignment lifecycle.
taskBidPayload A payload of optional, arbitrary JSON describing additional information about the task provider's bid.
customCosts Additional unweighted cost data attached to the bid
enrichmentData Additional data attached to the bid

Return to top

TaskBidRequestInputType

InputObject

Request used to get the bids or bid rejections for a single task

Input Fields:

Name Description Type
task The task to get bids for
taskAssignmentProcessingId The unique id associated with the request

Return to top

TaskExecutionErrorInputType

InputObject

The input model used to configure an agent's task execution error. When an emulated agent has a task execution error, the emulator pauses that agent's task execution and reports the associated error codes

Input Fields:

Name Description Type
agentId The Id of the agent that should have a task execution error
errorHostActionCode The code used to set the type of error
raymondCarrierErrorCode The exact Raymond error code when the ErrorHostActionCode indicates a Raymond carrier error
kollmorgenCarrierErrorCode The exact Kollmorgen error code when the ErrorHostActionCode indicates a Kollmorgen carrier error

Return to top

TaskGroupInput

InputObject

Create a new task group

Input Fields:

Name Description Type
name The name of the task group to create

Return to top

TaskGroupQueryInput

InputObject

Input type describing how to filter task groups

Input Fields:

Name Description Type
taskGroupStates The task group states to include in the query results. Null implies no restriction on state.
minDateCreated The inclusive minimum task group creation date to include in the query results. Null implies no restriction on minimum date created.
maxDateCreated The exclusive maximum task group creation date to include in the query results. Null implies no restriction on maximum date created.

Return to top

TaskModelInputType

InputObject

The details of an existing task

Input Fields:

Name Description Type
name The name of the task
taskGroupName The name of the TaskGroup
taskType The type of the task
id The unique Id of the task
requiredAgentId The optional id of the agent required to execute that task
agentId The name of the agent assigned to the task
agentTypeId The id of the AgentType of the agent assigned to the task
taskPayload Contains the original arbitrary details about how to execute the task, as a JSON string
instructionPayload Contains the concrete instructions calculated about how to execute the task, as a JSON string
missionName The optional id of the mission that this task belongs to
priority The priority that this task takes over other tasks
assignmentStatus The assignment status of the task
executionStatus The execution status of the task
creatingUserId The id of the user who created the task
creationDate The date and time that the task was created
dispatchDate The date and time that the task dispatched
dueDate The date and time by which the task should be ended
endingUserId The id of the user who ended the task
endReason The reason that the task was ended
endDate The date and time that the task ended
onHold If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
taskDuration The amount of time in milliseconds it took to complete the task
cancellationSource The source of cancellation
repairType Describes the type of repair used to fix the task
repairStatus Describes the execution status of the task used to fix this task

Return to top

TaskNameAndGroupInputType

InputObject

An input object used to specify a specific task from a specific task group

Input Fields:

Name Description Type
taskName The name of the task
taskGroupName The name of the group that the task belongs to
agentId The id of the agent associated with the task. The meaning of the agent id is context dependent. For example, it may refer to the agent assigned to the task, or an agent we want to target with a command related to the task.

Return to top

TaskPriorityComponentWeightsInput

InputObject

Defines Task priority cost component weights

Input Fields:

Name Description Type
orderCreationDateWeight The weight of the order creation date component
orderDueDateWeight The weight of the order due date component
orderNumRunLoopsUnnacceptedWeight The weight of the number of unnaccepted run loops component
orderPriorityWeight The weight of the order priority component

Return to top

TaskSortCriterionInputType

InputObject

Input Fields:

Name Description Type
sortType The type of sorting.
direction The direction of sorting.

Return to top

TaskTransformConfigInput

InputObject

The configuration for task transformation for one or more task types

Input Fields:

Name Description Type
isEnabled Whether or not task transformation is enabled for tasks of the types. If enabled, TaskAssignment will attempt to communicate with a custom Maestro task transform service during task creation, using a URI based on the TaskType

Return to top

TaskTypeConfigInput

InputObject

The configuration for one or more types of tasks

Input Fields:

Name Description Type
names The names of the types of the tasks that this configuration applies to
aliasConfig The configuration for how tasks of the type should be aliased
taskTransformConfig The configuration for how tasks of the type should go through task transformation

Return to top

TdaProxyConfigInput

InputObject

The dynamic TdaProxy service configuration settings.

Input Fields:

Name Description Type
aisleParsingRegex
exitAisleAlgorithm The algorithm used to determine how to exit an aisle. Valid set: [DriveShortestPath, DriveTractorsFirst, ManualExitAisle]
locationIdToMapIdRegex
locationCacheValidityInSeconds
maxIdleAgentTimeInSeconds a time in seconds that represents how long we'll allow an agent to stay idle before manually requesting a dispatch of tasks for the agent. 0 implies we will never force a dispatch to the agent just because it is idle.

Return to top

TransferContainerRequest

InputObject

Request object for removing a container from a location

Input Fields:

Name Description Type
agentId The id of the agent who removed the container
locationName The name of the location that the container was removed from

Return to top

TransferTaskInput

InputObject

Input type which describes a task to move a container from one location to another

Input Fields:

Name Description Type
jackpotsTaskNames Optional. The names of faulted tasks which are jackpotted if this task completes successfully. Jackpot means the system is moved into a controlled error state from which it can recover autonomously or with operator assistance.
  • List
  • Type:
name The name of the task to create. This must be globally unique
missionName Optional. The name of the mission task associated with this task. If used, this task is exempt from the task assignment process. The associated mission participates in the bid process; tasks on the mission are assigned as a unit.
onHold If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
predecessorTasks The ids of any tasks which must be completed before this task can be executed.
  • NonNull
  • Type:
    • List
    • Type:
priority The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority.Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
  • NonNull
  • Type:
repairsTaskNames Optional. The names of faulted tasks which are repaired if this task completes successfully. Repaired implies the system looks as if the original faulted tasks had succeeded.
  • List
  • Type:
requiredAgentId Optional. The id of an agent which MUST be assigned to the task
dueDate The date by which this task must be completed
taskGroupName The name of the task group this task belongs to.
creatingUserId The user id of who created the task.
customTaskType Optional. Override the task type with a custom task type
agentPayloadPosition The criteria for the payload position on the agent to use when executing the task
sourceLocationQuery The location from which the container targeted by this task will be picked. Omitting this value implies Maestro can infer the source location on its own.
destinationLocationQuery The location at which the container targeted by this task will be placed. Omitting this value implies Maestro can infer the destination location on its own.
container The container to transfer between locations for this task
containerId The container to transfer between locations for this task.
containerDimensions The physical dimensions of the container in millimeters where X is Width, Y is Depth, and Z is height.

Return to top

TransferTaskUpdateInput

InputObject

Updates properties of a transfer task

Input Fields:

Name Description Type
name The name of the transfer task to update.
dueDate The new due date of the transfer task. If null, the task's due date will not be updated.
priority The new priority of the transfer task. If null, the task's priority will not be updated.

Return to top

UnreserveLocationRequest

InputObject

Unreserves an inventory location

Input Fields:

Name Description Type
reservationTokenId The reservation id that was returned when the location was originally reserved
  • NonNull
  • Type:

Return to top

updatedProperty

InputObject

The model used to map the name of a property to its updated value

Input Fields:

Name Description Type
propertyName The name of the property to update
propertyValue The value of the property to update

Return to top

UpdateLocationsRequestInput

InputObject

The parameters required for attempting to update an inventory location.

Input Fields:

Name Description Type
locations The new values of the locations to be updated

Return to top

updateRouteInput

InputObject

Update the map with a new set of waypoints to update the route with

Input Fields:

Name Description Type
agentId The Agent's Unique ID
agentProfile The Agent Map Profile
agentTypeId The Agent Type ID
excludeNodes The list of nodes to avoid
taskId The Task Id of the task to update
taskGroup The Task Group the task is in
waypoints The waypoints to route through
  • NonNull
  • Type:

Return to top

updateRouteReservationInput

InputObject

Update the specified reservation id with new nodes to reserve and/or nodes to unreserve.

Input Fields:

Name Description Type
reservationId The unique reservation id
nodesToReserve The nodes to reserve
nodesToUnreserve The nodes to unreserve

Return to top

UpdateTaskBatchCommandInput

InputObject

Describes desired updates for one or more tasks belonging to a single task group. The updates will succeed if the tasks are unassigned. The update may partially succeed if only some tasks are valid for update.

Input Fields:

Name Description Type
taskGroupName The name of the task group which the tasks to update belong to.
updateTaskCommands Describes an update to a single task in the batch.

Return to top

UpdateTaskBatchItemCommandInput

InputObject

Describes desired updates for a single task. The update will succeed if the task is not assigned

Input Fields:

Name Description Type
taskName The name of the task to update.
dueDate Optional. The new due date, in UTC, for the task.
priority Optional. The new priority for the task. A lower number translates to a higher priority.
onHold Optional. A task on hold is ineligible for assignment. This command is the only way to remove the hold from a task.
requiredAgentId Optional. The new required agent ID for the task. If this is set, the task must be assigned to this agent, or not assigned at all.

Return to top

Vector3Input

InputObject

Represents a point in 3D space as a vector with 3 single-precision floating point values

Input Fields:

Name Description Type
x
y
z

Return to top

Vector3TransformInput

InputObject

Represents a transformation specification from one coordinate system to another system.

Input Fields:

Name Description Type
offset
scale
pivotOffset
axisSwap

Return to top

Vector4Input

InputObject

Represents a rotation in 3D space as a vector with 4 single-precision floating point values

Input Fields:

Name Description Type
x
y
z
w

Return to top

Scalar

Boolean

Scalar

Return to top

ByteGraphType

Scalar

Return to top

Date

Scalar

The Date scalar type represents a year, month and day in accordance with the ISO-8601 standard.

Return to top

DateTime

Scalar

The DateTime scalar type represents a date and time. DateTime expects timestamps to be formatted in accordance with the ISO-8601 standard.

Return to top

DateTimeOffset

Scalar

The DateTimeOffset scalar type represents a date, time and offset from UTC. DateTimeOffset expects timestamps to be formatted in accordance with the ISO-8601 standard.

Return to top

Decimal

Scalar

Return to top

Float

Scalar

Return to top

GuidGraphType

Scalar

Return to top

ID

Scalar

Return to top

Int

Scalar

Return to top

Milliseconds

Scalar

The Milliseconds scalar type represents a period of time represented as the total number of milliseconds.

Return to top

Seconds

Scalar

The Seconds scalar type represents a period of time represented as the total number of seconds.

Return to top

Short

Scalar

Return to top

String

Scalar

Return to top

UIntGraphType

Scalar

Return to top

Uri

Scalar

Return to top

UShort

Scalar

Return to top

Interface

TaskModel

Interface

Fields:

1. agentId
  • The id of the agent assigned to this task.
2. agentTypeId
  • The id of the agent type of the agent assigned to the task.
3. assignmentStatus
  • Describes if the task has been assigned to an agent or if it is eligible for assignment.
4. creatingUserId
  • The user id who created the task.
5. creationDate
  • The datetime at which this task was created.
6. dispatchDate
  • The datetime in UTC at which the task was dispatched to an agent.
7. dueDate
  • The datetime by which this task must be complete.
8. endDate
  • The datetime in UTC at which this task completed, failed, or was cancelled.
9. endingUserId
  • The user id who ended the task.
10. endReason
  • The reason a task was ended.
11. executionStatus
  • Describes the execution status of the task. This encompasses whether or not the assigned agent has started the task, if the task has been completed, or if the task has failed for some reason.
12. id
  • The id of the task.
13. missionName
  • If this task belongs to a mission, this field contains the mission's name. If only the mission name is needed, this is a less expensive alternative to querying the mission task field.
14. missionTask
  • If this task belongs to a mission, this field contains the details about the mission task.
15. name
  • The name of the task.
16. onHold
  • If true, this task will not be released for bidding until the OnHold is manually set to false. This feature is used for tasks with external dependencies unknown to Maestro.
17. predecessorTasks
  • The set of tasks which must be completed before this task can execute.
18. priority
  • NonNull
  • Type:
  • The priority of this task over other tasks. Absent other constraints, tasks should be executed in ascending order of their priority. Priority 1 tasks should be executed first, priority 2 tasks second, and so on.
19. repairStatus
  • If this task faulted and is repairable, describes the execution status of the repair task.
20. repairType
  • If this task faulted and is repairable, describes the type of repair used.
21. requiredAgentId
  • Optional. Specifies an agent that MUST be assigned to this task.
22. taskDuration
  • The amount of time in milliseconds it took to complete the task.
23. taskGroup
  • The task group this task belongs to.
24. taskGroupName
  • The name of the task group this task belongs to.
25. taskType
  • The task type of the task.

Return to top

Enum

__DirectiveLocation

Enum

A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.

Enum Values:

Name Description
QUERY Location adjacent to a query operation.
MUTATION Location adjacent to a mutation operation.
SUBSCRIPTION Location adjacent to a subscription operation.
FIELD Location adjacent to a field.
FRAGMENT_DEFINITION Location adjacent to a fragment definition.
FRAGMENT_SPREAD Location adjacent to a fragment spread.
INLINE_FRAGMENT Location adjacent to an inline fragment.
SCHEMA Location adjacent to a schema definition.
SCALAR Location adjacent to a scalar definition.
OBJECT Location adjacent to an object type definition.
FIELD_DEFINITION Location adjacent to a field definition.
ARGUMENT_DEFINITION Location adjacent to an argument definition.
INTERFACE Location adjacent to an interface definition.
UNION Location adjacent to a union definition.
ENUM Location adjacent to an enum definition
ENUM_VALUE Location adjacent to an enum value definition
INPUT_OBJECT Location adjacent to an input object type definition.
INPUT_FIELD_DEFINITION Location adjacent to an input object field definition.

Return to top

__TypeKind

Enum

An enum describing what kind of type a given __Type is.

Enum Values:

Name Description
SCALAR Indicates this type is a scalar.
OBJECT Indicates this type is an object. fields and possibleTypes are valid fields.
INTERFACE Indicates this type is an interface. fields and possibleTypes are valid fields.
UNION Indicates this type is a union. possibleTypes is a valid field.
ENUM Indicates this type is an num. enumValues is a valid field.
INPUT_OBJECT Indicates this type is an input object. inputFields is a valid field.
LIST Indicates this type is a list. ofType is a valid field.
NON_NULL Indicates this type is a non-null. ofType is a valid field.

Return to top

ActiveTaskOverrideState

Enum

Defines the possible end states for an overridden task. Disabled (if the feature is not enabled), Completed, Cancelled, and Faulted

Enum Values:

Name Description
Disabled The agent type is not capable of overriding active tasks.
Completed The agent completed this task successfully.
Faulted The agent did not complete this task due to a fault which could not be recovered from.
Cancelled The agent did not complete this task due to cancellation.

Return to top

AliasableProperty

Enum

The names of properties that can be aliased

Enum Values:

Name Description
AgentId The configuration for aliasing the AgentId
ContainerId The configuration for aliasing the ContainerId
Location The configuration for aliasing the locations

Return to top

AxisSwapEnum

Enum

Enum Values:

Name Description
NONE
XY
XZ
YZ

Return to top

AxisSwapEnumType

Enum

Constants used to denote which axes to swap

Enum Values:

Name Description
XY
XZ
XW
YZ
YW
ZW
XY Swap the X and Y axes
XZ Swap the X and Z axes
XW Swap the X and W axes
YZ Swap the Y and Z axes
YW Swap the Y and W axes
ZW Swap the Z and W axes

Return to top

DayOfWeek

Enum

The days of the week

Enum Values:

Name Description
SUNDAY
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY

Return to top

EventSeverityEnum

Enum

Enumeration that contains possible severities for an event.

Enum Values:

Name Description
Critical The critical event severity.
Error The error event severity.
Warning The warning event severity.
Informational The informational event severity.
Verbose The verbose event severity.

Return to top

FaultSetting

Enum

Enum Values:

Name Description
NONE
PRE_PICK
POST_PICK_PRE_DROP
POST_DROP

Return to top

FinalTaskExecutionStatus

Enum

The final execution state of the task

Enum Values:

Name Description
Completed The agent completed this task successfully.
Faulted The agent did not complete this task due to a fault which could not be recovered from.
Cancelled The agent did not complete this task due to cancellation.

Return to top

ForkDirections

Enum

The possible directions of an agent's forks

Enum Values:

Name Description
Unknown The forks are in an unknown position
Front The forks are in front of the agent
Left The forks are to the left of the agent
Right The forks are to the right of the agent
Both The forks are both to the left and to the right of the agent

Return to top

HostActionCode

Enum

The code used to determine different types of s-message / error codes

Enum Values:

Name Description
FATAL_ERROR_KM
FATAL_ERROR_RAYMOND
OPERATOR_INTERVENTION_REQUIRED_KM
OPERATOR_INTERVENTION_REQUIRED_RAYMOND

Return to top

KollmorgenCarrierErrorCode

Enum

The code used to determine the exact Kollmorgen task execution error

Enum Values:

Name Description
AGV_COMS_DOWN
CARRIER_HAS_NEW_POSITION
CANCELLATION_REQUESTED
CARRIER_IN_SEMI_OR_MANUAL_MODE
CARRIER_IN_LOCAL_MODE
CARRIER_ON_UNKNOWN_SEGMENT
CARRIER_UNKNOWN
SYNCHRONIZATION_PROBLEM
ORIENTATION_MISMATCH
PREVIOUS_COMMAND_NOT_FINISHED
EXIT_SEGMENT_CANNOT_BE_REACHED
INVALID_STATION_A
INVALID_CARRIER_MASK_A
INVALID_STATION_ACTION_A
INVALID_ORIENTATION_A
INVALID_STATION_MASK_A
INVALID_STATION_B
INVALID_CARRIER_MASK_B
INVALID_STATION_ACTION_B
INVALID_ORIENTATION_B
INVALID_STATION_MASK_B
STATION_BLOCKED
STATION_UNREACHABLE
VEHICLE_NOT_IN_AUTO_MODE
ORIENTATION_INCOMPATIBLE
GROUP_TYPE_DOES_NOT_EXIST
GROUP_TYPE_OCCUPIED
PLC_CANNOT_FIND_ACTION_ID
CAUSE_UNKNOWN
PREVIOUS_COMMAND_NOT_COMPLETED
CANNOT_FIND_ENTRY
NO_STATION_ACTION_FOUND
WARM_RESTART_ISSUED
CANNOT_GET_CARRIER_PARAMETERS
CANNOT_GET_STATION_PARAMETERS
CARRIER_POSITION_UNKNOWN

Return to top

OrderStatus

Enum

The current status of the order

Enum Values:

Name Description
ORDER_REJECTED
ORDER_ACKNOWLEDGED_AND_IN_QUEUE
ORDER_FINISHED
ORDER_CANCELLED
INVALID_NUMBER_OF_PARAMETERS
PRIORITY_ERROR
INVALID_STRUCTURE
ORDER_BUFFER_FULL
NOT_ACTIVATED_INDEX
PARAMETER_NUMBER_TOO_HIGH
NOT_ALLOWED_TO_UPDATE
CARRIER_NUMBER_ERROR
INVALID_INDEX_NUMBER
CANCEL_ACKNOWLEDGE
MISSING_PARAMETERS
DUPLICATED_I_KEY
INVALID_FORMAT_CODE
ORDER_CONNECTED_TO_CARRIER

Return to top

RaymondCarrierErrorCode

Enum

The code used to determine the exact Raymond task execution error

Enum Values:

Name Description
FORK_INSERT_OBSTRUCTED
STOP_DISTANCE_INVALID
OPERATION_INVALID
OMPLC_INVALID
CARRIER_LOAD_STATUS_INVALID
TRAVEL_TIMEOUT_EXCEEDED
LIFT_LOWER_TIMEOUT_EXCEEDED
NESTING_OPERATION_TIMEOUT_EXCEEDED
CAMERA_CANNOT_DETECT_PALLET
ADJUSTMENT_OUT_OF_RANGE
PALLET_LIFT_TIMEOUT_EXCEEDED
PALLET_EXTRACT_TIMEOUT_EXCEEDED
PALLET_DROP_VIOLATION
PALLET_PICK_VIOLATION
MINI_MAST_RETURN_TO_RIDE_HEIGHT_TIMEOUT
AUTO_MODE_DROPPED
INTERNAL_ERROR

Return to top

RecommendedAisleExit

Enum

The possible ways for an agent to exit an aisle

Enum Values:

Name Description
NotDefined Recommended aisle exit is not used at this site.
GoStraightAheadAfterExit Go straight ahead after exit.
TurnLeftAfterExit Turn left after exit.
TurnRightAfterExit Turn right after exit.

Return to top

RepairType

Enum

Describes repair strategies for a faulted task.

Enum Values:

Name Description
None The task will not be repaired.
Repair The task will be fully repaired such that the system is in the expected state had the task completed successfully.
Jackpot The task will be repaired such that the system is in a controlled error state which can be recovered autonomously or with operator assistance.

Return to top

ReturnCode

Enum

The codes returned by the TdaProxyServer in response to request telegrams

Enum Values:

Name Description
Ok The telegram was properly handled
ProtocolVersionNotSupported Protocol version not supported
MissionNotFound Mission not found (e.g. illegal mission id)
MissionNotActive Mission not active
MissionNotFinished Mission not finished
IllegalMissionTasksAddedToMission Illegal mission tasks added to mission
MissionTaskNotFound Mission task not found (e.g. illegal TaskId)
MissionTaskCannotBeDeleted Mission task cannot be deleted (e.g. it is being executed or done)
IllegalMissionParameters Illegal mission parameters
MissionEndingNoAppendingOrCompleting Mission shall be ended, mission tasks cannot be appended or completed
MissionTaskCannotBeCompleted Mission task cannot be completed (task has been executed)
IllegalOffsetInMissionTask Illegal offset in mission task, valid range is -1000 – 1000 mm
MissionTaskAbortedByAgent Mission task aborted by agent
UnknownLocation Unknown location
VehicleOccupiedWithMission Vehicle occupied with mission
VehicleNotFound Vehicle not found
VehicleNotAvailable Vehicle not available for new mission
NoNetworkContactWithVehicle No network contact with vehicle
InternalError Internal error

Return to top

TaskAction

Enum

The possible actions that can be performed in a single task

Enum Values:

Name Description
Action Handle the action specified by the Message property
DriveToExit Drive to Exit
DriveVia Drive Via
PalletDrop Pallet Drop
PalletFetch Pallet Fetch
Picking Picking

Return to top

TaskAssignmentStatus

Enum

The status of a task's assignment to a specific agent

Enum Values:

Name Description
New The task was recently received by the assignment service. It has been saved but no other processing has occurred.
NotEligible The task is not eligible for assignment yet. This may be due to incomplete predecessor tasks.
ChildrenEligible The task is not eligible for assignment because it is a non-executable macro task. Its children, however, are eligible for assignment.
Eligible The task is eligible to be assigned an agent for execution.
Assigned The task has been assigned an agent for execution.
Dispatched The task has been dispatched to an agent for execution.
TaskEnded The task has been completed, cancelled, or failed. It can no longer be assigned.

Return to top

TaskBidRejectionCodeEnum

Enum

Describes the reason for rejecting a task.

Enum Values:

Name Description
InvalidTaskType The task bid is rejected because the task's type cannot be handled by the task executer.
NoAgentsAvailable The task bid is rejected because the task executer has no agents available to fulfill the task.
UnreachableLocation The task bid is rejected because the task's location is unreachable by agents managed by the task executer.
NotRequiredAgent The task bid is rejected because the task requires a specific agent id, and the bidder is not that agent.
PlaceOnlyRequired The task bid specified both source and destination locations, but the agent currently has inventory on board and can only complete a place only task.
PlaceOnlyContainerMismatch The agent currently has inventory on board. The task bid specifies a place only task, but the requested container does not match the container currently on board the agent.
RouteNotFound The task bid is rejected because a route to the task could not be resolved.
AgentEStopped The task bid is rejected because the bidding agent is at an emergency stop, and cannot execute tasks.
AgentInManualMode The task bid is rejected because the normally autonomous bidding agent is being controlled manually.
AgentLowBattery The task bid is rejected because the bidding agent's battery is too low to execute tasks.
AgentTaskQueueFull The task bid is rejected because the bidding agent's task queue is at max capacity.
AgentQuarantined The task bid is rejected because the bidding agent is in a quarantined state preventing it from accepting new tasks.
AgentPoorNetworkConnectivity The task bid is rejected because the bidding agent is exhibiting poor network connectivity.
IncorrectAgentService The task bid is rejected because no agents from the service will ever be able to handle the task
NoAgentTypesAvailable The task bid is rejected because no AgentTypes are available
InvalidMissionChildTaskType The task bid is rejected because the mission's child tasks' types are not supported by the AgentType
MissionChildTaskMapMissing The task bid is rejected because no child tasks map was found for the mission
AgentStatusNotReported The task bid is rejected because no standard maestro agent status was found
AgentPaused The task bid is rejected because the agent's standard maestro status indicates the agent is paused
AgentShutdown The task bid is rejected because the agent's standard maestro status indicates the agent is shutdown
AgentPayloadPositionStateMismatch The task bid is rejected because the agent's payload position state is not projected to meet the task's payload position criteria
Other The task bid is rejected for a different reason known only to the task executer. The reason should be described in the task bid rejection.

Return to top

TaskCommissionRejectionCode

Enum

The code representing the reason why a task was not commissioned

Enum Values:

Name Description
AgentNoLongerAvailable The agent proposed by the task executer for the task is no longer available to execute the task.
InventoryReservationFailed The task required an inventory reservation which could not be obtained.
IncorrectAgentService The task commission is rejected because no agents from the service will ever be able to handle the task.
Other The task commission cannot proceed for reasons understood only by the task executer.

Return to top

TaskExecutionStatus

Enum

The execution state of the task

Enum Values:

Name Description
New The task was recently received by the assignment service. It has been saved but no other processing has occurred.
NotEligible The agent assigned to this task is not yet ready to execute it.
Eligible The agent assigned to this task is ready to execute it.
Started The agent assigned to this task has started the task.
Completed The agent completed this task successfully.
Faulted The agent did not complete this task due to a fault which could not be recovered from.
Cancelled The agent did not complete this task due to cancellation.

Return to top

TaskGroupStatus

Enum

The overall state of the task group

Enum Values:

Name Description
New The task group was recently received by the assignment service. It has been saved but no other processing has occurred. It's tasks are not being assigned by the service.
Active The task group is active. The task assignment service is assigning its tasks to agents.
Completed All tasks in the task group have ended, successfully or otherwise.
Cancelled The task group is cancelled. Task assigment will assign no more of its tasks to agents. Tasks previously assigned may still be executing.
Paused The task group is paused. Task assignment will assign no more of its tasks to agents until it returns to an active state. Tasks previously assigned may still be executing.

Return to top

TaskResult

Enum

Enum Values:

Name Description
COMPLETED
CANCELLED
FAULTED

Return to top

TaskSortDirectionEnum

Enum

Enumeration that contains direction for sorting tasks

Enum Values:

Name Description
Ascending Indicates that the sort criterion is ascending.
Descending Indicates that the sort criterion is descending.

Return to top

TaskSortEnum

Enum

Enumeration that contains names of sorting methods

Enum Values:

Name Description
TaskName Sort by task Name.
TaskGroupName Sort by task Group Name.
CreatedDate Sort by task Created Date.
DueDate Sort by task Due Date.
EndDate Sort by task End Date.
AgentId Sort by task AgentId.
AssignmentStatus Sort by task Assignment Status.
ExecutionStatus Sort by task Execution Status.
Priority Sort by task priority.

Return to top

TransferOrderPhase

Enum

The current phase of the order

Enum Values:

Name Description
UNINITIALIZED
ORDER_START
PICK_SYNC
MOVING_TO_PICK_STATION
PICKING
DROP_SYNC
MOVING_TO_DROP_STATION
DROPPING
ORDER_FINISHED

Return to top

TransportStructure

Enum

The type of transport task

Enum Values:

Name Description
PICK_AND_DROP
COMMUNICATION_OPTIONS
MOVE_TO_POINT

Return to top

VehicleStatuses

Enum

The possible statuses of an agent

Enum Values:

Name Description
Assigned The vehicle is assigned to a mission
ExecutingMission The vehicle is executing a mission
Offline The vehicle is offline
Online The vehicle is online
Unknown The vehicle status is unknown

Return to top