Swagger Interface

Introduction

Swagger UI allows anyone from developers to end consumers to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, with the visual documentation making it easy for back end implementation and client side consumption.

Infor Web Services Hub API

The current version of the Swagger Infor Web Services Hub API can be easily accessed here.

End Points

For the EAM Web Services, the Swagger web interface provides a list of all Endpoints available. These include several Endpoints for the Work Orders, Equipments, Grids, Issue Returns, Parts, Lot, Store Bin and Comments. The possible actions for the several EAM Endpoints can be seen below by selecting the corresponding tab.

Work OrdersEquipmentGrid RequestsIssue ReturnsParts & LotStore Bin & Comments

The Work Orders' Endpoints can be divided into two categories: the General ones containing the actions for Single or Multiple Work Orders or the Activity and Labor Booking's ones.

General

Action	Single Order	Multiple Order
GET	/workorders/{number} reads a work order	/workorders/list/{workorders} reads multiple new work order
POST	/workorders creates a new work order	/workorders/list creates multiple new work order
DELETE	/workorders/{number} deletes a work order	/workorders/list deletes multiple new work order
PUT	/workorders/{number} updates a work order	/workorders/list updates multiple new work order

Activity & Labor Bookings

Action	Activity	Labor Bookings
GET	/workorders/activities/{number} reads a work order activity	/workorders/laborbookings/{number} reads a work order labor
POST	/workorders/activities/{number} creates a work order activity	/workorders/laborbookings/{number} creates a work order labor
DELETE
PUT	/workorders/activities/{number} updates a work order activity

The Equipment' Endpoints include the access to Individual or Multiple Equipment as well as their Structure.

Action	Single Equipment	Multiple Equipment	Structure
GET	/equipment/{code} reads an equipment	/equipment/list reads multiple equipment
POST	/equipment/ creates an equipment	/equipment/list creates multiple equipment	/equipmentstructure attach equipment
DELETE	/equipment/{code} deletes an equipment	/equipment/list deletes multiple equipment
PUT	/equipment/{code} updates an equipment	/equipment/list updates multiple equipment	/equipmentstructure update structure

The Grid Requests' Endpoints include the access to Individual or Multiple Grid Requests.

Action	Single Grid	Multiple Grids
GET
POST	/grids/{gridName}/data executes a grid request	/grids/data executes multiple grid requests
DELETE
PUT

The Issue Return Part Transactions' Endpoints include the access to Individual or Multiple Issue Return Part Transactions.

Action	Single Issue Return	Multiple Issue Return
GET
POST	/issuereturnparttransaction creates an issue return part transaction	/issuereturnparttransaction/list creates multiple issue return part transaction
DELETE
PUT

The Parts' Endpoints allow to retrieve and change information regarding a part and the Lots' Endpoints allow to retrieve and change information regarding a Lot.

Action	Parts	Lot
GET	/parts/{number} reads a part
POST	/parts creates a part	/lot creates a lot
DELETE	/parts/{code} deletes a part
PUT	/parts updates a part

The Store Bin's Endpoints allow to retrieve and change information regarding a Store Bin and the Comments' Endpoints allow to retrieve and change Comments.

Action	Store Bin	Comments
GET	/storebin/read reads a store bin	/comments/{entityCode}/{entityKeyCode} reads a comment
POST	/storebin/create creates a store bin	/comments/{entityCode}/{entityKeyCode} creates a comment
DELETE	/storebin/delete deletes a store bin
PUT	/storebin/update updates a store bin	/comments/{entityCode}/{entityKeyCode} update a comment

How to Use

When an Endpoint is selected, the user will be prompted to enter all of the information needed for the completion of the operation. This information includes specifying a Request Body, provide Codes, the Username and Password and so on. An example of a Request Window can be seen in Figure 1.

Figure 1: Settings for performing an Action at an Endpoint

After executing the Endpoint Request, the user will receive a Curl Equivalent, the Request URL, a code for the Response Body and the Response Body of the query itself. On Figure 2, we can see a typical Response to a Query at an Endpoint.

Figure 2: Example of a Response to a query at an Endpoint

The response is classified by a Code which indicates if the request was valid and executed correctly or not. The possible Codes for the Response are listed below:

Code	Description
200	Success in retrieving a Response to the query
400	Error in retrieving a Response to the query
500	Server Error in retrieving a Response to the query

Next Section

---

Last update: August 22, 2024