Mapping REST Parameters with HTTP Client Snap
This topic provides a comparison of parameter mappings between REST Snaps and the equivalent HTTP Client Snap methods.
REST Get
| REST GET Snap | HTTP Client Snap (GET Request Method) | Limitations in HTTP Client Snap in comparison with the REST Get Snap |
|---|---|---|
| Service URL | URI | |
| Process array | N/A — The Process array field is not available in the HTTP Client Snap. | The Process array field is not available in the HTTP Client Snap. |
| Trust all Certificates | Client Settings > Connection > Trust all certificates | -- |
| Follow redirects | Client settings > Redirects > Follow redirects | -- |
| Query Parameters | Query Parameters | -- |
| HTTP header | HTTP headers | -- |
| Response entity type Value = Default Value = TEXT Value = BINARY |
Client settings > Output > Response type
|
-- |
| Cookie policy | Client settings > Connection > Cookie policy | -- |
| Read timeout | Client settings > Connection > Read timeout (seconds) | -- |
| Connection timeout | Client settings > Connection > Connection timeout (seconds) | -- |
| Maximum retry attempts | Client settings > Retry > Maximum Attempts | -- |
| Retry request interval | Client settings > Retry > Retry interval (seconds) | -- |
| Retry policy | Client settings > Retry > Retry condition | -- |
| Normalize URL | N/A — The Normalize URL field is not available in the HTTP Client Snap. | The Normalize URL field is not available in the HTTP Client Snap. |
| Has next | Pagination > Has next | When the Pagination URL is provided, the Page size is set to 0 in
the HTTP Client Get request. Note: The HTTP Client Snap writes an
output document after evaluating Pagination Properties.
Therefore, when snap.out.totalCount is used, it
is not evaluated correctly. We have addressed this limitation as
part of the script by updating it to
snap.out.totalCount+1 for pagination
properties. |
| Next URL | Pagination | -- |
| Pagination interval | N/A | -- |
| Show all headers | Enable debug | -- |
REST Post
| REST POST Snap | HTTP Client Snap (POST Request Method) | Limitations in HTTP Client Snap in comparison with the REST Post Snap |
|---|---|---|
| REST POST snap | Request method: Post | -- |
| Service URL | URI | -- |
| HTTP Entity |
Entity type: The HTTP Entity type that you use to send to the endpoint supports the following data:
|
When single file upload and multi-file upload are selected and the Upload body type is multipart form-data, two upload requests occur as part of the REST POST snap, but after migration, only one request will be sent that includes both single file upload and multi-file upload. |
| Batch Size | N/A | There is no property available for Batch Size in the HTTP Client Snap. |
| Show all headers | Enable debug | -- |
| Single file upload: File | There is no option available to provide the upload file Name for both single-file and multi-file uploads; the HTTP Client uses the uploaded file name internally. | |
| Single file upload: File Key | ||
| Single file upload : Filename to be used | NA | |
| Upload transfer request type | N/A | There is no property available for Upload transfer request type; the HTTP Client Snap calculates content length internally. |
| Upload body type | N/A | |
| Single file upload: Multipart Content-Type | ||
| File Upload.Multipart Type | HTTP entity > Multipart form > Type | |
| File Upload.Multipart Key | HTTP entity > Multipart form > Key | |
| File Upload.Multipart Value | HTTP entity > Multipart form > Value | |
| File Upload.Http Entity | ||
| File Upload.Filename to be used | ||
| File Upload.Multipart Content-Type | HTTP entity > Multipart form > Content Type | |
| Trust all Certificates | Client Settings > Connection > Trust all certificates | |
| Follow redirects | Client settings > Redirects > Follow redirects | |
| Query Parameters | Query Parameters | |
| HTTP header | HTTP headers | |
| Response entity type Value = Default Value = TEXT Value = BINARY |
Client settings > Output > Response type
|
|
| Cookie policy | Client settings > Connection > Cookie policy | |
| Read timeout | Client settings > Connection > Read timeout (seconds) | |
| Connection timeout | Client settings > Connection > Connection timeout (seconds) | |
| Maximum retry attempts | Client settings > Retry > Maximum Attempts | |
| Retry request interval | Client settings > Retry > Retry interval (seconds) | |
| Retry policy | Client settings > Retry > Retry condition | |
| Normalize URL | N/A | There is no property available for Normalize URL in the HTTP Client Snap. |
REST Put
| REST PUT Snap | HTTP Client Snap (PUT Request Method) |
|---|---|
| REST PUT snap | Request method is PUT |
| Service URL | URI |
| HTTP Entity | Entity type |
| Batch Size | N/A — There is no property available for Batch Size in the HTTP Client Snap. |
| Show all headers | Enable debug |
| Upload transfer request type | NA |
| File Upload.Multipart Type | HTTP entity > Entity type > multipart |
| File Upload.Multipart Key | HTTP entity > Entity type > multipart > Multipart form > form-data > Text > Key |
| File Upload.Multipart Value | HTTP entity > Entity type > multipart > Multipart form > form-data > Text > Key > Value |
| File Upload.Filename to be used | NA |
| File Upload.Multipart Content-Type | HTTP entity > Entity type > multipart > Multipart form > form-data > Text > Key |
| Trust all Certificates | Client Settings > Connection > Trust all certificates |
| Follow redirects | Client settings > Redirects Follow redirects |
| Query Parameters | Query Parameters |
| HTTP header | HTTP headers |
| Response entity type Value = Default Value = TEXT Value = BINARY |
Client settings > Output > Response type
|
| Cookie policy | Client settings > Connection Cookie policy |
| Read timeout | Client settings > Connection Read timeout (seconds) |
| Connection timeout | Client settings > Connection Connection timeout (seconds) |
| Maximum retry attempts | Client settings > Retry Maximum Attempts |
| Retry request interval | Client settings > Retry Retry interval (seconds) |
| Retry policy | Client settings > Retry Retry condition |
| Normalize URL | N/A The Normalize URL field is not available in the HTTP Client Snap. |
REST Patch
| REST PATCH Snap | HTTP Client Snap (PATCH Request Method) |
|---|---|
| REST Patch snap | Request method is PATCH |
| Service URL | URI |
| HTTP Entity | Entity type |
| Batch Size | N/A There is no property available for Batch Size in the HTTP Client Snap. |
| Show all headers | Enable debug |
| File Upload.Multipart Type | HTTP entity > Entity type > multipart |
| File Upload.Multipart Key | HTTP entity > Entity type > multipart > Multipart form > form-data > Text > Key |
| File Upload.Multipart Value | HTTP entity > Entity type > multipart > Multipart form > form-data > Text > Key > Value |
| File Upload.Filename to be used | NA There is no property available for “File Upload.Filename in the HTTP Client Snap; it uses the uploaded fileName internally. |
| File Upload.Multipart Content-Type | HTTP entity > Entity type > multipart > Multipart form > form-data > Text > Key |
| Trust all Certificates | Client Settings > Connection > Trust all certificates |
| Follow redirects | Client settings > Redirects > Follow redirects |
| Query Parameters | Query Parameters |
| HTTP header | HTTP headers |
| Response entity type Value = Default Value = TEXT Value = BINARY |
Client settings > Output > Response type
|
| Cookie policy | Client settings > Connection > Cookie policy |
| Read timeout | Client settings > Connection > Read timeout (seconds) |
| Connection timeout | Client settings > Connection > Connection timeout (seconds) |
| Maximum retry attempts | Client settings > Retry > Maximum Attempts |
| Retry request interval | Client settings > Retry > Retry interval (seconds) |
| Retry policy | Client settings > Retry > Retry condition |
| Normalize URL | N/A The Normalize URL field is not available in the HTTP Client Snap. |
REST Delete
| REST DELETE Snap | HTTP Client Snap (DELETE Request Method) |
|---|---|
| REST Patch snap | Request method is DELETE |
| Service URL | URI |
| HTTP Entity | Entity type |
| Batch Size | N/A There is no property available for Batch Size in the HTTP Client Snap. |
| Show all headers | Enable debug |
| Trust all Certificates | Client Settings > Connection > Trust all certificates |
| Follow redirects | Client settings > Redirects > Follow redirects |
| Query Parameters | Query Parameters |
| HTTP header | HTTP headers |
| Response entity type Value = Default Value = TEXT Value = BINARY |
Client settings > Output > Response type
|
| Cookie policy | Client settings > Connection > Cookie policy |
| Read timeout | Client settings > Connection.Read timeout |
| Connection timeout | Client settings > Connection > Connection timeout (seconds) |
| Maximum retry attempts | Client settings > Retry > Maximum Attempts |
| Retry request interval | Client settings > Retry > Retry interval (seconds) |
| Retry policy | Client settings > Retry > Retry condition |
| Normalize URL | N/A There is no property available for Normalize URL in the HTTP Client Snap. |