Field Name | Field Type | Description |
---|
Label* | String | Insert excerpt |
---|
| File Writer |
---|
| File Writer |
---|
nopanel | true |
---|
|
Default Value: REST Patch Example: REST Patch |
Service URL* | URL | Specify the service endpoint URL of REST API. You can provide the URL in one of the following ways: For example: http://coresnapsqa-v4.s3.us-east-2.amazonaws.com/S3Account/'+encodeURIComponent("Special_char_owner_!3)12.json") For example: "https://www.example.com/slm/webservice/v2.0/defect/%s".replace("%s", $.widg et.id) For Snaps using AWS Signature V4 accounts, you can use the canonical name (CNAME) for the URI so it's not necessary for the URL to end with amazonaws.com or have the region and service provided in it. However, if you are using the CNAME you must provide it in the AWS Region and Service Name fields in the AWS Signature V4 account. The hostname in the CNAME must be equal to the bucket name. For example: Previous URI: https://jsmith-bucket.nia3.snaplogic.net.s3.us-west-1.amazonaws.com/HttpClientTest/test1 New URI with CNAME: https://jsmith-sltest.nia3.snaplogic.net/HttpClientTest/test1 Here, the bucket name is jsmith-bucket.nia3.snaplogic.net The Snap finds the value at the JSON path $.widget.id in the input data and replaces "%s" in the Service URL with the value. You can connect File Reader and JSON Parser Snaps upstream of a REST Put Snap and prepare the following JSON file for the File Reader Snap: Info |
---|
The Service URL for the REST snap has to be valid. If the Service URL contains any special characters, such as !, =, %21, $, and ^, the Snap throws an exception error. You can escape the special characters (using expression language) using one of the following methods: We recommend you use the former (encodeURIComponent) method to escape the special characters. |
Default Value: N/A Example: https://elastic.snaplogic.com/api/1/rest/public/runtime/snaplogic?start=1430377200000&end=1430420399000 |
HTTP Entity | String | Multiexcerpt include macro |
---|
name | HTTP_entity |
---|
page | REST Post |
---|
|
Default Value: $ (the HTTP entity data is at the root of the input map data) Example: $.entity (if the HTTP entity data is the value of the "entity" key at the root of the input map data) |
Batch size | Integer |
Multiexcerpt macro |
---|
| The number of documents to be included in a single request. The incoming documents will be accumulated in a list up to the defined batch size before it is submitted to the endpoint Make sure to set the batch size only if your REST endpoint expects a list.
|
Default Value: N/A Example: 20 |
Show all headers | Checkbox | Multiexcerpt include macro |
---|
name | Show_All_Headers |
---|
page | REST Delete |
---|
|
Default Value: Deselected
|
Form Upload | Multiexcerpt include macro |
---|
name | Upload_Files |
---|
page | REST Post |
---|
|
Default Value: N/A Example: REST Patch |
Multipart Type | Dropdown list | Choose the type of multipart upload that you want to initiate. The available options are: |
Multipart Key | String | Specify the key required for the multi-part to upload a file or text as required. HTTP POST uses multi-part entity to achieve the form upload. The form data of its multi-part entity contains key-value pairs.Multipart Key can be anything and it depends on the service endpoint. Default Value: file Example: file, initial_comment, channels |
Multipart Value | String/Expression | Specify the the file or text to be uploaded. If Multipart Type is FILE, the following are applicable: The file protocols supported for file values are 'sldb:///' and 'file:///'. If the file path is a relative path, it is considered as an SLDB file. If this field is not empty, HTTP Entity and Batch size fields are ignored and the Multipart Key field is required. If the value is an expression, the input document is used to evaluate the expression. Each input document invokes one file upload. This field does not support wildcard or glob patterns.
If Multipart Type is a TEXT, then Note |
---|
For Text part upload using the Form Upload, the Http Entity and Filename to be used fields are ignored. |
Default Value: N/A Example: |
Filename to be used | String | Enter the name that you want to use for the file at the endpoint. Multiexcerpt include macro |
---|
name | ExpEnabled |
---|
page | REST Put |
---|
|
Default Value: N/A Example: uploaded_file.csv |
Multipart Content- Type | String | Select the content type headers for the data in the body of the multipart HTTP request. This enables the Snap how to read or interpret the input file . The available options are: application/octet-stream text/plain application/json text/csv text/html image/jpeg
Note |
---|
If the Multipart Type is TEXT, it is generally not required to specify any value in this field. When you do not specify any value, the API uses the default value text/plain; charset=UTF-8 . |
Info |
---|
To specify other HTTP headers configure the headers in the HTTP header field set. If you configure both Multipart Content-Type and HTTP header fields, the value in the Multipart Content-type gets precedence.
|
Default Value: N/A Example: text/csv |
Trust all certificates | Checkbox | Multiexcerpt include macro |
---|
name | Trust_All_Certificates |
---|
page | REST Post |
---|
|
Default Value: Deselected |
Follow redirects | Checkbox | Multiexcerpt include macro |
---|
name | Follow_Redirects |
---|
page | REST Post |
---|
|
Default Value: Selected |
Query parameters |
Multiexcerpt include macro |
---|
name | Query_Parameters_REST |
---|
page | REST Post |
---|
|
|
Query parameter | String | Enter the name of the query parameter. Default Value: N/A Example: id |
Query parameter value | String | Enter the value that you want to assign to the parameter. Default Value: N/A Example: $widget.id |
HTTP Header |
Multiexcerpt include macro |
---|
name | HTTP_Header |
---|
page | REST Post |
---|
|
Note |
---|
Configuring HTTP headers helps avoid problems in reading or opening files uploaded using the REST Post Snap. Refer to the Troubleshooting section, below, for more information. |
|
Key | String | Enter the name of the HTTP header. Multiexcerpt include macro |
---|
name | ExpEnabled |
---|
page | REST Put |
---|
|
Default Value: N/A Example: content-type |
Value | String | Enter the value that you want to assign to the HTTP header. Multiexcerpt include macro |
---|
name | ExpEnabled |
---|
page | REST Put |
---|
|
Default Value: N/A Example: application/json |
Response entity type | String | Select one of the following response entity types you want the Snap to display in the output document.: DEFAULT - This option enables the Snap to process the response automatically. The response entity is processed automatically based on the Content-Type header in the response. If the content provided does not parse with the provided Content-Type , the snap will result in an error. The following two scenarios describe the Snap’s behavior when using the Process Array checkbox:: When you select the Process Array checkbox, the Snap parses JSON or XML and produces a stream of documents at the output view. When you deselect the Process Array checkbox, the Snaps sends the data as it is at the output view.
TEXT - Select this option to enable, the Snap to produce an entity of string type. BINARY - Select this option to enable the Snap to produce an entity of byte array type.
Default Value: DEFAULT Example: N/A |
Cookie Policy | Dropdown list | Select a Cookie Policy from the following options: Browser Compatibility: This policy is compatible with different servers even if they are not completely standards-compliant. If you are facing issues while parsing cookies, you should try using this policy. Ignore Cookies: This cookie policy ignores all cookies. You should use this policy to prevent HTTP Client from accepting and sending cookies. RFC Strict: This policy uses the set-cookie header RFC Lax: The policy uses set-cookie and set-cookie2 for parsing.
Info |
---|
When using a cookie policy, you must select Show All Headers checkbox to view the parsed cookies from the cookie policy specification. |
Default Value: Ignore Cookies Example: RFC Strict |
Read timeout | Integer | Multiexcerpt include macro |
---|
name | Read_Timeout |
---|
page | REST Post |
---|
|
Default Value: 900 Example: 1200 |
Connection timeout | Integer | Multiexcerpt include macro |
---|
name | Connection_Timeout |
---|
page | REST Post |
---|
|
Default Value: 30 Example: 60 |
Maximum request attempts | Integer | Multiexcerpt include macro |
---|
name | Maximum_Request_Attempts |
---|
page | REST Post |
---|
|
Default Value: 5 Example: 3 |
Retry request interval | Integer | Specify the time in seconds to wait before retrying the request. Default Value: 3 Example: 10 |
Retry Policy | String | Multiexcerpt include macro |
---|
name | Retry_Policy |
---|
page | REST Post |
---|
|
Default Value: Connection errors Example: All errors |
Normalize URL | Checkbox | Select this checkbox to normalize the Service URL. This enables the Snap to convert double slashes (//) in the URL path to a single slash (/). For example, https://example.com/path//to//file is converted to https://example.com/path/to/file. Info |
---|
Deselecting this checkbox reverts the Snap to 4.19 Snaplex behavior, where the URL paths were not normalized by default. In the 4.20 Release, due to the HTTP client upgrade the URL paths were normalized by default. Hence, there was a change in behavior in handling the URL paths in 4.20 release when compared to 4.19. This change in behavior should not impact the existing Pipelines, because most of the websites map URL paths with double or single slashes to the same endpoint. For example, https://snaplogic.com/company/diversity and https://snaplogic.com//company//diversity both URLs are directed to the same endpoint. Hence, we recommend you to select the Normalize URL checkbox. However, an exception to this is when you use non-standard URLs that differentiate the URL paths containing double slashes from those with single slashes and map them to different endpoints, in which case you must deselect Normalize URL checkbox. For example, http://host/pages/foo.html and http://host/pages//foo.html point to different URIs, and servers assign different meanings to them. |
Default Value: Selected |
Snap Execution | Checkbox | Multiexcerpt include macro |
---|
name | Snap_Execution_Introduced |
---|
page | Anaplan Read |
---|
|
Default Value: Validate & Execute Example: Validate & Execute |