Salesforce

HTTP - Methods (Magic xpi 4.13)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

HTTP – Methods

The following methods are used to configure the HTTP component:

  • Using the GET, POST, and REST methods to issue an HTTP request with data containing special characters (such as %, &, <, and >) causes translation of the data to legal HTTP codes. To prevent this from happening, and to allow the HTTP request body to be sent "as is", include 'content-type:text/html' in the HTTP header of the request.

  • The body of the HTTP request cannot be Unicode.

The following table lists the methods and parameters that can be used. Parameters in bold are mandatory.

Name

Parameters

Description

GET method executes the HTTP Get command. It is used primarily for retrieving data and returns it in a BLOB.

Start Text

Enter a comma delimited keyword path to the required text in the URL.

End Text

Enter a comma delimited keyword path to the ending text in the URL.

Header Information

Enter the header keyword that is necessary when parsing the returned HTML.

Header Set

Enter text or an expression to be added to the HTTP Header. If any Header value contains a comma (,) then the value must be escaped with a backslash.

Output BLOB

The User BLOB contains the output information returned by the HTML Get operation.

Output Header

Click to open the Variables List and select a variable to return the output header.

Error Code

This parameter is returned, with the corresponding error code, when an error occurs.

POST method executes the HTTP Post command. It can be used for various operations, such as updating or storing data on a Web site.

Start Text

Enter a comma delimited keyword path to the required text in the URL.

End Text

Enter a comma delimited keyword path to the ending text in the URL.

Header Information

Enter the header keyword that is necessary when parsing the returned HTML.

Header Set

Enter the header added when using the Send Data operation with an HTTP Post operation. If any Header value contains a comma (,) then the value must be escaped with a backslash.

Data BLOB

The Data BLOB contains the input information required by the HTTP Post operation.

Encoding

Enter the desired encoding of the data to be sent. The default value is Keep Existing.

The supported encoding values are Keep Existing, UTF-8 with BOM, UTF-8, Unicode, Ansi and Binary.

The runtime conversion will be done to the Data BLOB. See: Conversion Table

When sending Unicode data in the HTTP request body, the matching content type charset should be UTF-16LE.
For example, content-type:text/html; charset=UTF-16LE.

Since version: 4.7

Output BLOB

The Output BLOB contains the output information returned by the HTTP Post operation.

Output Header

Click to open the Variables List and select a variable to return the output header.

Error Code

This parameter is returned, with the corresponding error code, when an error occurs.

REST method executes an HTTP request and returns the results.

HTTP Verb

This string indicates which method will be used.

Select one of the following from the drop-down list:

  • GET (default)

  • POST

  • PUT

  • HEAD

  • DELETE

See also: How Do I Get the HTTP Request's HTTP Verb?

URL Dynamic Addition

This string represents an HTTP address. Its value is appended to the end of the resource URL.

Header Information

Enter the header keyword that is necessary when parsing the response's HTTP header. This value will be available in the output header.

Header Set

Enter the user header(s) that will be added to the HTTP header. Headers are delimited by commas (,). If any Header value contains a comma (,) then the value must be escaped with a backslash.

Data BLOB

The Data BLOB contains the input information required by the HTTP Call.

Encoding

Enter the desired encoding of the data to be sent. The default value is Keep Existing.

The runtime conversion will be done to the Data BLOB. See: Conversion Table

Since version: 4.7

Encoding of the data is supported for all the methods except for the GET method.

Output BLOB

The Output BLOB contains the output information returned by the HTTP Call.

Output Header

Click to open the Variables List and select a variable that will hold the output header.

Error Code

This parameter is returned, with the corresponding error code, when an error occurs.

Related Topics

How to Use Direct Access Methods

Reference
Attachment 
Attachment