Creating a REST Off-Ramp - EIS Workflow Messaging - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external - OnBase/EIS-Workflow-Messaging/Foundation-24.1/EIS-Workflow-Messaging/Configuration/Off-Ramps/REST-Off-Ramps/Creating-a-REST-Off-Ramp - 2024-03-25

EIS Workflow Messaging
Platform
OnBase
Product
EIS Workflow Messaging
Release
Foundation 24.1
License

To create a REST off-ramp:

  1. Connect to the appropriate repository in OnBase Studio.
  2. Launch the Create Off-Ramp wizard by doing one of the following:

    • Click the REST Off-Ramp button in the Integration Services ribbon.

    • Right-click the HIS Off-Ramp node in the Integration Services tab of the Repositories pane, then select New | REST.

    The Create Off-Ramp wizard is displayed.
  3. Enter the name of the off-ramp in the Name field.
  4. Enter a description for the off-ramp in the Description field.
  5. Click Next. The operations page is displayed.
  6. Enter the base URI in the Base URI field. This is the common URI for all operations in the off-ramp (for example, http://localhost:5000). This value is limited to 249 or fewer characters.
  7. Click Add to configure and add an operation to the off-ramp. The Add REST Operation dialog box is displayed.
  8. Enter a name for the operation in the Operation Name field.
  9. Using the HTTP Method drop-down list, select the HTTP request method to be used in the operation. The following HTTP methods are available:

    • GET

    • POST

    • PUT

    • PATCH

    • DELETE

    • HEAD

    • OPTIONS

    • CONNECT

    • TRACE

  10. Enter the URI for the operation in the URI field. This is the resource URI of the specific operation (for example, /sample/messages).
  11. Click OK to add the operation.
  12. Add any additional operations to the off-ramp as needed, and then click Next. The Summary page is displayed.
  13. Review the summary and click Finish.