# Connector.restCall

## Description

Performs a rest API call using a Rest Connector.

## Input / Parameter

| Name       | Description                                           | Input Type    | Default      | Options                                                   | Required |
| ---------- | ----------------------------------------------------- | ------------- | ------------ | --------------------------------------------------------- | -------- |
| connector  | The Rest Connector to be used.                        | Text          | -            | -                                                         | Yes      |
| path       | The additional path to append to the connector's url. | Text          | -            | -                                                         | No       |
| method     | The http request method.                              | Text          | Get          | Get, Patch, Put, Post, Delete                             | No       |
| query      | The query string for the endpoint.                    | Object        | -            | -                                                         | No       |
| callType   | The content type of the API.                          | Text          | Raw          | Form\_Data, X\_WWW\_Form\_URL\_Encoded, Raw, Binary, JSON | No       |
| headers    | The query string for the endpoint.                    | Object        | -            | -                                                         | No       |
| cookies    | The cookies of the API call.                          | Object / List | -            | -                                                         | No       |
| resultType | The preferred result to return.                       | Text          | String\_UTF8 | String\_UTF8, Byte\_Array                                 | No       |
| body       | The body to pass along in the call.                   | Object / Text | -            | -                                                         | No       |
| attachment | The path to the selected file.                        | Object / List | -            | -                                                         | No       |
| extra      | The stored value that is passed to all the callbacks. | Any           | -            | -                                                         | No       |

### cookies (Object | List)

Cookies of the API call. Will contain a single object, or a list of one (1) or more objects which consist of:

| Key   | Description                       | Input Type | Required |
| ----- | --------------------------------- | ---------- | -------- |
| name  | Name of the cookie.               | Text       | No       |
| value | Contains the value of the cookie. | Text       | Yes      |

### attachment (Object | List)

The path to the selected file. Will contain a single object, or a list of one (1) or more objects which consist of:

| Key   | Description                                              | Input Type | Required |
| ----- | -------------------------------------------------------- | ---------- | -------- |
| name  | Optional name. If not specified, file name will be used. | Text       | No       |
| value | Contains the direct file path of the attachments.        | Text       | Yes      |

## Output

| Description                        | Output Type |
| ---------------------------------- | ----------- |
| Returns the formatted information. | Object      |

### Object

| Key     | Description                                                             | Output Type |
| ------- | ----------------------------------------------------------------------- | ----------- |
| success | Boolean value to denote whether the function was executed successfully. | Text        |
| message | The message to print.                                                   | Text        |
| data    | Any additional message or data to print.                                | Text        |

## Callback

### callback

The action performed if this function runs successfully.

| Description                                             | Output Type |
| ------------------------------------------------------- | ----------- |
| Returns an object with the information of the API call. | Object      |

#### Object

| Key        | Description                      | Output Type |
| ---------- | -------------------------------- | ----------- |
| statusCode | The status code of the API call. | Number      |
| result     | The result of the API call.      | Text        |
| cookies    | The cookies of the API call.     | Object      |

### errorCallback

The action performed if this function runs successfully.

| Description                                             | Output Type |
| ------------------------------------------------------- | ----------- |
| Returns an object with the information of the API call. | Object      |

#### Object

| Key          | Description                                  | Output Type |
| ------------ | -------------------------------------------- | ----------- |
| statusCode   | The status code of the API call.             | Number      |
| errorMessage | The error message for unsuccessful API call. | Text        |

## Video

Coming Soon.

## Example

Coming Soon.

### Steps

Coming Soon.

### Result

Coming Soon.

## Links


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.emobiq.com/emobiq-server/005-function/connector/connector.restcall.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.