Published REST Path Parameters

Last modified: December 3, 2024

Introduction

The operation path in the published REST operation specifies the last part of the location (URL) of the operation.

You can use one or more path parameters to capture part of the location as a microflow parameter. Specify path parameters in the operation path between { and }.

Whatever is in the URL at the place of the path parameter will be is passed to the microflow, the import mapping, or both.

These are the requirements for path parameters:

  • You cannot use the same path parameter twice in an operation path.
  • Path parameter names cannot contain curly braces ({ or }).
  • Path parameters can only have primitive types (Boolean, date and time, decimal, enumeration, integer/long, or string).
  • Path parameters can only appear between slashes (/) in the path.

When generating a new microflow from the published REST operation editor window, the resulting microflow will have string parameters for each of the path parameters specified in the operation path. If you want the path parameters to be of a different type, you can change the type in the microflow.

Date and time parameters should be entered in the ISO-8601 format (for example, 2018-12-31T09:00:00).