Testing LN REST API services using the Try It Out feature

You can test the methods of an activated service in the cloud. To do so, you can send test requests from the API documentation.

To test a method of an activated service:

  1. In Infor OS Portal, click the Navigation Menu button and select Applications > OS > API Gateway.
  2. In the left-hand navigation panel, select Available APIs.
  3. In the right-hand panel, select Infor LN.
  4. In the search field above the Description column, type Rest.
  5. In the row that contains LN/lnapi, click the icon in the Documentation column. The LN REST services are displayed.
  6. Locate the service you have activated.
  7. Click the icon in the Documentation column of the service. The methods of the service, such as GET, POST, and. PATCH, are displayed.
  8. Click the method to test. Detailed information about the method is displayed, such as the method's parameters and responses.
  9. Click the Try it out button in the upper right corner of the page. Several parameters for the method are displayed.
  10. Specify the appropriate values for the parameters.
    Note: 
    • In the X-Infor-LnCompany field, specify a company number for which the service has been activated.
    • Ensure the X-Infor-LnIdentity field is blank. To send a basic test request, this field must be blank.
    In a later stage, you might want to send more advanced requests that apply identity switching. If identity switching has been configured in LN, you can specify an identity tag in this field. See Identity switching.
  11. If applicable, complete the body of the request.
    The content of the request body depends on the type of request:
    • For GET and DELETE requests, the body is typically empty.
    • For PATCH requests, you must specify the new values for the properties you want to update. For example, for a PATCH request for a purchase order line, you can specify new values for the OrderedQuantity, PurchaseUnit, ConfirmedReceiptDate, and Price properties.
    • For PUT requests, you must specify the new values for all properties.
    • For POST requests, you must specify the required action parameters. For example, for a POST request to approve a purchase order, you must specify the ApplyApprovalRules, CheckAmountUpto, and CheckAmountUptoCurrency parameters.
  12. Click Execute.
Note: 
  • The Try it out option only works if you are entitled for the service and the service has been activated. If you click the Execute button when you are not entitled or the service has not been activated, a 404 error message is displayed.
  • 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.