GET Request
Description
Creates a get request to a rest service
Input Ports
Name | dataType | sourceType | required | description |
---|---|---|---|---|
Request URL | text | link-manual | true | The path to the rest service |
Headers | dataItem | link-manual | false | Headers are an important part of the API request and response as they represent the meta-data associated with the API request and response. |
Query | dataItem | link-manual | false | These options are being appended to the Request URL |
Header options
Type | Description |
---|---|
Authorization | Carries credentials containing the authentication information of the client for the resource being requested. |
WWW-Authenticate | This is sent by the server if it needs a form of authentication before it can respond with the actual resource being requested. Often sent along with a response code of 401, which means ‘unauthorized’. |
Accept-Charset | This is a header which is set with the request and tells the server about which character sets are acceptable by the client. |
Content-Type | Indicates the media type (text/html or text/JSON) of the response sent to the client by the server, this will help the client in processing the response body correctly. |
Cache-Control | This is the cache policy defined by the server for this response, a cached response can be stored by the client and re-used till the time defined by the Cache-Control header. |
- If the service requires a
JWT Token
to authenticate, you are required to specify theAuthotization
header value with aBearer
token.
Query parameters
- The query data-items are the where clause of your get request, the data-items specified must exist for it to take effect.
Scenarios
- The user wants to get rows with a where clause from a server
- The user wants to get all the rows from a server
Use case
Experienced tips
- If the rest service is public, it is not required to specify the
JWT token
inside of theHeaders
- If you want to get all the rows, leave the query parameters empty
Search Tags
Get rows with a rest request