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 do 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.
|
