# REST Client

The REST Client component allows users to interact with RESTful web services by making HTTP requests and receiving responses. Users can specify the HTTP method, URL, headers, and body of the request, and handle the response based on its content type. The REST Client component is commonly used in data integration workflows to retrieve or post data to external systems via RESTful APIs.

<div align="left"><img src="https://support.xnarum.com/download/manuals/ISM-Manual-2023.fld/image302.png" alt="Shape

Description automatically generated with low confidence"></div>

## **Input**

&#x20;

<table><thead><tr><th width="228">Attribute</th><th>Description</th></tr></thead><tbody><tr><td>URL</td><td>Service Endpoint</td></tr><tr><td>Service System Id</td><td><p>HTTP System Id</p><p>Get authentication information from the predefined system</p></td></tr><tr><td>Method</td><td><p>HTTP Method</p><p>GET/POST/PUT/DELETE</p></td></tr><tr><td>Authentication</td><td><p>Authentication Type</p><ul><li>None</li><li>Basic</li><li>Digest</li><li>Custom</li></ul></td></tr><tr><td>Linked Data Structure Id</td><td>Input data structure. This id is used to generate input data through mapping.</td></tr><tr><td>Request Format</td><td><p>Request Content-Type</p><ul><li>JSON</li><li>XML</li><li>Form Parameter</li></ul></td></tr><tr><td>Response Format</td><td><p>Request Content-Type</p><ul><li>JSON</li><li>XML</li></ul></td></tr><tr><td>Timeout</td><td>Service timeout(sec). The default value is 30 seconds.</td></tr><tr><td>Input Data</td><td>The name of the input parameter or contents</td></tr></tbody></table>

### HTTP Method

<table><thead><tr><th width="245">Method</th><th>Description</th></tr></thead><tbody><tr><td>GET</td><td>The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.</td></tr><tr><td>POST</td><td>The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.</td></tr><tr><td>PUT</td><td>The PUT method replaces all current representations of the target resource with the request payload.</td></tr><tr><td>DELETE</td><td>The DELETE method deletes the specified resource.</td></tr></tbody></table>

&#x20;

### Authentication Type

<table><thead><tr><th width="246">Type</th><th>Description</th></tr></thead><tbody><tr><td>Basic</td><td>Please refer to <a href="https://support.xnarum.com/download/manual.php">this chapter</a>.</td></tr><tr><td>Digest</td><td>Please refer to <a href="https://support.xnarum.com/download/manual.php">this chapter</a></td></tr><tr><td>Custom</td><td> </td></tr></tbody></table>

&#x20;

## **Output**

&#x20;

<table data-header-hidden><thead><tr><th width="241"></th><th></th></tr></thead><tbody><tr><td>Attributes</td><td>Description</td></tr><tr><td>ResponseCode</td><td>HTTP Response code</td></tr><tr><td>InputMessage</td><td>Request message sent to the service</td></tr><tr><td>OutputMessage</td><td>Response message returned from the service</td></tr><tr><td>DataStructureId</td><td>Data structure id for mapping</td></tr></tbody></table>

&#x20;

&#x20;

## **Example**