RESTClient object

The RESTClient object provides the ability to access the RESTful Web APIs. It loads the JSON-formatted string returned from the RESTful Web Service APIs into the DataWindow object. The JSON string returned from the RESTFul Web Service APIs must be in the format described in the section called “Supported JSON formats” in Application Techniques.

Note

This object cannot be referenced in .NET Web Service or .NET Assembly components, otherwise the component will fail to be deployed.

Note

DataWindow object with the following presentation styles are unsupported: Composite, Crosstab, OLE 2.0, and RichText.

Properties

RESTClient property

Datatype

Description

SecureProtocol

Integer

The secure protocol.

TimeOut

Long

The timeout seconds.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control


Events

RESTClient event

Occurs

Constructor

When the object is created

Destructor

When the object is destroyed


Functions

RESTClient function

Datatype returned

Description

ClassName

String

Returns the name assigned to the object

ClearRequestHeaders

Integer

Clears headers of the request.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetParent

PowerObject

Returns a reference to the name of the parent object.

GetJWTToken

Integer

Gets the JWT token using the POST method.

GetOAuthToken

Integer

Gets the OAuth 2.0 access token.

GetRequestHeader

String

Gets the request header by name.

GetRequestHeaders

String

Gets all of the request headers information.

GetResponseHeader

String

Gets the response header by name.

GetResponseHeaders

String

Gets all of the response headers information.

GetResponseStatusCode

Long

Gets the response status code.

GetResponseStatusText

String

Gets the response status description.

PostEvent

Boolean

Adds an event to the end of the message queue for the object.

Retrieve

Long

Retrieves data to the DataWindow, DataWindowChild, or DataStore from the RESTFul Web service.

RetrieveOne

Long

Retrieves one data row to the DataWindow, DataWindowChild, or DataStore from the RESTFul Web service.

SendDeleteRequest

Integer

Sends the HTTP DELETE request to the server and then gets the content of the server response.

SendGetRequest

Integer

Sends the HTTP GET request to the server and then gets the content of the server response.

SendPatchRequest

Integer

Sends the HTTP PATCH request to the server and then gets the content of the server response.

SendPostRequest

Integer

Sends the HTTP POST request to the server and then gets the content of the server response.

SendPutRequest

Integer

Sends the HTTP PUT request to the server and then gets the content of the server response.

SetJWTToken

Integer

Sets the JWT token string to the HTTP request header which will be sent to the server.

SetOAuthToken

Integer

Sets the OAuth 2.0 token string to the HTTP request header which will be sent to the server.

SetRequestHeader

Integer

Sets the request header.

SetRequestHeaders

Integer

Sets all of the request headers information.

Submit

Integer

Sends the data to the server via the HTTP POST method.

TriggerEvent

Integer

Triggers a specific event in the object and executes the script for the event.

TypeOf

Object

Returns the type of the object.