REST API

<<- Back to Home

• APIs need to be enabled using the User Interface before use.
• The APIs will contain a Rate Limitor so excessive polling of the API is discouraged. You should instead use MultiPlug's Event Architecture.
• This work was completed under issue #17 to support OEM Manufacturing Equipment Integration.

HTTP Response Codes for all APIs

• 403 Forbidden - API Not Enabled
• 503 Service Unavailable - The Multiplug software is Starting or Shutting down

Known Issues

• See MultiPlug issue #66

Index

• Lanes List
• Upstream
• This Station
• Downstream
• Scan Station
• Inspection Station
• Power Off or Cycle the hardware device

REST URLs

Lanes

• GET /lanes/

Upstream

SMEMA	Boards	Hermes
GET POST /up/smema/	GET /up/boards/all/	GET /up/hermes/servicedescription/
	GET /up/boards/forecast/	POST /up/hermes/connection/restart

This Station

SMEMA	Boards	Hermes
GET /this/smema/	POST /this/boards/new/	GET /this/hermes/servicedescription/
GET /this/smema/up/	POST /this/boards/delete/
GET /this/smema/down/	GET /this/boards/all/
	GET /this/boards/first/
	GET /this/boards/last/
	GET /this/boards/query/

Downstream

SMEMA	Boards	Hermes
GET /down/smema/	POST /down/boards/delete/	GET /down/hermes/servicedescription/
POST /down/smema/good/	GET /down/boards/all/	POST /down/hermes/connection/restart
POST /down/smema/bad/	GET /down/boards/first/
	GET /down/boards/last/
	GET /down/boards/query/

Scan Station

Boards
POST /scan/boards/new/
POST /scan/boards/delete/
GET /scan/boards/all/
GET /scan/boards/first/
GET /scan/boards/last/
GET /scan/boards/query/

Inspection Station

Boards
POST /inspection/boards/delete/
GET /inspection/boards/all/
GET /inspection/boards/first/
GET /inspection/boards/last/
GET /inspection/boards/query/
GET POST /inspection/boards/action/

Power

• POST /power/restart/
• POST /power/shutdown/