REST Client Paths Configuration (Magic xpi 4.13)

Path is a part of the RESTful URL. Path along with other parameters will be appended to server URL in order to form complete RESTful API invocation URL.

Clicking the Paths button will open a window with two panes. The pane on the left side will allow the user to add, remove or copy and duplicate Path Names. The user can define dynamic path parameters by enclosing the path parameters' names within curly braces ({}). For example, Product/{id}/customers. The user can set the values for dynamic path parameters in the Data Mapper.

The characters [space] < > | \ ^~ # % are not allowed in Paths. The Path parameters should be enclosed in {}.

The pane on the right side will allow the user to configure Query Parameters, Header Parameters and Form Parameters. Here, the user can use the up and down arrow keys to select the parameter and edit the value.

When a copy of a Path name is created on the left pane, the values of the related parameters also get copied and duplicated. The duplicate path is created with the name same as the existing path name suffixed with the text _Copy. The Query Parameters, Header Parameters and Form Parameters linked to the path name are also duplicated during the Copy operation.

The configuration is completed on pressing the OK button and aborted on pressing the Cancel button.

1. Query Parameters:

The Query Parameters tab lets the user view and configure the following parameters:

Parameter Name	Description
Name	Enter the Query Parameter name.
Default Value	Provide the default value.

The Add button adds a new Query Parameters line.

The Delete button deletes the highlighted Query Parameters line.

2. Header Parameters:

The Header Parameters tab lets the user view and configure the following parameters:

Parameter Name	Description
Name	Enter the Header Parameter name.
Default Value	Provide the default value.

The Add button adds a new Header Parameters line.

The Delete button deletes the highlighted Header Parameters line.

3. Form Parameters - Request:

The Form Parameters - Request tab lets the user view and configure the following parameters:

Parameter Name	Description
Name	Enter the Form Parameter - Request name.
Part Type	This is a multi-select grid field. Click to open the Part Type. The supported Part Types are: Attachment Text If the part type is selected as Attachment, the path to the attachment location has to be provided in the Data Mapper. The user will be able to map the attachment value in the Data Mapper while configuring the RESTClient step. While mapping the field in the Data Mapper, since the field is of type Alpha, the file path of the attachment location has to be provided and not the actual attachment binary (Blob) contents.
Content Type	This is a multi-select grid field. Click to open the Content Type. Alternatively, the user can Add or Delete other Content Types. The supported Content Types are: Application/pdf Application/json Application/xml Image/jpeg Image/png Multipart/form-data Text/plain Text/html Text/xml
Encoding	This is a multi-select grid field. Click to open Encoding. Alternatively, the user can Add or Delete other Encodings. The supported Encoding are: Binary UTF-8

The Add button adds a new Form Parameter - Request line.

The Delete button deletes the highlighted Form Parameter - Request line.

4. Form Parameters - Response:

The Form Parameters - Response tab lets the user view and configure the following parameters:

Parameter Name	Description
Name	Enter the Form Parameter - Response name.
Part Type	This is a multi-select grid field. Click to open the Part Type. The supported Part Types are: Attachment Text If the part type is selected as Attachment, the path to the attachment location has to be provided in the Data Mapper. The user will be able to map the attachment value in the Data Mapper while configuring the RESTClient step. While mapping the field in the Data Mapper, since the field is of type Alpha, the file path of the attachment location has to be provided and not the actual attachment binary (Blob) contents.
Content Type	This is a multi-select grid field. Click to open the Content Type. The supported Content Types are: Application/pdf Application/json Application/xml Image/jpeg Image/png Multipart/form-data Text/plain Text/html Text/xml
Encoding	This is a multi-select grid field. Click to open Encoding. The supported Encoding are: Binary UTF-8

The user will be able to overwrite the default values for the Form Parameters in the destination pane of the Data Mapper after adding the Rest Client step.

The Add button adds a new Form Parameter - Response line.

The Delete button deletes the highlighted Form Parameter - Response line.

Newly added or removed Query and Header parameters in the resource will not automatically update in the existing steps until the user selects the existing step and opens the parameter window. To reflect the newer changes in the existing step, the user has to select the existing step and reopen the parameter window. If the existing Query and Header parameters values are modified after creating the steps, then the modifications will not reflect in the existing steps. If the Form Parameters are modified at the Resource level, then the schema needs to be refreshed for the existing steps.