Viewing documentation for LN REST APIs
You can review the available documentation for the public services that are part of LN API.
The documentation explains details such as:
- What data/object models the service uses/supports.
- The latter part of the URL path to invoke a specific operation on a specific piece of data.
- Any query-string parameters that are required or optional.
- What HTTP methods, such as GET and POST, to use when.
To view available documentation for the LN REST API:
- In Infor OS Portal, click the button and select to start the API Gateway application.
- In the left-hand navigation panel, select .
- In the right-hand panel, select .
- In the search field above the Description column, type Rest.
- In the row that contains LN/lnapi, click the icon in the Documentation column. The LN REST services are displayed.
- To view the documentation for a service, click the icon in the Documentation column of that service. The methods of the service, such as GET, POST, and. PATCH, are displayed.
- To view details for a method, click that method. Detailed information about the method is displayed, such as the method's parameters and responses.
Note:
- A button is displayed in the upper right corner of the page. This option only works if you are entitled for the service and the service has been activated. If you click the button and then click , a 404 error message is displayed if you are not entitled or the service has not been activated.
- A 404 error message may also be displayed if the tenant is in admin-only mode or in maintenance mode, or if the current ELN release is not supported.
- If the service is not activated, also a 503 error message may be displayed.