HTTP Client

This service allows you to make HTTP requests to external third party websites.

Note that you must configure (declare) the external service via the Cloud Code - Web Services page of the brainCloud portal first.

info

General – a default accept header is now added to all calls to improve overall compatibility. This new behaviour is disabled by the new compatibility flag – which is enabled by default for existing apps: [x] Do not add default response media type accept header for responses (can interfere with request signatures if apps are not aware)

API Summary

Get

• GetResponseJson() - Retrieves a Json document.
• GetResponseText() - Retrieves a Text document.

Post

• PostJsonResponseJson() - Posts a JSON document, expects a Json response.
• PostJsonResponseText() - Posts a JSON document, expects a text response.
• PostJsonOffboard() - Posts a JSON document in the background, without waiting for a response.
• PostFormResponseJson() - Posts a Form encoded document, expects a Json response.
• PostMultipartResponseJson() - Posts a Form encoded document, expects a Json response.
• PostFormResponseText() - Posts a Form encoded document, expects a Text response.
• PostTextResponseText() - Posts a text document, expects a Text response.
• PostTextResponseJson() - Posts a text document, expects a Json response.

Put

• PutJsonResponseJson() - Puts a JSON document, expects a Json response.
• PutTextResponseText() - Puts a text document, expects a Text response.

Patch

• PatchJsonResponseJson() - Patches a JSON document, expects a Json response.
• PatchTextResponseText() - Patches a text document, expects a Text response.

Delete

• DeleteJsonResponseJson() - Deletes a document, passes a Json body, expects a Json response.
• Delete() - Deletes a document., expects a Text response.

Other

• ParseRequest() - Makes a request to Parse Rest API.
• HeadRequest() - Executes a HEAD request.

📄️ Delete

Deletes a document.

📄️ DeleteJsonResponseJson

Deletes a document, passes a Json body, expects a Json response.

📄️ GetResponseJson

Gets a JSON formatted document via HTTP.

📄️ GetResponseText

Gets text document via HTTP.

📄️ HeadRequest

Executes a HEAD request.

📄️ ParseRequest

Makes a Parse HTTP get.

📄️ PatchJsonResponseJson

Patches a JSON document, expects a Json response.

📄️ PatchTextResponseText

Patches a JSON document, expects a Json response.

📄️ PostFormResponseJson

Posts a form encoded document via HTTP and expects a JSON response.

📄️ PostFormResponseText

Posts a form encoded document via HTTP and expects a Text response.

📄️ PostJsonOffboard

Queues a JSON formatted document to be posted via HTTP, but does not wait for it to complete. This is useful for calls that you assume will succeed, but you don't want to take the time to wait for them to complete.

📄️ PostJsonResponseJson

Posts a JSON formatted document via HTTP and expects a JSON response.

📄️ PostJsonResponseText

Posts a JSON document, expects a text response.

📄️ PostMultipartResponseJson

Posts a Form encoded document, expects a Json response.

📄️ PostTextResponseJson

Posts text string via HTTP and expects a JSON response.

📄️ PostTextResponseText

Posts text string via HTTP and expects a Text response.

📄️ PutJsonResponseJson

Puts a JSON document, expects a Json response.

📄️ PutTextResponseText

Puts a text document, expects a Text response.