Search Results for

    Show / Hide Table of Contents

    Exacta Maestro™ APIs

    Integration with Exacta Maestro™ is tightly coupled to a large collection of standard application programming interfaces, message specifications, file formats, and more. The following links define the specifications for these contracts, sometimes including OpenAPI docs and other formal API documentation.

    Exacta Maestro™ Endpoints

    The bulk of Exacta Maestro™'s external endpoints are exposed over GraphQL, but some of the services expose HTTP APIs (often somewhat RESTful). The GraphQL User Guide provides more information about interacting with the GraphQL endpoints.

    Maestro API Docs:

    Service Type Documentation Spec
    ActionStations HTTP (RESTful) OpenAPI
    AgentHub GraphQL Agent Management Schema
    Aliasing GraphQL Schema
    Inventory GraphQL Schema
    PLC HTTP (RESTful) OpenAPI
    TaskAssignment GraphQL Task Management Schema

    Maestro Export Adapter

    The Maestro Export Adapter is a ServiceFabric application which contains the services Maestro uses to notify consumers.

    Name Documentation
    SignalR Docs

    Standard Agent

    The StandardAgent specification is the preferred framework to use for communication between Maestro and the agents. While Maestro can communicate with a few other agent APIs, the StandardAgent API has the most features, most support, and is overall the most flexible. The specification allows for Maestro to talk directly to an individual agent or to an intermediary server. While usually Maestro acts as the client to a StandardAgent server, Maestro also exposes a StandardAgent Listener for other systems to push state change notifications.

    Name Type Documentation Spec
    StandardAgent HTTPs Docs, API Docs OpenAPI
    StandardAgent Listener HTTPs OpenAPI

    Map

    The Maestro Map service, used for routing and traffic, has an associated map file schema. Tooling should be used to generate Map files during the commissioning phase of each individual project. The StandardAgent specification references the Map file specification, as it is the same map file schema used by Maestro to push the new maps to the agents.

    Name Type Documentation Spec
    Map json Spec Docs
    In This Article