Skip to content
Last updated:

Use Schema

Record the request and response payload of each interface, starting from what Integration Mapper detects.

Schema keeps the payload contract of each interface: what it receives and what it returns. The contract is shared by everyone in the environment. For iFlows, ERP interfaces and API proxy resources, Schema also shows a payload detected from the design, which you can adopt with one click.

The sidebar lists everything by group: CPI iFlows, APIM Proxies, Event Mesh, ERP and the external interfaces, with packages and systems as sub-headers. Search it by name. An item turns green when it has a saved contract.

API proxies expand into their resources, each with its own contract.

ItemSource
iFlowIts design: the WSDL or XSD files, the message mapping, the XSLT or the Groovy scripts. It is read at each Discovery sync, and what you see is an example built from the detected fields.
ERP interfaceThe iFlow that calls it, or Detect via mapping, which looks for an XSLT, message mapping or Groovy script in up to 5 iFlows linked to it. A result from Groovy needs Approve or Reject.
API proxy resourceThe Swagger the proxy publishes in API Management, with its parameters and each documented response. Needs an API Management credential.
Queues, topics and other interfacesNo detection: write the contract yourself.
  1. Select the item.
  2. Click Use as my contract to start from the detected payload, or Write my own to type or paste it.
  3. Optionally choose JSON or XML for highlighting, and Format to indent JSON.
  4. Click Save.

For an API proxy resource, expand each response status and document it the same way.

Delete removes the contract after you confirm.

  • A contract is saved for everyone in the environment, and anyone with access can change or delete it. There is no history of earlier versions, and the last save wins.
  • Unsaved edits are lost when you select another item.
  • Explorer shows whether an iFlow has a contract, Projects can reference contracts, and Mapper AI can tell whether an interface has one.
  • New items appear after you reload the page.