Rest Service Wizard

Rest Service Wizard is used to create a new Rest Resource or add Rest Services to an existing resource in TIBCO Business Studio™ for BusinessWorks™.

The Rest Service Wizard has the following fields:

Field Description
Resource Name The name of the REST Resource.
Summary The summary or description of the REST Resource.
Resource Service Path The relative path for this REST Service Resource.

If an application contains multiple REST bindings, ensure that the location of the path parameters is unique for each REST binding.

For example, one REST binding is using the paths /book/{isbn} and another REST binding is using the path /book/{authorid}. Since {isbn} and {authorid} are defined at the same location in the URI , one of these services will not function correctly.

In addition to path parameters, the path in a REST binding can also contain query parameters. For example,

/resource/path/{pathparam}? query={queryparam} or /resource/path/{pathparam}?{ queryparam}

Resource Definition The XSD schema element to be used for creating the REST resource.

You can also use this to create the input and output of each operation defined. You can override this on the next screen if required, for each operation.

Operations These are the HTTP methods implemented by this REST Service.

Currently POST, GET, PUT, PATCH, DELETE, OPTIONS, HEAD, and custom methods are supported for users to implement.

Note: You can add custom operations by clicking on the Add Custom Operation button.
Implementation Data The implementation data field can be Structured or Opaque.
  • Structured: The XSD element structure is preserved for the input and output of every operation. You need not manually parse the payload to generate the actual element to be used in the process.
  • Opaque: Use this mode to apply the pass through mechanism. A user gets a messageBody element in the input or output of every operation and needs to use either parse activities for JSON or XML to get a structured output for the payload.

Note: To add additional services to a process, click Create A Rest Service on the top left of the process canvas.

Note: Re-creating a component containing a REST binding after deleting the component is not supported. To add the REST binding, in the process editor, right click on the service without a binding. Go to Components > [componentware] > Create REST Binding. A binding is created for the service. The binding has to be re-configured as the previous configurations are lost.