rbv_api.invokeSystemRESTV2()

Purpose

Sends a JSON request to the specified RESTV2 resource and returns the HTTP response body. This method doesn’t require any credentials as it is invoking internal system RESTV2 methods.

This method allows API-Key/JWT based authentication. Users can pass the API-Key/JWT token as header when required to invoke RESTV2 methods using another user’s context for the same tenant.

This API allows the RESTV2 endpoints which are added to the shared property - WhiteListForServerSideRESTV2.

Syntax

rbv_api.invokeSystemRESTV2(relativeUrl, data, method, contentType, headers, retryParams)

Parameters

relativeUrl

Relative URL to invoke RESTV2 method

For Example: /meta/roles

data

Text string or a JSON object to send as a body of the request

method

HTTP method, one of GET (default), POST, PUT or DELETE

contentType

MIME content type of data. For example:

application/json; charset=UTF-8 (default)

headers

Optional HTTP headers in name-value pairs, by default null

For Example: {"Api-Key":"95as018c-63cc-3addff-a715-a5044e6a85f3-41011-42551"}

retryParams

Optional JSON object that includes the following mandatory retry options for trigger.

  • numRetries — Number of retries allowed for a trigger. The maximum number of retries must not exceed 3.
  • retryInterval — Interval (ms) between two subsequent retries. The maximum retry timeout value (Retry Interval * Number of retries) can be configured using MaxHttpRetryTimeoutInMins shared.property. Default value of MaxHttpRetryTimeoutInMins is 1 min.
  • statusCodes — HTTP Response codes on which retry should happen. It can be a comma separated values of status codes as well as a range of status codes. For example, 302-400,500.

Return value

Body of HTTP response

Example

rbv_api.invokeSystemRESTV2("/meta/roles", null,"GET", null, null, null); 
NoteValidate Formula in the Template Helper section commits all the RESTv2.0 API calls while validating them.