Getting started and configuration

Use the REST API integration feature that is enabled by default for Service Definition Framework.

Supported capabilities

The REST API integration supports the following HTTP methods and payload formats.

Supported HTTP methods

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Supported payload formats

  • JSON
  • XML
Important:

JSON support configuration

To use JSON input/output in service flows, you must configure one of the following:

Option 1: Add the service to the JSON wrap property:

yfs.xmljson.wrapjson.forflows=YourServiceName,AnotherService

Option 2: Configure the service as an MCP Tool. JSON is default for MCP Tools.

Only API Component, Kafka, and JMS sender/receiver support JSON in service flows.

Basic configuration

You can dynamically resolve the following configuration elements:

  • Headers
  • Query parameters
  • URL segments
  • OAuth configuration such as client ID, client secret, and OAuth URL

Using:

  • System properties - supported for all fields including OAuth
  • XML XPath - for headers, parameters, URL
  • JSONPath - for headers, parameters, URL
  • Incoming request context - headers and query params
Note: OAuth configuration fields such as client ID, secret, and URL can be resolved using ${property} syntax.

Configuration elements

Table 1. REST API configuration elements
Element Purpose
URL REST endpoint
Method HTTP method
Headers Custom request headers
Parameters Query parameters
Authentication OAuth / None via dropdown
Timeout API timeout - optional