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.

Note - if the far-end service returns anything other than a 200 response, an error will be written to the Monitoring | Global Monitoring | Recent Errors log.

Error reason codes

Parameter	Description
40443	Processing exception (message): Invalid service code. Ensure the Web Service has been configured

Service	Operation
httpClient	POST_JSON_OFFBOARD

Method Parameters

Parameter	Description
serviceCode	Service code of the external service configured in the Cloud Code - Web Services section of the portal
path	Path to append to the Base URL of the service
query	Map of query parameters
headers	Map of extra headers
json	JSON formatted data to post

Usage

http://localhost:3000

C#

//Switch to CC tab

C++

//Switch to CC tab

Objective-C

//Switch to CC tab

Java

//Switch to CC tab

JavaScript

//Switch to CC tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var serviceCode = "webService";
var path = "resource/dir";
var query = {
    "parmName": "value"
};
var headers = {
    "headerName": "value"
};
var json = {
    "key": "value"
};
var httpClientProxy = bridge.getHttpClientServiceProxy();

var postResult = httpClientProxy.postJsonOffboard(serviceCode, path, query, headers, json);
if (postResult.status == 200) {
    // Success!
}

Raw

var serviceCode = "webService";
var path = "resource/dir";
var query = {
    "parmName": "value"
};
var headers = {
    "headerName": "value"
};
var json = {
    "key": "value"
};
var httpClientProxy = bridge.getHttpClientServiceProxy();

var postResult = httpClientProxy.postJsonOffboard(serviceCode, path, query, headers, json);
if (postResult.status == 200) {
    // Success!
}

JSON Response

{
  "data": null,
  "status": 200
}