Learn about the GitHub GraphQL API, previews for upcoming changes, breaking changes, and limitations. You can also use the GraphQL Explorer available ways to interact with the API on real GitHub dataWorkLink platform with sample use cases and orchestration approaches.
Interface Summary
There are 3a a few primary methods for interfacing with WorkLink system.
...
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.
Application
Get data from a work instruction session and attach it to a particular job ID in the customer’s system of record.
Functional 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.
...
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 (Sample):
| Code Block |
|---|
email
startedAt
finishedAt
duration
idleDuration
numberOfStepsPossible
numberOfStepsViewed
percentOfStepsViewed |
...
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
Summary
As an administrator, I want aggregate data for Work Instruction Sessions so that I can merge it with data from my system of record to calculate KPI and ROI metrics.
Call Integration (Coming Soon)
...
As an expert, I want an easy way to launch a call from our service desk application so that it’s associated with
...
Upcoming Changes
Additional data sets including Scenario Session details
Better filtering of data
...