Custom-Built Web Services Input Parameters

Fabric lets you pass input parameters to the custom-built web services, with various ways to define it and with a flexibility when passing them.

Defining The Input Parameters

Fabric provides easy methods to define the expected input parameters for a web service, either Graphit or Java function. For each of the parameters you can define its name, type and whether it is mandatory.

To learn how to define input parameters for Graphit - read here

Transferring The Input Parameters

Input parameters can be transferred to the project custom-built Web Services either as:

• Standard web service parameters, according to the verb
• A part of the URL path

For POST and PUT verb methods, parameters shall be transferred in the request body and yet, Fabric knows to use URL based parameters also for these verb methods.

Transferring Input Parameters as Standard web service parameters

When input parameters are not set as a part of the URL path, transfer them according to the web service verb (method).

For GET verb - it looks like this pattern: /api/[VERSION_NO]/<Web-Service name>?[param1 name]=[param1 value]&[param2 name]=[param2 value]...&

For example:

http://localhost:3213/api/v1/wsMigrateStatsParams?i_migrateId=dca63eda-1553-40b7-b2e8-ae098b3c2c04&i_runMode=S

When calling to web services set with PUT and POST verbs, parameters shall be sent in the request body.

Transferring Input Parameters As a Part of the URL Path

Input parameters can be a part of a request URL path, by adding them to the path wrapped in curly brackets. For example, for a WS named 'demo' with x & y parameters, use 'demo/{x}/{y}', where request call can be: "demo/1/2" (x=1, y=2).

A combination of the 2 methods can be used as well, e.g. "demo/{x}?y=".

To define it for Graphit:

1. Click on the icon at the top Graphit Editor toolbar.

2. Edit the Override Path section.