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 have no more than 2 levels, and the top-level must be arrays, the second-level must be objects.
Note
This object cannot be referenced in .NET Web Service and .NET Assembly components, otherwise the component will fail to be deployed.
|
RESTClient property |
Datatype |
Description |
|---|---|---|
|
Integer |
The secure protocol. |
|
|
Long |
The timeout seconds. |
|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control |
|
RESTClient event |
Occurs |
|---|---|
|
Constructor in PowerScript Reference |
When the object is created |
|
Destructor in PowerScript Reference |
When the object is destroyed |
|
RESTClient function |
Datatype returned |
Description |
|---|---|---|
|
ClassName in PowerScript Reference |
String |
Returns the name assigned to the object |
|
ClearRequestHeaders in PowerScript Reference |
Integer |
Clears headers of the request. |
|
GetContextService in PowerScript Reference |
Integer |
Creates a reference to a context-specific instance of the specified service |
|
GetParent in PowerScript Reference |
PowerObject |
Returns a reference to the name of the parent object |
|
GetRequestHeader in PowerScript Reference |
String |
Gets the request header by name. |
|
GetRequestHeaders in PowerScript Reference |
String |
Gets all of the request headers information. |
|
GetResponseHeader in PowerScript Reference |
String |
Gets the response header by name. |
|
GetResponseHeaders in PowerScript Reference |
String |
Gets all of the response headers information. |
|
GetResponseStatusCode in PowerScript Reference |
Long |
Gets the response status code. |
|
GetResponseStatusText in PowerScript Reference |
String |
Gets the response status description. |
|
PostEvent in PowerScript Reference |
Boolean |
Adds an event to the end of the message queue for the object |
|
Retrieve in PowerScript Reference |
Long |
Retrieves data to the DataWindow. |
|
SetRequestHeader in PowerScript Reference |
Integer |
Sets the request header. |
|
SetRequestHeaders in PowerScript Reference |
Integer |
Sets all of the request headers information. |
|
TriggerEvent in PowerScript Reference |
Integer |
Triggers a specific event in the object and executes the script for the event |
|
TypeOf in PowerScript Reference |
Object |
Returns the type of the object |
