Rest_Client Element

• Rest_Client, page 1

Rest_Client
The Rest_Client element provides a flexible interface in order to interact with REST endpoints. The
communication between the REST client and server is made completely secure using two-way Secure Sockets
Layer (SSL). The Rest_Client element permits users to send GET, POST, PUT, or DELETE requests to
application servers.

For more information about Secure Socket Layer Authentication, see the User Guide for Cisco Unified CVP
VXML Server and Cisco Unified Call Studio at http://www.cisco.com/c/en/us/support/customer-collaboration/
unified-customer-voice-portal/products-user-guide-list.html.

Settings
Name Type Req'd Single Substitution Default Notes
(Label) Setting Allowed
Value
Endpoint Boolean Yes true false Blank This settings
URL specifies whether
SNMP alert to be
generated.

HTTP GET HTTP supports

method GET,PUT, POST,
DELETE

Parameters Blank Any additional

parameters will be
passed along with
URL.

Element Specifications for Cisco Unified CVP VXML Server and Cisco Unified Call Studio Release 11.5(1)
1
 Rest_Client Element
Element Data

Name Type Req'd Single Substitution Default Notes

(Label) Setting Allowed
Value
Ignore false The SSL security
Certificate setting gets enabled
Validation when flag is set to
false.

Require true Username and

HTTP password of REST
authentication end point to be
accessed.

Headers Blank Specify the content

type to be retrieved.
For example: XML
of

XPath/JSONPath Blank

Connect 3000 msec

Timeout

Read 5000 msec

Timeout

Element Data
Name Type Notes

response_body string This element data carries the REST response that is received
from the REST end point.

status_code string This element data carries the REST response code received
for the REST operation performed.

Exit States
Name Notes

done The element execution is complete.

Element Specifications for Cisco Unified CVP VXML Server and Cisco Unified Call Studio Release 11.5(1)
2
 Rest_Client Element
Events

Events
Name (Label) Notes

Event Type Java Exception event handler type can be selected.

Element Specifications for Cisco Unified CVP VXML Server and Cisco Unified Call Studio Release 11.5(1)
3
 Rest_Client Element
Events

Element Specifications for Cisco Unified CVP VXML Server and Cisco Unified Call Studio Release 11.5(1)
4