Learn about the GitHub GraphQL API, previews for upcoming changes, breaking changes, and limitations. You can also use the GraphQL Explorer to interact with the API on real GitHub data.
Interface Summary
There are 3 primary methods for interfacing with WorkLink system.
Interface | Description |
|---|---|
GraphQL | Flexible and efficient query-driven data-retrieval through an endpoint. For more information, please see https://graphql.org/ |
DeepLinks | Method for launching app and passing parameters through to the platform through a structure URL. “Deferred Deep” linking automatically prompts for app download |
Resource Catalogs | Map internal system |
Example Use Cases
System of Record Integration
Single Session
As an administrator, I want a work order in my system-of-record updated with activity executed through 3D work instructions, so that i have a single source of truth for job completion.
Summary
Clicking a URL in the system of record user interface (in a work order or a training module) launches the WorkLink app and loads the relevant work instructions.
A Work Instruction Session is completed and session data is sent to the CMS
Through a webhook, the system-of-record is notified data is available for the specific record id. System of record queries the GraphQL API to retrieve the data:
email
startedAt
finishedAt
duration
idleDuration
numberOfStepsPossible
numberOfStepsViewed
percentOfStepsViewed
Orchestration
Through the Resource Catalog interface in the CMS, IDs (for asset models) are mapped to sets of Work Instructions
The system of record is configured to generate a dynamic URL with the Asset Model ID and a Work/Job Order ID
The URLs are added to the relevant UI screens in the system or record
Customers configure a “webhook receiver” app to get webhook alerts
Customer system is configured to automatically query the GraphQL endpoint to receive the data based on webhook alerts for the Work/Job Order ID.
All Sessions
Add Comment