senselogic.sitevision.api.script

Interface RestApi<O>

Type Parameters:

O - script object

@Requireable(value="RestApi")
public interface RestApi<O>

Script utility for server-side invoke of the local Sitevision REST API.

This is a local, server-side, inbound utility to invoke the Sitevision REST API of the local site without any outgoing http connections. This utility can be used regardless of the REST API of the local site is enabled or not!

Version note! External (http connection-based) invocations of the Sitevision REST API can specify different versions (online / offline) via the URL. This inbound utility will always use current version as of VersionUtil.getCurrentVersion().

Below are two typical examples of how to use the RestApi utility to execute a GET for the "nodes" endpoint on a given JCR Node context and and process the returned javascript object.

a) Using a Node via a script variable (named "startPage") in the Sitevision Script module:

   var restApi = require('RestApi'),
       result;

   result = restApi.get(scriptVariables.startPage, 'nodes');

   if (result.statusCode >= 200 && result.statusCode < 300) {
      out.println('Result: ' + JSON.stringify(result.body));
   } else {
      out.println('Fail: ' + result.statusMessage + '<br>' + JSON.stringify(result.body));
   }

b) Using a Node via the app data (property "startPage") of a WebApp/RestApp:

   ...
   result = restApi.get(appData.getNode('startPage'), 'nodes');
   ...

REST siblings note!

• To execute endpoints in the REST API with a fixed version (ONLINE / OFFLINE) should typically be handled via VersionedRestApi.
• Server-side invoke of a local RESTApp should typically be handled via RestAppInvoker.
• Invoking external REST API:s should typically be handled via Requester.

Since:

Sitevision 4.5

Author:

Magnus Lövgren

See Also:

VersionedRestApi, Requester, RestAppInvoker

Method Summary

Modifier and Type	Method and Description
O	delete(Node aContextNode, String aOperationName) Executes a DELETE endpoint of the REST API.
O	delete(Node aContextNode, String aOperationName, Node aOperationNode) Executes a DELETE endpoint of the REST API, targeting an instance of the context.
O	delete(Node aContextNode, String aOperationName, Node aOperationNode, O aOperationOptions) Executes a DELETE endpoint of the REST API, targeting an instance of the context.
O	get(Node aContextNode, String aOperationName) Executes a GET endpoint of the REST API.
O	get(Node aContextNode, String aOperationName, Node aOperationNode, O aOperationOptions) Executes a GET endpoint of the REST API, targeting an instance of the context.
O	get(Node aContextNode, String aOperationName, O aOperationOptions) Executes a GET endpoint of the REST API.
O	post(Node aContextNode, String aOperationName, O aOperationOptions) Executes a POST endpoint of the REST API.
O	put(Node aContextNode, String aOperationName, Node aOperationNode, O aOperationOptions) Executes a PUT endpoint of the REST API, targeting an instance of the context.
O	put(Node aContextNode, String aOperationName, O aOperationOptions) Executes a PUT endpoint of the REST API.

Method Detail

get

O get(Node aContextNode,
      String aOperationName)

Executes a GET endpoint of the REST API.

REST hint! A get typically indicates a read of something.

Parameters:

aContextNode - the endpoint context Node

aOperationName - the endpoint operation name/method

Returns:

a script object representing the response (properties: statusCode, statusMessage, body)

get

O get(Node aContextNode,
      String aOperationName,
      O aOperationOptions)

Executes a GET endpoint of the REST API.

REST hint! A get typically indicates a read of something.

Parameters:

aContextNode - the endpoint context Node

aOperationName - the endpoint operation name/method

aOperationOptions - the operation data/parameters

Returns:

a script object representing the response (properties: statusCode, statusMessage, body)

get

O get(Node aContextNode,
      String aOperationName,
      Node aOperationNode,
      O aOperationOptions)

Executes a GET endpoint of the REST API, targeting an instance of the context.

REST hint! A get typically indicates a read of something.

Parameters:

aContextNode - the endpoint context Node

aOperationName - the endpoint operation name/method

aOperationNode - the operation Node of the context

aOperationOptions - the operation data/parameters

Returns:

a script object representing the response (properties: statusCode, statusMessage, body)

post

O post(Node aContextNode,
       String aOperationName,
       O aOperationOptions)

Executes a POST endpoint of the REST API.

REST hint! A post typically indicates the creation of something.

Parameters:

aContextNode - the endpoint context Node

aOperationName - the endpoint operation name/method

aOperationOptions - the operation data/parameters

Returns:

a script object representing the response (properties: statusCode, statusMessage, body)

put

O put(Node aContextNode,
      String aOperationName,
      O aOperationOptions)

Executes a PUT endpoint of the REST API.

REST hint! A put typically indicates an update of something.

Parameters:

aContextNode - the endpoint context Node

aOperationName - the endpoint operation name/method

aOperationOptions - the operation data/parameters

Returns:

a script object representing the response (properties: statusCode, statusMessage, body)

Since:

Sitevision 5

put

O put(Node aContextNode,
      String aOperationName,
      Node aOperationNode,
      O aOperationOptions)

Executes a PUT endpoint of the REST API, targeting an instance of the context.

REST hint! A put typically indicates an update of something.

Parameters:

aContextNode - the endpoint context Node

aOperationName - the endpoint operation name/method

aOperationNode - the operation Node of the context

aOperationOptions - the operation data/parameters

Returns:

a script object representing the response (properties: statusCode, statusMessage, body)

delete

O delete(Node aContextNode,
         String aOperationName)

Executes a DELETE endpoint of the REST API.

REST hint! A delete typically indicates a removal of something.

Parameters:

aContextNode - the endpoint context Node

aOperationName - the endpoint operation name/method

Returns:

a script object representing the response (properties: statusCode, statusMessage, body)

Since:

Sitevision 4.5.1

delete

O delete(Node aContextNode,
         String aOperationName,
         Node aOperationNode)

Executes a DELETE endpoint of the REST API, targeting an instance of the context.

REST hint! A delete typically indicates a removal of something.

Parameters:

aContextNode - the endpoint context Node

aOperationName - the endpoint operation name/method

aOperationNode - the operation Node of the context

Returns:

a script object representing the response (properties: statusCode, statusMessage, body)

delete

O delete(Node aContextNode,
         String aOperationName,
         Node aOperationNode,
         O aOperationOptions)

Executes a DELETE endpoint of the REST API, targeting an instance of the context.

REST hint! A delete typically indicates a removal of something.

Parameters:

aContextNode - the endpoint context Node

aOperationName - the endpoint operation name/method

aOperationNode - the operation Node of the context

aOperationOptions - the operation data/parameters

Returns:

a script object representing the response (properties: statusCode, statusMessage, body)

Since:

Sitevision 2023.01.1