Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Send Requests
• Conventions
• Authentication
• Status Codes
• Error Messages
• Collections
• Use cURL
• Using mongoDB Query Syntax

Tasks

• API Versions
  • View Available API Versions
  • View Information about Version 2 of the API
• Factories
  • Create factory
  • Delete factory by ID
  • Replace factory by ID
  • Retrieve all factories
  • Retrieve factory by ID
  • Retrieve factory count
  • Retrieve factory metrics by ID
  • Retrieve Out-of-Box Factory Dashboard metrics
  • Update factory by ID
• Factory Maintenances
  • Retrieve all factory maintenance configs
  • Retrieve factory maintenance config by config ID
  • Retrieve factory maintenance config by factory ID
  • Retrieve factory maintenance config count
• Incidents
  • Add comments to incident
  • Delete incident by ID
  • Get Incidents Count
  • Retrieve all incidents
  • Retrieve count of incident occurrences by ID
  • Retrieve incident by ID
  • Retrieve incident occurrences by incident ID
  • Update incident by ID
• Machine Types
  • Create machine type
  • Delete machine type by ID
  • Replace machine type by ID
  • Retrieve all machine types
  • Retrieve machine type by ID
  • Retrieve machine type count
  • Update machine type by ID
• Machines
  • Create machine
  • Delete machine by ID
  • Replace machine by ID
  • Retrieve all machines
  • Retrieve machine by ID
  • Retrieve machine contextual data for sensor graph
  • Retrieve machine count
  • Retrieve machine incidents by ID
  • Retrieve machine metrics by ID
  • Update machine by ID
• Operator Types
  • Create operator type
  • Delete operator type by ID
  • Get all operator types
  • Replace operator type by ID
  • Retrieve operator type by ID
  • Retrieve operator type count
  • Update operator type by ID
• Operators
  • Create operator
  • Delete operator by id
  • Get all operators
  • Get operator by id
  • Get operator count
  • Replace operator by id
  • Update operator by id
• Production Lines
  • Retrieve all production lines
  • Retrieve production line by ID
  • Retrieve production line count
• Production Plans
  • Add production output details
  • Delete a given production plan
  • Delete all production plans
  • Retrieve all production plans
  • Retrieve production plan count
  • Retrieve production plan information
• Products
  • Create product
  • Delete product by ID
  • Replace product by ID
  • Retrieve all products
  • Retrieve digital birth certificate
  • Retrieve product by ID
  • Retrieve product count
  • Update product by ID
• Routing Tasks
  • Retrieve all routing tasks
  • Retrieve routing task by ID
  • Retrieve routing task count
• Rules
  • Create rule
  • Delete rule by ID
  • Get Rules Count
  • Retrieve all rules
  • Retrieve rule by ID
  • Update rule by ID
• Warnings
  • Delete warning by ID
  • Get Warnings Count
  • Retrieve all warnings
  • Retrieve warning by ID
  • Update warning by ID
• Work Orders
  • Create work order
  • Delete work order by ID
  • Replace work order by ID
  • Retrieve all operation tasks
  • Retrieve all work order operations
  • Retrieve all work orders
  • Retrieve operation task by ID
  • Retrieve operation task count
  • Retrieve work order by ID
  • Retrieve work order count
  • Retrieve work order operation by ID
  • Retrieve work order operation count
  • Update work order by ID