The Sentinel REM extension provides a RESTful HTTP provisioning API.
 |
To use the Sentinel IP-SM-GW Provisioning REST Web Interface and Machine API, you will need to configure a Rhino instance using the Rhino Element Manager (REM). |
This page covers
Accessing the Provisioning REST API
To access the Provisioning REST API:
1 |
Ensure the Sentinel REM extension is installed in REM. |
|---|---|
2 |
Start REM. |
3 |
Access the Sentinel Provisioning API at [http://localhost:8080/rem/sentinel/api] (replace localhost with some other hostname if REM is not being run locally). |
| |
Access is restricted to users configured through REM using HTTP BASIC authorization. If you’re using a web browser, it will prompt you to enter a username and password the first time you access any part of the API. |
Listing and browsing resources
Listing resources
You can find a listing of all available resources at the top-level URL for the API (for example, [http://localhost:8080/rem/sentinel/api]).
The list can be in either:
-
HTML format (for viewing in a browser)
-
an APP Service Document (application/atomsvc+xml), that can be parsed by a scripted client.
Browsing resources
From the top-level API URL, you can browse into the available resources. Each resource in turn lists its own sub-resources. All of the sub-resources require a rhinoInstanceId query parameter. This should exactly match the name of a Rhino instance configured in REM (such as rhinoInstanceId=Local). Most of the sub-resources also require a selectionKey query parameter in the form of platformOperator:networkOperator:sessionType:planId:subscriptionId - such as selectionKey=OpenCloud::::
Example 1:
http://localhost:8080/rem/sentinel/api/featureexecutionscripts returns a sub-resource listing for feature execution scripts:
<feature>
<name>FeatureExecutionScripts</name>
<resources>
<link title="Feature Execution Scripts" href="http://localhost:8080/rem/sentinel/api/featureexecutionscripts/scripts" rel="entries"/>
<link title="Feature Execution Script Execution Point Associations" href="http://localhost:8080/rem/sentinel/api/featureexecutionscripts/executionpoints" rel="associations"/>
</resources>
</feature>Example 2:
- Following the entries relation to the scripts resource, by adding the rhinoInstanceId and selectionKey parameters, http://localhost:8080/rem/sentinel/api/featureexecutionscripts/scripts?rhinoInstanceId=Local&selectionKey=OpenCloud
-
returns a paged listing of feature execution scripts configured in your local Rhino instance for platform operator OpenCloud:
<featureExecutionScripts next="http://localhost:8080/rem/sentinel/api/featureexecutionscripts/scripts?rhinoInstanceId=Local&selectionKey=OpenCloud::::&page=2">
<featureExecutionScript>
<name>default_DiameterAccess_NetworkPreCreditCheck</name>
<resources>
<link title="default_DiameterAccess_NetworkPreCreditCheck" href="http://localhost:8080/rem/sentinel/api/featureexecutionscripts/scripts/default_DiameterAccess_NetworkPreCreditCheck?rhinoInstanceId=Local&selectionKey=OpenCloud::::" rel="config"/>
</resources>
</featureExecutionScript>
...
<featureExecutionScript>
<name>default_Mediation_CreditAllocatedPostOcsCC</name>
<resources>
<link title="default_Mediation_CreditAllocatedPostOcsCC" href="http://localhost:8080/rem/sentinel/api/featureexecutionscripts/scripts/default_Mediation_CreditAllocatedPostOcsCC?rhinoInstanceId=Local&selectionKey=OpenCloud::::" rel="config"/>
</resources>
</featureExecutionScript>
</featureExecutionScripts>-
The next and prev attributes contain the URLs for the next and previous pages of results.
-
The link entries contain the URLs for accessing the individual feature execution script resource entities.
Specifying content type
By default, the API accepts and returns application/xml, but also supports application/json. To request content in JSON format, simple set the http Accept request header to application/json.
For example:
{{wget --header='Accept: application/json' ...}}
for {{.../featureexecutionscripts/scripts/default_DirectAccess_SessionStart?rhinoInstanceId=Local&selectionKey=OpenCloud::::}}returns a JSON object representing the requested feature execution script.
{"featureExecutionScript": {
"name": "default_DirectAccess_SessionStart",
"src": "featurescript OnSessionStart { if not currentNextStep.refuseDialog and not currentNextStep.relayDialog { run AcceptCamelVoiceV1V2V3 } }"
}}Provisioning using simple tools and scripts
Higher-level clients can be used to interact with the REST API from Java or other application code, but you really just need to be able to make HTTP requests. See these examples:
Adding a feature execution script with curl (XML)
Request |
curl -H 'Accept: application/xml' \
-H 'Content-Type: application/xml' \
-i -w '\nHTTP STATUS: %{http_code}\nTIME: %{time_total}\n' \
-X POST \
-u "username:password" \
-d "<featureExecutionScript><name>my_new_feature_script</name><src>featurescript newScript { }</src></featureExecutionScript>" \
"http://localhost:8080/rem/sentinel/api/featureexecutionscripts/scripts?rhinoInstanceId=Local&selectionKey=OpenCloud::::"
|
|---|---|
Response |
HTTP/1.1 201 Created Date: Tue, 13 Sep 2011 20:42:15 GMT Location: http://localhost:8080/rem/sentinel/api/featureexecutionscripts/scripts/my_new_feature_script?rhinoInstanceId=Local&selectionKey=OpenCloud:::: Content-Length: 0 Server: Jetty(6.1.24) |
Adding a subscriber with curl (JSON)
Request |
curl -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-i -w '\nHTTP STATUS: %{http_code}\nTIME: %{time_total}\n' \
-X POST \
-u "username:password" \
-d '{ "name": "34600000002", "subscriberData": [ {"name": "FriendsAndFamilyEnabled", "type": "Boolean", "valueBoolean": "true"}, {"name": "FriendsAndFamilyList", "type": "StringArray", "valueArray": ["34600000001"] } ] }' \
"http://localhost:8080/rem/sentinel/api/subscriberdata/records?rhinoInstanceId=Local&selectionKey=OpenCloud::::"
|
|---|---|
Response |
HTTP/1.1 201 Created Date: Tue, 13 Sep 2011 21:07:03 GMT Location: http://localhost:8080/rem/sentinel/api/subscriberdata/records/34600000002?rhinoInstanceId=Local&selectionKey=OpenCloud:::: Content-Length: 0 Server: Jetty(6.1.24) |
Turning on HomeZone for a subscriber using Ruby (JSON)
require 'rubygems'
require 'json'
require 'net/http'
Net::HTTP.start('localhost', '8080') {|http|
req = Net::HTTP::Get.new('/rem/sentinel/api/subscriberdata/records/34600000003?rhinoInstanceId=Local&selectionKey=OpenCloud::::', {'Accept' => 'application/json'})
req.basic_auth 'username', 'password'
response = http.request(req)
subscriber = JSON.parse(response.body)
subscriber['subscriberData'].each {|item|
if item['name'] == 'HomeZoneEnabled'
item['valueBoolean'] = true;
end
}
req = Net::HTTP::Put.new('/rem/sentinel/api/subscriberdata/records/34600000003?rhinoInstanceId=Local&selectionKey=OpenCloud::::', {'Content-Type' => 'application/json'})
req.basic_auth 'username', 'password'
response = http.request(req, JSON.generate(subscriber))
}Result codes and error responses
The Provisioning REST API returns the following Result codes and Error responses
Result codes
The API returns these codes
Result code |
Description |
200 OK |
The request to list or retrieve a record was successful |
201 Created |
The record posted was successfully created |
204 No Content |
The update or delete operation was successful |
400 Bad Request |
Incorrectly configured request. Check the response body for specific error information |
401 Unauthorized |
The request was not authorized. Check that the username and password are correct in the request |
404 Not Found |
The requested resource could not be found. Check the response body for specific error information |
406 Not Acceptable |
The requested media type is not supported |
500 Internal Server Error |
An internal error occurred while processing the request. Check the response body for specific error information |
Error responses
You can find more information for result codes 400, 404, and 500 in an error response entity in the response body, in the requested content type (XML or JSON). For example:
XML
<error>
<type>...</type>
<message>...</message>
</error>JSON
{
"type": "...",
"message": "..."
}Here are the possible responses:
Error type |
Associated Result Code |
Description |
CollectionNotFound |
404 Not Found |
The collection/table/scope containing the requested entity could not be found |
EntityNotFound |
404 Not Found |
The requested entity could not be found |
EntityMissing |
400 Bad Request |
Post request did not contain an entity in the request body |
EntityAlreadyExists |
400 Bad Request |
Post request attempted to create an entity that already exists |
RequiredParameterMissing |
400 Bad Request |
A required query parameter was not provided |
ParameterInvalid |
400 Bad Request |
One of the query parameters provided was invalid |
RequestInconsistent |
400 Bad Request |
Put request attempted to update an entity with an id/name in the request body that didn’t match the id/name in the URL |
ServerError |
500 Internal Server Error |
An internal error occurred while processing the request |
PageNotFound |
404 Not Found |
The requested page of the paged resource listing could not be found |
NotAcceptable |
406 Not Acceptable |
Requested media type is not supported (XML-only response, since media type could not be determined) |
Activity Test REST API
Resource Activity Test
Resource |
Activity Test |
|---|---|
Workspace |
Sentinel Services |
Path |
/activitytest |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/activitytest |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/activitytest/config
Operation |
Create a new Activity Test Config entry |
|---|---|
Request Method |
POST |
Path |
/activitytest/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Activity Test Config entry or a listing of Activity Test Config entries |
|---|---|
Request Method |
GET |
Path |
/activitytest/config |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: ActivityTestConfig Otherwise: ActivityTestConfigs |
Operation |
Update an existing Activity Test Config entry |
|---|---|
Request Method |
PUT |
Path |
/activitytest/config |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Activity Test Config entry |
|---|---|
Request Method |
DELETE |
Path |
/activitytest/config |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>ActivityTestConfig
Class: com.opencloud.sentinel.provisioning.activitytest.ActivityTestConfig
JSON
{
"type" : "object",
"properties" : {
"timerModeType" : {
"type" : "string"
},
"fixedDuration" : {
"type" : "number"
},
"chargingPeriodMultiple" : {
"type" : "number"
},
"activityTestInvokeTimeout" : {
"type" : "number"
},
"randomPeriod" : {
"type" : "number"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="activityTestConfig" type="ActivityTestConfigType"/>
<xs:complexType name="ActivityTestConfigType">
<xs:sequence>
<xs:element name="timerModeType" type="xs:string" minOccurs="0"/>
<xs:element name="fixedDuration" type="xs:long"/>
<xs:element name="chargingPeriodMultiple" type="xs:double"/>
<xs:element name="activityTestInvokeTimeout" type="xs:long"/>
<xs:element name="randomPeriod" type="xs:long"/>
</xs:sequence>
</xs:complexType>
</xs:schema>ActivityTestConfigs
Class: com.opencloud.sentinel.rest.server.resources.activitytest.ActivityTestConfigResource$ActivityTestConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="activityTestConfig" type="ActivityTestConfigsEntryType"/>
<xs:element name="activityTestConfigs" type="ActivityTestConfigsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="ActivityTestConfigsType">
<xs:sequence>
<xs:element ref="activityTestConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="ActivityTestConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Correlation REST API
Resource Correlation
Resource |
Correlation |
|---|---|
Workspace |
Sentinel Services |
Path |
/correlation |
Operations
Operation |
Retrieve a listing of correlation RA entities with links to sub-resources |
|---|---|
Request Method |
GET |
Path |
/correlation |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/correlation/{raEntityName}/config
Operation |
Create a new correlation config |
|---|---|
Request Method |
POST |
Path |
/correlation/{raEntityName}/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing correlation config |
|---|---|
Request Method |
GET |
Path |
/correlation/{raEntityName}/config |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing correlation config |
|---|---|
Request Method |
PUT |
Path |
/correlation/{raEntityName}/config |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing correlation config |
|---|---|
Request Method |
DELETE |
Path |
/correlation/{raEntityName}/config |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/correlation/{raEntityName}/pools
Operation |
Create a new correlation id pool |
|---|---|
Request Method |
POST |
Path |
/correlation/{raEntityName}/pools |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve a listing of correlation id pools |
|---|---|
Request Method |
GET |
Path |
/correlation/{raEntityName}/pools |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing correlation id pool config |
|---|---|
Request Method |
PUT |
Path |
/correlation/{raEntityName}/pools/{poolName} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing correlation id pool |
|---|---|
Request Method |
DELETE |
Path |
/correlation/{raEntityName}/pools/{poolName} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Retrieve an existing correlation id pool config |
|---|---|
Request Method |
GET |
Path |
/correlation/{raEntityName}/pools/{poolName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Schemas
CorrelationRAEntities
Class: com.opencloud.sentinel.rest.correlation.CorrelationRAEntities
JSON
{
"type" : "object",
"properties" : {
"raEntities" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="correlationRAEntities" type="CorrelationRAEntitiesType"/>
<xs:element name="link" type="LinkType"/>
<xs:element name="raEntity" type="CorrelationRAEntityType"/>
<xs:complexType name="CorrelationRAEntitiesType">
<xs:sequence>
<xs:element ref="raEntity" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="CorrelationRAEntityType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>CorrelationConfig
Class: com.opencloud.sentinel.provisioning.correlation.CorrelationConfig
JSON
{
"type" : "object",
"properties" : {
"correlationIDExpiryTimerPeriod" : {
"type" : "number"
},
"numberOfThreadPool" : {
"type" : "integer"
},
"requestTimeout" : {
"type" : "number"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="correlationConfig" type="CorrelationConfigType"/>
<xs:complexType name="CorrelationConfigType">
<xs:sequence>
<xs:element name="correlationIDExpiryTimerPeriod" type="xs:long"/>
<xs:element name="numberOfThreadPool" type="xs:int"/>
<xs:element name="requestTimeout" type="xs:long"/>
</xs:sequence>
</xs:complexType>
</xs:schema>CorrelationIdPool
Class: com.opencloud.sentinel.provisioning.correlation.CorrelationIdPool
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"addressPrefixes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"correlationIDNumberOfDigits" : {
"type" : "integer"
},
"correlationIDRangePerNode" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"isPreconfiguredCorrelationIdSetUsed" : {
"type" : "boolean",
"required" : true
},
"maxCorrelationIDInCluster" : {
"type" : "number"
},
"minCorrelationIDInCluster" : {
"type" : "number"
},
"nodeIds" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"preconfiguredCorrelationIdSet" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="correlationIdPool" type="CorrelationIdPoolType"/>
<xs:complexType name="CorrelationIdPoolType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="addressPrefixes" nillable="true" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="correlationIDNumberOfDigits" type="xs:int"/>
<xs:element name="correlationIDRangePerNode" nillable="true" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="value" type="xs:int" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="isPreconfiguredCorrelationIdSetUsed" type="xs:boolean"/>
<xs:element name="maxCorrelationIDInCluster" type="xs:long"/>
<xs:element name="minCorrelationIDInCluster" type="xs:long"/>
<xs:element name="nodeIds" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="value" type="xs:int" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="preconfiguredCorrelationIdSet" nillable="true" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:schema>CorrelationIdPools
Class: com.opencloud.sentinel.rest.server.resources.correlation.CorrelationIdPoolResource$CorrelationIdPools
JSON
{
"type" : "object",
"properties" : {
"idPools" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="correlationIdPools" type="CorrelationIdPoolsType"/>
<xs:element name="idPool" type="CorrelationIdPoolEntryType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="CorrelationIdPoolsType">
<xs:sequence>
<xs:element ref="idPool" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="CorrelationIdPoolEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Diameter Mediation REST API
Resource Diameter Mediation
Resource |
Diameter Mediation |
|---|---|
Workspace |
Sentinel Services |
Path |
/diametermediation |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/diametermediation |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/diametermediation/ocsdestination
Operation |
Retrieve a listing of Diameter Mediation OCS Destination entries |
|---|---|
Request Method |
GET |
Path |
/diametermediation/ocsdestination |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new Diameter Mediation OCS Destination entry |
|---|---|
Request Method |
POST |
Path |
/diametermediation/ocsdestination |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Diameter Mediation OCS Destination entry |
|---|---|
Request Method |
GET |
Path |
/diametermediation/ocsdestination/{ocsId} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing Diameter Mediation OCS Destination entry |
|---|---|
Request Method |
PUT |
Path |
/diametermediation/ocsdestination/{ocsId} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Diameter Mediation OCS Destination entry |
|---|---|
Request Method |
DELETE |
Path |
/diametermediation/ocsdestination/{ocsId} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/diametermediation/tcctimerconfig
Operation |
Create a new Diameter Mediation TCC Timer Config entry |
|---|---|
Request Method |
POST |
Path |
/diametermediation/tcctimerconfig |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Diameter Mediation TCC Timer Config entry or a listing of Diameter Mediation TCC Timer Config entries |
|---|---|
Request Method |
GET |
Path |
/diametermediation/tcctimerconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: DiameterMediationTccTimerConfig Otherwise: DiameterMediationTccTimerConfigs |
Operation |
Update an existing Diameter Mediation TCC Timer Config entry |
|---|---|
Request Method |
PUT |
Path |
/diametermediation/tcctimerconfig |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Diameter Mediation TCC Timer Config entry |
|---|---|
Request Method |
DELETE |
Path |
/diametermediation/tcctimerconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/diametermediation/serviceids
Operation |
Create a new Diameter Mediation Service IDs entry |
|---|---|
Request Method |
POST |
Path |
/diametermediation/serviceids |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Diameter Mediation Service IDs entry or a listing of Diameter Mediation Service IDs entries |
|---|---|
Request Method |
GET |
Path |
/diametermediation/serviceids |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: DiameterMediationServiceIdConfig Otherwise: DiameterMediationServiceIdConfigs |
Operation |
Update an existing Diameter Mediation Service IDs entry |
|---|---|
Request Method |
PUT |
Path |
/diametermediation/serviceids |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Diameter Mediation Service IDs entry |
|---|---|
Request Method |
DELETE |
Path |
/diametermediation/serviceids |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/diametermediation/ocsconfig
Operation |
Retrieve an existing Diameter Mediation OCS Config entry or a listing of Diameter Mediation OCS Config entries |
|---|---|
Request Method |
GET |
Path |
/diametermediation/ocsconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: DiameterMediationOCSConfig Otherwise: DiameterMediationOCSConfigs |
Operation |
Update an existing Diameter Mediation OCS Config entry |
|---|---|
Request Method |
PUT |
Path |
/diametermediation/ocsconfig |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Diameter Mediation OCS Config entry |
|---|---|
Request Method |
DELETE |
Path |
/diametermediation/ocsconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Create a new Diameter Mediation OCS Config entry |
|---|---|
Request Method |
POST |
Path |
/diametermediation/ocsconfig |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
/diametermediation/config
Operation |
Create a new Diameter Mediation Config entry |
|---|---|
Request Method |
POST |
Path |
/diametermediation/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Diameter Mediation Config entry or a listing of Diameter Mediation Config entries |
|---|---|
Request Method |
GET |
Path |
/diametermediation/config |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: DiameterMediationConfig Otherwise: DiameterMediationConfigs |
Operation |
Update an existing Diameter Mediation Config entry |
|---|---|
Request Method |
PUT |
Path |
/diametermediation/config |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Diameter Mediation Config entry |
|---|---|
Request Method |
DELETE |
Path |
/diametermediation/config |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>DiameterMediationOCSDestinations
Class: com.opencloud.sentinel.rest.server.resources.diametermediation.DiameterMediationOCSDestinationResource$DiameterMediationOCSDestinations
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationOCSDestination" type="DiameterMediationOCSDestinationsEntryType"/>
<xs:element name="diameterMediationOCSDestinations" type="DiameterMediationOCSDestinationsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="DiameterMediationOCSDestinationsType">
<xs:sequence>
<xs:element ref="diameterMediationOCSDestination" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="DiameterMediationOCSDestinationsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>DiameterMediationOCSDestination
Class: com.opencloud.sentinel.provisioning.diametermediation.DiameterMediationOCSDestination
JSON
{
"type" : "object",
"properties" : {
"ocsId" : {
"type" : "string"
},
"destinationRealm" : {
"type" : "string"
},
"destinationHost" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationOCSDestination" type="DiameterMediationOCSDestinationType"/>
<xs:complexType name="DiameterMediationOCSDestinationType">
<xs:sequence>
<xs:element name="ocsId" type="xs:string" minOccurs="0"/>
<xs:element name="destinationRealm" type="xs:string" minOccurs="0"/>
<xs:element name="destinationHost" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>DiameterMediationTccTimerConfig
Class: com.opencloud.sentinel.provisioning.diametermediation.DiameterMediationTccTimerConfig
JSON
{
"type" : "object",
"properties" : {
"defaultTccTimeout" : {
"type" : "number"
},
"tccOption" : {
"type" : "string"
},
"tccMinValue" : {
"type" : "number"
},
"gsuScaleFactorMultiplier" : {
"type" : "integer"
},
"gsuOffset" : {
"type" : "integer"
},
"gsuScaleFactorDivisor" : {
"type" : "integer"
},
"vtScaleFactorMultiplier" : {
"type" : "integer"
},
"vtOffset" : {
"type" : "integer"
},
"vtScaleFactorDivisor" : {
"type" : "integer"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationTccTimerConfig" type="DiameterMediationTccTimerConfigType"/>
<xs:complexType name="DiameterMediationTccTimerConfigType">
<xs:sequence>
<xs:element name="defaultTccTimeout" type="xs:long"/>
<xs:element name="tccOption" type="xs:string" minOccurs="0"/>
<xs:element name="tccMinValue" type="xs:long"/>
<xs:element name="gsuScaleFactorMultiplier" type="xs:int"/>
<xs:element name="gsuOffset" type="xs:int"/>
<xs:element name="gsuScaleFactorDivisor" type="xs:int"/>
<xs:element name="vtScaleFactorMultiplier" type="xs:int"/>
<xs:element name="vtOffset" type="xs:int"/>
<xs:element name="vtScaleFactorDivisor" type="xs:int"/>
</xs:sequence>
</xs:complexType>
</xs:schema>DiameterMediationTccTimerConfigs
Class: com.opencloud.sentinel.rest.server.resources.diametermediation.DiameterMediationTccTimerConfigResource$DiameterMediationTccTimerConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationTccTimerConfig" type="DiameterMediationTccTimerConfigsEntryType"/>
<xs:element name="diameterMediationTccTimerConfigs" type="DiameterMediationTccTimerConfigsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="DiameterMediationTccTimerConfigsType">
<xs:sequence>
<xs:element ref="diameterMediationTccTimerConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="DiameterMediationTccTimerConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>DiameterMediationServiceIdConfig
Class: com.opencloud.sentinel.provisioning.diametermediation.DiameterMediationServiceIdConfig
JSON
{
"type" : "object",
"properties" : {
"serviceIDs" : {
"type" : "array",
"items" : {
"type" : "number"
}
},
"serviceNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationServiceIdConfig" type="DiameterMediationServiceIdConfigType"/>
<xs:complexType name="DiameterMediationServiceIdConfigType">
<xs:sequence>
<xs:element name="serviceIDs" nillable="true" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="value" type="xs:long" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="serviceNames" nillable="true" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:schema>DiameterMediationServiceIdConfigs
Class: com.opencloud.sentinel.rest.server.resources.diametermediation.DiameterMediationServiceIdConfigResource$DiameterMediationServiceIdConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationServiceIdConfig" type="DiameterMediationServiceIdConfigsEntryType"/>
<xs:element name="diameterMediationServiceIdConfigs" type="DiameterMediationServiceIdConfigsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="DiameterMediationServiceIdConfigsType">
<xs:sequence>
<xs:element ref="diameterMediationServiceIdConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="DiameterMediationServiceIdConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>DiameterMediationOCSConfig
Class: com.opencloud.sentinel.provisioning.diametermediation.DiameterMediationOCSConfig
JSON
{
"type" : "object",
"properties" : {
"destinationRealm" : {
"type" : "string"
},
"destinationHost" : {
"type" : "string"
},
"timeoutDuration" : {
"type" : "number"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationOCSConfig" type="DiameterMediationOCSConfigType"/>
<xs:complexType name="DiameterMediationOCSConfigType">
<xs:sequence>
<xs:element name="destinationRealm" type="xs:string" minOccurs="0"/>
<xs:element name="destinationHost" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="timeoutDuration" type="xs:long"/>
</xs:sequence>
</xs:complexType>
</xs:schema>DiameterMediationOCSConfigs
Class: com.opencloud.sentinel.rest.server.resources.diametermediation.DiameterMediationOCSConfigResource$DiameterMediationOCSConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationOCSConfig" type="DiameterMediationOCSConfigsEntryType"/>
<xs:element name="diameterMediationOCSConfigs" type="DiameterMediationOCSConfigsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="DiameterMediationOCSConfigsType">
<xs:sequence>
<xs:element ref="diameterMediationOCSConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="DiameterMediationOCSConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>DiameterMediationConfig
Class: com.opencloud.sentinel.provisioning.diametermediation.DiameterMediationConfig
JSON
{
"type" : "object",
"properties" : {
"closeSessionOnErrorBehaviour" : {
"type" : "string"
},
"vtTimerEnabled" : {
"type" : "boolean",
"required" : true
},
"vtTimerOffset" : {
"type" : "integer"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationConfig" type="DiameterMediationConfigType"/>
<xs:complexType name="DiameterMediationConfigType">
<xs:sequence>
<xs:element name="closeSessionOnErrorBehaviour" type="xs:string" minOccurs="0"/>
<xs:element name="vtTimerEnabled" type="xs:boolean"/>
<xs:element name="vtTimerOffset" type="xs:int"/>
</xs:sequence>
</xs:complexType>
</xs:schema>DiameterMediationConfigs
Class: com.opencloud.sentinel.rest.server.resources.diametermediation.DiameterMediationConfigResource$DiameterMediationConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="diameterMediationConfig" type="DiameterMediationConfigsEntryType"/>
<xs:element name="diameterMediationConfigs" type="DiameterMediationConfigsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="DiameterMediationConfigsType">
<xs:sequence>
<xs:element ref="diameterMediationConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="DiameterMediationConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Feature Execution Scripts REST API
Resource Feature Execution Scripts
Resource |
Feature Execution Scripts |
|---|---|
Workspace |
Sentinel Services |
Path |
/featureexecutionscripts |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/featureexecutionscripts |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/featureexecutionscripts/executionpoints
Operation |
Retrieve a listing of Feature Execution Scripts Config entries |
|---|---|
Request Method |
GET |
Path |
/featureexecutionscripts/executionpoints |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new Feature Execution Scripts Config entry |
|---|---|
Request Method |
POST |
Path |
/featureexecutionscripts/executionpoints |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Feature Execution Scripts Config entry |
|---|---|
Request Method |
GET |
Path |
/featureexecutionscripts/executionpoints/{featureExecutionPointName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing Feature Execution Scripts Config entry |
|---|---|
Request Method |
PUT |
Path |
/featureexecutionscripts/executionpoints/{featureExecutionPointName} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Feature Execution Scripts Config entry |
|---|---|
Request Method |
DELETE |
Path |
/featureexecutionscripts/executionpoints/{featureExecutionPointName} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/featureexecutionscripts/scripts
Operation |
Retrieve a listing of feature execution scripts |
|---|---|
Request Method |
GET |
Path |
/featureexecutionscripts/scripts |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new feature execution script |
|---|---|
Request Method |
POST |
Path |
/featureexecutionscripts/scripts |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing feature execution script |
|---|---|
Request Method |
GET |
Path |
/featureexecutionscripts/scripts/{scriptName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing feature execution script |
|---|---|
Request Method |
PUT |
Path |
/featureexecutionscripts/scripts/{scriptName} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing feature execution script |
|---|---|
Request Method |
DELETE |
Path |
/featureexecutionscripts/scripts/{scriptName} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>FeatureExecutionScriptAssociations
Class: com.opencloud.sentinel.rest.server.resources.FeatureExecutionScriptAssociationResource$FeatureExecutionScriptAssociations
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="featureExecutionScriptAssociation" type="FeatureExecutionScriptAssociationsEntryType"/>
<xs:element name="featureExecutionScriptAssociations" type="FeatureExecutionScriptAssociationsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureExecutionScriptAssociationsType">
<xs:sequence>
<xs:element ref="featureExecutionScriptAssociation" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="FeatureExecutionScriptAssociationsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>FeatureExecutionScriptAssociation
Class: com.opencloud.sentinel.provisioning.featurescript.FeatureExecutionScriptAssociation
JSON
{
"type" : "object",
"properties" : {
"featureExecutionPointName" : {
"type" : "string"
},
"featureExecutionScriptName" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="featureExecutionScriptAssociation" type="FeatureExecutionScriptAssociationType"/>
<xs:complexType name="FeatureExecutionScriptAssociationType">
<xs:sequence>
<xs:element name="featureExecutionPointName" type="xs:string" minOccurs="0"/>
<xs:element name="featureExecutionScriptName" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>FeatureExecutionScripts
Class: com.opencloud.sentinel.rest.common.FeatureExecutionScripts
JSON
{
"type" : "object",
"properties" : {
"scripts" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="featureExecutionScript" type="FeatureExecutionScriptsEntryType"/>
<xs:element name="featureExecutionScripts" type="FeatureExecutionScriptsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureExecutionScriptsType">
<xs:sequence>
<xs:element ref="featureExecutionScript" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="FeatureExecutionScriptsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>FeatureExecutionScript
Class: com.opencloud.sentinel.provisioning.featurescript.FeatureExecutionScript
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"src" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="featureExecutionScript" type="FeatureExecutionScriptType"/>
<xs:complexType name="FeatureExecutionScriptType">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="src" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>Features REST API
Resource Features
Resource |
Features |
|---|---|
Workspace |
Sentinel Services |
Path |
/features |
Operations
Operation |
Retrieve a list of features that can be configured |
|---|---|
Request Method |
GET |
Path |
/features |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/features/{featureKey}
Operation |
Retrieve a list of sub-resources for the specified feature |
|---|---|
Request Method |
GET |
Path |
/features/{featureKey} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/features/{featureKey}/addresslists/{schemaName}
Operation |
Retrieve a listing of address lists |
|---|---|
Request Method |
GET |
Path |
/features/{featureKey}/addresslists/{schemaName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/features/{featureKey}/addresslists/{schemaName}/config
Operation |
Create a new address list |
|---|---|
Request Method |
POST |
Path |
/features/{featureKey}/addresslists/{schemaName}/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve address list configuration |
|---|---|
Request Method |
GET |
Path |
/features/{featureKey}/addresslists/{schemaName}/config/{listName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing address list config |
|---|---|
Request Method |
PUT |
Path |
/features/{featureKey}/addresslists/{schemaName}/config/{listName} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing address list |
|---|---|
Request Method |
DELETE |
Path |
/features/{featureKey}/addresslists/{schemaName}/config/{listName} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/features/{featureKey}/addresslists/{schemaName}/lists
Operation |
Retrieve a listing of address list entries |
|---|---|
Request Method |
GET |
Path |
/features/{featureKey}/addresslists/{schemaName}/lists/{listName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new address list entry |
|---|---|
Request Method |
POST |
Path |
/features/{featureKey}/addresslists/{schemaName}/lists/{listName} |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing address list entry |
|---|---|
Request Method |
GET |
Path |
/features/{featureKey}/addresslists/{schemaName}/lists/{listName}/{address} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing address list entry |
|---|---|
Request Method |
PUT |
Path |
/features/{featureKey}/addresslists/{schemaName}/lists/{listName}/{address} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing address list entry |
|---|---|
Request Method |
DELETE |
Path |
/features/{featureKey}/addresslists/{schemaName}/lists/{listName}/{address} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/features/{featureKey}/configuration
Operation |
Retrieve feature configuration for the specified feature |
|---|---|
Request Method |
GET |
Path |
/features/{featureKey}/configuration/{configType} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: FeatureConfiguration Otherwise: FeatureConfigs |
Operation |
Retrieve feature configuration for the specified feature |
|---|---|
Request Method |
GET |
Path |
/features/{featureKey}/configuration/{configType}/{configId} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new feature config entry |
|---|---|
Request Method |
POST |
Path |
/features/{featureKey}/configuration/{configType} |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Update an existing feature config entry |
|---|---|
Request Method |
PUT |
Path |
/features/{featureKey}/configuration/{configType} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Update an existing feature config entry |
|---|---|
Request Method |
PUT |
Path |
/features/{featureKey}/configuration/{configType}/{configId} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing feature config entry |
|---|---|
Request Method |
DELETE |
Path |
/features/{featureKey}/configuration/{configType} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing feature config entry |
|---|---|
Request Method |
DELETE |
Path |
/features/{featureKey}/configuration/{configType}/{configId} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Features
Class: com.opencloud.sentinel.rest.server.resources.FeaturesResource$Features
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="features" type="FeaturesType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeaturesType">
<xs:sequence>
<xs:element ref="feature" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>AddressLists
Class: com.opencloud.sentinel.rest.common.AddressLists
JSON
{
"type" : "object",
"properties" : {
"lists" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="addressList" type="AddressListsEntryType"/>
<xs:element name="addressLists" type="AddressListsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="AddressListsType">
<xs:sequence>
<xs:element ref="addressList" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="AddressListsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>AddressListConfig
Class: com.opencloud.sentinel.provisioning.addresslists.AddressListConfig
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"defaultSearchMode" : {
"type" : "integer"
},
"shouldCache" : {
"type" : "boolean",
"required" : true
},
"version" : {
"type" : "number"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="addressListConfig" type="AddressListConfigType"/>
<xs:complexType name="AddressListConfigType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" minOccurs="0"/>
<xs:element name="defaultSearchMode" type="xs:int"/>
<xs:element name="shouldCache" type="xs:boolean"/>
<xs:element name="version" type="xs:long"/>
</xs:sequence>
</xs:complexType>
</xs:schema>AddressListEntries
Class: com.opencloud.sentinel.rest.common.AddressListEntries
JSON
{
"type" : "object",
"properties" : {
"addresses" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="addressListEntries" type="AddressListEntriesType"/>
<xs:element name="addressListEntry" type="AddressListEntriesEntryType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="AddressListEntriesType">
<xs:sequence>
<xs:element ref="addressListEntry" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="AddressListEntriesEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>AddressListEntryExt
Class: com.opencloud.sentinel.provisioning.addresslists.AddressListEntryExt
JSON
{
"type" : "object",
"properties" : {
"attributes" : {
"type" : "object"
},
"address" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="addressListEntry" type="AddressListEntryType"/>
<xs:element name="addressListEntryExt" type="AddressListEntryExtType"/>
<xs:complexType name="AddressListEntryExtType">
<xs:complexContent>
<xs:extension base="AddressListEntryType">
<xs:sequence>
<xs:element name="attributes">
<xs:complexType>
<xs:sequence>
<xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="key" minOccurs="0" type="xs:string"/>
<xs:element name="value" minOccurs="0" type="profileAttribute"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="AddressListEntryType">
<xs:sequence>
<xs:element name="address" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="profileAttribute">
<xs:sequence>
<xs:element name="array" type="xs:boolean"/>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="valueArray" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="valueString" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>FeatureConfiguration
Class: com.opencloud.sentinel.provisioning.featureconfig.FeatureConfiguration
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="featureConfiguration" type="FeatureConfigurationType"/>
<xs:complexType name="FeatureConfigurationType">
<xs:sequence>
<xs:element name="attributes">
<xs:complexType>
<xs:sequence>
<xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="key" minOccurs="0" type="xs:string"/>
<xs:element name="value" minOccurs="0" type="profileAttribute"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="profileAttribute">
<xs:sequence>
<xs:element name="array" type="xs:boolean"/>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="valueArray" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="valueString" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>FeatureConfigs
Class: com.opencloud.sentinel.rest.common.FeatureConfigs
JSON
{
"type" : "object",
"properties" : {
"configs" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="featureConfig" type="FeatureConfigsEntryType"/>
<xs:element name="featureConfigs" type="FeatureConfigsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureConfigsType">
<xs:sequence>
<xs:element ref="featureConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="FeatureConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>HTTP Determine Network Operator REST API
Resource HTTP Determine Network Operator
Resource |
HTTP Determine Network Operator |
|---|---|
Workspace |
Sentinel Services |
Path |
/httpdeterminenetworkoperator |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/httpdeterminenetworkoperator |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/httpdeterminenetworkoperator/config
Operation |
Retrieve a listing of HTTP Determine Network Operator config entries |
|---|---|
Request Method |
GET |
Path |
/httpdeterminenetworkoperator/config |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new HTTP Determine Network Operator config |
|---|---|
Request Method |
POST |
Path |
/httpdeterminenetworkoperator/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Delete an existing HTTP Determine Network Operator config |
|---|---|
Request Method |
DELETE |
Path |
/httpdeterminenetworkoperator/config/{httpFieldValue} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Retrieve an existing HTTP Determine Network Operator config |
|---|---|
Request Method |
GET |
Path |
/httpdeterminenetworkoperator/config/{httpFieldValue} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing HTTP Determine Network Operator config |
|---|---|
Request Method |
PUT |
Path |
/httpdeterminenetworkoperator/config/{httpFieldValue} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>HttpDetermineNetworkOperatorFieldValues
Class: com.opencloud.sentinel.rest.common.HttpDetermineNetworkOperatorFieldValues
JSON
{
"type" : "object",
"properties" : {
"httpFieldValues" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="httpDetermineNetworkOperatorFieldValues" type="HttpDetermineNetworkOperatorFieldValuesType"/>
<xs:element name="httpFieldValue" type="HttpDetermineNetworkOperatorFieldValuesEntryType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="HttpDetermineNetworkOperatorFieldValuesType">
<xs:sequence>
<xs:element ref="httpFieldValue" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="HttpDetermineNetworkOperatorFieldValuesEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>HttpDetermineNetworkOperatorConfig
Class: com.opencloud.sentinel.provisioning.httpdeterminenetworkoperator.HttpDetermineNetworkOperatorConfig
JSON
{
"type" : "object",
"properties" : {
"httpFieldValue" : {
"type" : "string"
},
"networkOperator" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="httpDetermineNetworkOperatorConfig" type="HttpDetermineNetworkOperatorConfigType"/>
<xs:complexType name="HttpDetermineNetworkOperatorConfigType">
<xs:sequence>
<xs:element name="httpFieldValue" type="xs:string" minOccurs="0"/>
<xs:element name="networkOperator" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>Mappers REST API
Resource Mappers
Resource |
Mappers |
|---|---|
Workspace |
Sentinel Services |
Path |
/mappers |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/mappers |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/mappers/mappersets
Operation |
Retrieve a listing of mapper sets |
|---|---|
Request Method |
GET |
Path |
/mappers/mappersets |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new mapper set |
|---|---|
Request Method |
POST |
Path |
/mappers/mappersets |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing mapper set config |
|---|---|
Request Method |
GET |
Path |
/mappers/mappersets/{mapperSetName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing mapper set config |
|---|---|
Request Method |
PUT |
Path |
/mappers/mappersets/{mapperSetName} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing mapper set |
|---|---|
Request Method |
DELETE |
Path |
/mappers/mappersets/{mapperSetName} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/mappers/mappings
Operation |
Retrieve an existing mapper set mapping or a listing of mapper set mappings |
|---|---|
Request Method |
GET |
Path |
/mappers/mappings;mapperSetName=?;mapperName=?;mapperExecutionPoint=?;sessionType=?;planId=? |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: MapperSetMapping Otherwise: MapperSetMappings |
Operation |
Create a new mapper set mapping |
|---|---|
Request Method |
POST |
Path |
/mappers/mappings |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Delete an existing mapper set mapping |
|---|---|
Request Method |
DELETE |
Path |
/mappers/mappings;mapperSetName=?;mapperName=?;mapperExecutionPoint=?;sessionType=?;planId=? |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>MapperSets
Class: com.opencloud.sentinel.rest.common.MapperSets
JSON
{
"type" : "object",
"properties" : {
"mapperSets" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="mapperSet" type="MapperSetEntryType"/>
<xs:element name="mapperSets" type="MapperSetsType"/>
<xs:complexType name="MapperSetsType">
<xs:sequence>
<xs:element ref="mapperSet" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="MapperSetEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>MapperSetConfig
Class: com.opencloud.sentinel.provisioning.mappers.MapperSetConfig
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"version" : {
"type" : "number"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="mapperSetConfig" type="MapperSetConfigType"/>
<xs:complexType name="MapperSetConfigType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="version" type="xs:long"/>
</xs:sequence>
</xs:complexType>
</xs:schema>MapperSetMapping
Class: com.opencloud.sentinel.provisioning.mappers.MapperSetMapping
JSON
{
"type" : "object",
"properties" : {
"mapperSetName" : {
"type" : "string"
},
"mappingName" : {
"type" : "string"
},
"mapperExecutionPoint" : {
"type" : "string"
},
"sessionType" : {
"type" : "string"
},
"planId" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="mapperSetMapping" type="MapperSetMappingType"/>
<xs:complexType name="MapperSetMappingType">
<xs:sequence>
<xs:element name="mapperSetName" type="xs:string"/>
<xs:element name="mappingName" type="xs:string"/>
<xs:element name="mapperExecutionPoint" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="sessionType" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="planId" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>MapperSetMappings
Class: com.opencloud.sentinel.rest.common.MapperSetMappings
JSON
{
"type" : "object",
"properties" : {
"mapperSetMappings" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"mapperSetMapping" : {
"type" : "object",
"properties" : {
"mapperSetName" : {
"type" : "string"
},
"mappingName" : {
"type" : "string"
},
"mapperExecutionPoint" : {
"type" : "string"
},
"sessionType" : {
"type" : "string"
},
"planId" : {
"type" : "string"
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="mapperSetMapping" type="MapperSetMappingType"/>
<xs:element name="mapperSetMappings" type="MapperSetMappingsType"/>
<xs:element name="mapping" type="MapperSetMappingEntryType"/>
<xs:complexType name="MapperSetMappingsType">
<xs:sequence>
<xs:element ref="mapping" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="MapperSetMappingEntryType">
<xs:sequence>
<xs:element ref="mapperSetMapping"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="MapperSetMappingType">
<xs:sequence>
<xs:element name="mapperSetName" type="xs:string"/>
<xs:element name="mappingName" type="xs:string"/>
<xs:element name="mapperExecutionPoint" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="sessionType" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="planId" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Normalization REST API
Resource Normalization
Resource |
Normalization |
|---|---|
Workspace |
Sentinel Services |
Path |
/normalization |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/normalization |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/normalization/addresslists
Operation |
Retrieve a listing of address lists |
|---|---|
Request Method |
GET |
Path |
/normalization/addresslists |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/normalization/addresslists/config
Operation |
Create a new address list |
|---|---|
Request Method |
POST |
Path |
/normalization/addresslists/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing address list config |
|---|---|
Request Method |
GET |
Path |
/normalization/addresslists/config/{listName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing address list config |
|---|---|
Request Method |
PUT |
Path |
/normalization/addresslists/config/{listName} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing address list |
|---|---|
Request Method |
DELETE |
Path |
/normalization/addresslists/config/{listName} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/normalization/addresslists/lists
Operation |
Create a new Normalization Address List Entries entry |
|---|---|
Request Method |
POST |
Path |
/normalization/addresslists/lists/{listName} |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Update an existing Normalization Address List Entries entry |
|---|---|
Request Method |
PUT |
Path |
/normalization/addresslists/lists/{listName}/{address} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Retrieve a listing of address list entries |
|---|---|
Request Method |
GET |
Path |
/normalization/addresslists/lists/{listName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Retrieve an existing address list entry |
|---|---|
Request Method |
GET |
Path |
/normalization/addresslists/lists/{listName}/{address} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Delete an existing address list entry |
|---|---|
Request Method |
DELETE |
Path |
/normalization/addresslists/lists/{listName}/{address} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/normalization/config
Operation |
Create a new Normalization Config entry |
|---|---|
Request Method |
POST |
Path |
/normalization/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Normalization Config entry or a listing of Normalization Config entries |
|---|---|
Request Method |
GET |
Path |
/normalization/config |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: NormalizationConfig Otherwise: NormalizationConfigs |
Operation |
Update an existing Normalization Config entry |
|---|---|
Request Method |
PUT |
Path |
/normalization/config |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Normalization Config entry |
|---|---|
Request Method |
DELETE |
Path |
/normalization/config |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>AddressLists
Class: com.opencloud.sentinel.rest.common.AddressLists
JSON
{
"type" : "object",
"properties" : {
"lists" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="addressList" type="AddressListsEntryType"/>
<xs:element name="addressLists" type="AddressListsType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="AddressListsType">
<xs:sequence>
<xs:element ref="addressList" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="AddressListsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>AddressListConfig
Class: com.opencloud.sentinel.provisioning.addresslists.AddressListConfig
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"defaultSearchMode" : {
"type" : "integer"
},
"shouldCache" : {
"type" : "boolean",
"required" : true
},
"version" : {
"type" : "number"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="addressListConfig" type="AddressListConfigType"/>
<xs:complexType name="AddressListConfigType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" minOccurs="0"/>
<xs:element name="defaultSearchMode" type="xs:int"/>
<xs:element name="shouldCache" type="xs:boolean"/>
<xs:element name="version" type="xs:long"/>
</xs:sequence>
</xs:complexType>
</xs:schema>AddressListEntry
Class: com.opencloud.sentinel.provisioning.addresslists.AddressListEntry
JSON
{
"type" : "object",
"properties" : {
"address" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="addressListEntry" type="AddressListEntryType"/>
<xs:complexType name="AddressListEntryType">
<xs:sequence>
<xs:element name="address" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>AddressListEntries
Class: com.opencloud.sentinel.rest.common.AddressListEntries
JSON
{
"type" : "object",
"properties" : {
"addresses" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="addressListEntries" type="AddressListEntriesType"/>
<xs:element name="addressListEntry" type="AddressListEntriesEntryType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="AddressListEntriesType">
<xs:sequence>
<xs:element ref="addressListEntry" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="AddressListEntriesEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>NormalizationConfig
Class: com.opencloud.sentinel.provisioning.normalization.NormalizationConfig
JSON
{
"type" : "object",
"properties" : {
"nationalPrefix" : {
"type" : "string"
},
"countryCode" : {
"type" : "string"
},
"networkDialingCode" : {
"type" : "string"
},
"internationalEscapeCode" : {
"type" : "string"
},
"normalizeTo" : {
"type" : "string"
},
"profileVersion" : {
"type" : "integer"
},
"minNormalizableLength" : {
"type" : "integer"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="normalizationConfig" type="NormalizationConfigType"/>
<xs:complexType name="NormalizationConfigType">
<xs:sequence>
<xs:element name="nationalPrefix" type="xs:string" minOccurs="0"/>
<xs:element name="countryCode" type="xs:string" minOccurs="0"/>
<xs:element name="networkDialingCode" type="xs:string" minOccurs="0"/>
<xs:element name="internationalEscapeCode" type="xs:string" minOccurs="0"/>
<xs:element name="normalizeTo" type="xs:string" minOccurs="0"/>
<xs:element name="profileVersion" type="xs:int"/>
<xs:element name="minNormalizableLength" type="xs:int"/>
</xs:sequence>
</xs:complexType>
</xs:schema>NormalizationConfigs
Class: com.opencloud.sentinel.rest.server.resources.normalization.NormalizationConfigResource$NormalizationConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="normalizationConfig" type="NormalizationConfigsEntryType"/>
<xs:element name="normalizationConfigs" type="NormalizationConfigsType"/>
<xs:complexType name="NormalizationConfigsType">
<xs:sequence>
<xs:element ref="normalizationConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="NormalizationConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Plans REST API
Resource Plans
Resource |
Plans |
|---|---|
Workspace |
Sentinel Services |
Path |
/plans |
Operations
Operation |
Retrieve a listing of plans |
|---|---|
Request Method |
GET |
Path |
/plans |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new plan |
|---|---|
Request Method |
POST |
Path |
/plans |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing plan |
|---|---|
Request Method |
GET |
Path |
/plans/{name} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing plan |
|---|---|
Request Method |
PUT |
Path |
/plans/{name} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing plan |
|---|---|
Request Method |
DELETE |
Path |
/plans/{name} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Plans
Class: com.opencloud.sentinel.rest.server.resources.PlansResource$Plans
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="plan" type="PlanEntryType"/>
<xs:element name="plans" type="PlansType"/>
<xs:complexType name="PlansType">
<xs:sequence>
<xs:element ref="plan" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="PlanEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Plan
Class: com.opencloud.sentinel.provisioning.plans.Plan
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="plan" type="PlanType"/>
<xs:complexType name="PlanType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>Promotions REST API
Resource Promotions
Resource |
Promotions |
|---|---|
Workspace |
Sentinel Services |
Path |
/promotions |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/promotions |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/promotions/bucketsConfig
Operation |
Retrieve a listing of Promotions Config entries |
|---|---|
Request Method |
GET |
Path |
/promotions/bucketsConfig |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new Promotions Config entry |
|---|---|
Request Method |
POST |
Path |
/promotions/bucketsConfig |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Promotions Config entry |
|---|---|
Request Method |
GET |
Path |
/promotions/bucketsConfig/{bucketName} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing Promotions Config entry |
|---|---|
Request Method |
PUT |
Path |
/promotions/bucketsConfig/{bucketName} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Promotions Config entry |
|---|---|
Request Method |
DELETE |
Path |
/promotions/bucketsConfig/{bucketName} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/promotions/configTables
Operation |
Retrieve an existing promotion table or a listing of promotion tables |
|---|---|
Request Method |
GET |
Path |
/promotions/configTables |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: PromotionTable Otherwise: PromotionTables |
Operation |
Create a new promotion table |
|---|---|
Request Method |
POST |
Path |
/promotions/configTables |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Update an existing promotion table |
|---|---|
Request Method |
PUT |
Path |
/promotions/configTables |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing promotion table |
|---|---|
Request Method |
DELETE |
Path |
/promotions/configTables |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/promotions/sqlconfig
Operation |
Create a new Promotions Config entry |
|---|---|
Request Method |
POST |
Path |
/promotions/sqlconfig |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Promotions Config entry or a listing of Promotions Config entries |
|---|---|
Request Method |
GET |
Path |
/promotions/sqlconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: PromotionsSqlConfig Otherwise: PromotionsSqlConfigs |
Operation |
Update an existing Promotions Config entry |
|---|---|
Request Method |
PUT |
Path |
/promotions/sqlconfig |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Promotions Config entry |
|---|---|
Request Method |
DELETE |
Path |
/promotions/sqlconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/promotions/buckets
Operation |
Retrieve an existing promotion bucket |
|---|---|
Request Method |
GET |
Path |
/promotions/buckets;subscriberId=?;bucketName=? |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new promotion bucket |
|---|---|
Request Method |
POST |
Path |
/promotions/buckets;subscriberId=?;bucketName=? |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Update an existing promotion bucket |
|---|---|
Request Method |
PUT |
Path |
/promotions/buckets;subscriberId=?;bucketName=? |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing promotion bucket |
|---|---|
Request Method |
DELETE |
Path |
/promotions/buckets;subscriberId=?;bucketName=? |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/promotions/config
Operation |
Create a new Promotions Config entry |
|---|---|
Request Method |
POST |
Path |
/promotions/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Promotions Config entry or a listing of Promotions Config entries |
|---|---|
Request Method |
GET |
Path |
/promotions/config |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: PromotionsConfig Otherwise: PromotionsConfigs |
Operation |
Update an existing Promotions Config entry |
|---|---|
Request Method |
PUT |
Path |
/promotions/config |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Promotions Config entry |
|---|---|
Request Method |
DELETE |
Path |
/promotions/config |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>PromotionsBucketsConfigs
Class: com.opencloud.sentinel.rest.server.resources.PromotionBucketsConfigResource$PromotionsBucketsConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="promotionsBucketsConfig" type="PromotionsBucketsConfigsEntryType"/>
<xs:element name="promotionsBucketsConfigs" type="PromotionsBucketsConfigsType"/>
<xs:complexType name="PromotionsBucketsConfigsType">
<xs:sequence>
<xs:element ref="promotionsBucketsConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="PromotionsBucketsConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>PromotionsBucketsConfig
Class: com.opencloud.sentinel.provisioning.promotions.PromotionsBucketsConfig
JSON
{
"type" : "object",
"properties" : {
"bucketName" : {
"type" : "string"
},
"dataSource" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="promotionsBucketsConfig" type="PromotionsBucketsConfigType"/>
<xs:complexType name="PromotionsBucketsConfigType">
<xs:sequence>
<xs:element name="bucketName" type="xs:string" minOccurs="0"/>
<xs:element name="dataSource" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>PromotionTable
Class: com.opencloud.sentinel.provisioning.promotions.PromotionTable
JSON
{
"type" : "object",
"properties" : {
"promotions" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"promotionName" : {
"type" : "string"
},
"bucketName" : {
"type" : "string"
},
"conditionSrc" : {
"type" : "string"
},
"priority" : {
"type" : "integer"
},
"validityStart" : {
"type" : "number"
},
"validityEnd" : {
"type" : "number"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="promotionConfig" type="PromotionConfigType"/>
<xs:element name="promotionTable" type="PromotionTableType"/>
<xs:complexType name="PromotionTableType">
<xs:sequence>
<xs:element ref="promotionConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PromotionConfigType">
<xs:sequence>
<xs:element name="promotionName" type="xs:string" minOccurs="0"/>
<xs:element name="bucketName" type="xs:string" minOccurs="0"/>
<xs:element name="conditionSrc" type="xs:string" minOccurs="0"/>
<xs:element name="priority" type="xs:int"/>
<xs:element name="validityStart" type="xs:long"/>
<xs:element name="validityEnd" type="xs:long"/>
</xs:sequence>
</xs:complexType>
</xs:schema>PromotionTables
Class: com.opencloud.sentinel.rest.common.PromotionTables
JSON
{
"type" : "object",
"properties" : {
"promotionTables" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"selectionKey" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="promotionTable" type="PromotionTableEntryType"/>
<xs:element name="promotionTables" type="PromotionTablesType"/>
<xs:complexType name="PromotionTablesType">
<xs:sequence>
<xs:element ref="promotionTable" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="PromotionTableEntryType">
<xs:sequence>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="selectionKey" type="xs:string"/>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>PromotionsSqlConfig
Class: com.opencloud.sentinel.provisioning.promotions.PromotionsSqlConfig
JSON
{
"type" : "object",
"properties" : {
"listAllSQL" : {
"type" : "string"
},
"loadSQL" : {
"type" : "string"
},
"updateSQL" : {
"type" : "string"
},
"deleteSQL" : {
"type" : "string"
},
"addSQL" : {
"type" : "string"
},
"databaseRequestTimeout" : {
"type" : "integer"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="promotionsSqlConfig" type="PromotionsSqlConfigType"/>
<xs:complexType name="PromotionsSqlConfigType">
<xs:sequence>
<xs:element name="listAllSQL" type="xs:string" minOccurs="0"/>
<xs:element name="loadSQL" type="xs:string" minOccurs="0"/>
<xs:element name="updateSQL" type="xs:string" minOccurs="0"/>
<xs:element name="deleteSQL" type="xs:string" minOccurs="0"/>
<xs:element name="addSQL" type="xs:string" minOccurs="0"/>
<xs:element name="databaseRequestTimeout" type="xs:int"/>
</xs:sequence>
</xs:complexType>
</xs:schema>PromotionsSqlConfigs
Class: com.opencloud.sentinel.rest.server.resources.PromotionsSqlResource$PromotionsSqlConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="promotionsSqlConfig" type="PromotionsSqlConfigsEntryType"/>
<xs:element name="promotionsSqlConfigs" type="PromotionsSqlConfigsType"/>
<xs:complexType name="PromotionsSqlConfigsType">
<xs:sequence>
<xs:element ref="promotionsSqlConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="PromotionsSqlConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>PromotionBucket
Class: com.opencloud.sentinel.provisioning.promotions.PromotionBucket
JSON
{
"type" : "object",
"properties" : {
"availableUnits" : {
"type" : "number"
},
"reservedUnits" : {
"type" : "number"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="promotionBucket" type="PromotionBucketType"/>
<xs:complexType name="PromotionBucketType">
<xs:sequence>
<xs:element name="availableUnits" type="xs:long"/>
<xs:element name="reservedUnits" type="xs:long"/>
</xs:sequence>
</xs:complexType>
</xs:schema>PromotionsConfig
Class: com.opencloud.sentinel.provisioning.promotions.PromotionsConfig
JSON
{
"type" : "object",
"properties" : {
"defaultDataSource" : {
"type" : "string"
},
"unitGrantingMode" : {
"type" : "string"
},
"promotionApplicationMode" : {
"type" : "string"
},
"partialGrantingThreshold" : {
"type" : "number"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="promotionsConfig" type="PromotionsConfigType"/>
<xs:complexType name="PromotionsConfigType">
<xs:sequence>
<xs:element name="defaultDataSource" type="xs:string" minOccurs="0"/>
<xs:element name="unitGrantingMode" type="xs:string" minOccurs="0"/>
<xs:element name="promotionApplicationMode" type="xs:string" minOccurs="0"/>
<xs:element name="partialGrantingThreshold" type="xs:long"/>
</xs:sequence>
</xs:complexType>
</xs:schema>PromotionsConfigs
Class: com.opencloud.sentinel.rest.server.resources.PromotionsConfigResource$PromotionsConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="promotionsConfig" type="PromotionsConfigsEntryType"/>
<xs:element name="promotionsConfigs" type="PromotionsConfigsType"/>
<xs:complexType name="PromotionsConfigsType">
<xs:sequence>
<xs:element ref="promotionsConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="PromotionsConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Registrar Determine Network Operator REST API
Resource Registrar Determine Network Operator
Resource |
Registrar Determine Network Operator |
|---|---|
Workspace |
Sentinel Registrar Services |
Path |
/registrardeterminenetworkoperator |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/registrardeterminenetworkoperator |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/registrardeterminenetworkoperator/config
Operation |
Create a new Registrar Determine Network Operator config |
|---|---|
Request Method |
POST |
Path |
/registrardeterminenetworkoperator/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve a listing of Registrar Determine Network Operator config entries |
|---|---|
Request Method |
GET |
Path |
/registrardeterminenetworkoperator/config |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Retrieve an existing Registrar Determine Network Operator config |
|---|---|
Request Method |
GET |
Path |
/registrardeterminenetworkoperator/config/{lookupKey} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing Registrar Determine Network Operator config |
|---|---|
Request Method |
PUT |
Path |
/registrardeterminenetworkoperator/config/{lookupKey} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Registrar Determine Network Operator config |
|---|---|
Request Method |
DELETE |
Path |
/registrardeterminenetworkoperator/config/{lookupKey} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>RegistrarDetermineNetworkOperatorConfig
Class: com.opencloud.sentinel.provisioning.registrardeterminenetworkoperator.RegistrarDetermineNetworkOperatorConfig
JSON
{
"type" : "object",
"properties" : {
"lookupKey" : {
"type" : "string"
},
"networkOperator" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="registrarDetermineNetworkOperatorConfig" type="RegistrarDetermineNetworkOperatorConfigType"/>
<xs:complexType name="RegistrarDetermineNetworkOperatorConfigType">
<xs:sequence>
<xs:element name="lookupKey" type="xs:string" minOccurs="0"/>
<xs:element name="networkOperator" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>RegistrarDetermineNetworkOperatorLookupKeys
Class: com.opencloud.sentinel.provisioning.rest.registrardeterminenetworkoperator.RegistrarDetermineNetworkOperatorLookupKeys
JSON
{
"type" : "object",
"properties" : {
"lookupKeys" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="lookupKey" type="RegistrarDetermineNetworkOperatorLookupKeysEntryType"/>
<xs:element name="registrarDetermineNetworkOperatorLookupKeys" type="RegistrarDetermineNetworkOperatorLookupKeysType"/>
<xs:complexType name="RegistrarDetermineNetworkOperatorLookupKeysType">
<xs:sequence>
<xs:element ref="lookupKey" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="RegistrarDetermineNetworkOperatorLookupKeysEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Sentinel Core REST API
Resource Sentinel Core
Resource |
Sentinel Core |
|---|---|
Workspace |
Sentinel Services |
Path |
/sentinelcore |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/sentinelcore |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/sentinelcore/config
Operation |
Create a new Sentinel core config |
|---|---|
Request Method |
POST |
Path |
/sentinelcore/config |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve the existing Sentinel core config |
|---|---|
Request Method |
GET |
Path |
/sentinelcore/config |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update the existing Sentinel core config |
|---|---|
Request Method |
PUT |
Path |
/sentinelcore/config |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete the existing Sentinel core config |
|---|---|
Request Method |
DELETE |
Path |
/sentinelcore/config |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>SentinelCoreConfig
Class: com.opencloud.sentinel.provisioning.core.SentinelCoreConfig
JSON
{
"type" : "object",
"properties" : {
"platformOperator" : {
"type" : "string"
},
"defaultNetworkOperator" : {
"type" : "string"
},
"networkOperators" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"httpParameterForHttpDetermineNetworkOperator" : {
"type" : "string"
},
"defaultOcsEntityId" : {
"type" : "string"
},
"maximumCallDuration" : {
"type" : "string"
},
"featureTimeOut" : {
"type" : "integer"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="sentinelCoreConfig" type="SentinelCoreConfigType"/>
<xs:complexType name="SentinelCoreConfigType">
<xs:sequence>
<xs:element name="platformOperator" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="defaultNetworkOperator" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="networkOperators" nillable="true" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="httpParameterForHttpDetermineNetworkOperator" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="defaultOcsEntityId" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="maximumCallDuration" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="featureTimeOut" type="xs:int"/>
</xs:sequence>
</xs:complexType>
</xs:schema>Sentinel Install Information REST API
Resource Sentinel Install Information
Resource |
Sentinel Install Information |
|---|---|
Workspace |
Sentinel Services |
Path |
/installinfo |
Operations
Operation |
Retrieve feature metadata for the specified feature |
|---|---|
Request Method |
HEAD |
Path |
/installinfo/features/{featureGroup}/{featureName} |
Parameters |
|
Request Body |
Not used |
Success Result |
Undefined |
Response Headers |
None |
Response Body |
Not used |
Session Types REST API
Resource Session Types
Resource |
Session Types |
|---|---|
Workspace |
Sentinel Services |
Path |
/sessiontypes |
Operations
Operation |
Retrieve a listing of session types |
|---|---|
Request Method |
GET |
Path |
/sessiontypes |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new session type |
|---|---|
Request Method |
POST |
Path |
/sessiontypes |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing session type |
|---|---|
Request Method |
GET |
Path |
/sessiontypes/{name} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing session type |
|---|---|
Request Method |
PUT |
Path |
/sessiontypes/{name} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing session type |
|---|---|
Request Method |
DELETE |
Path |
/sessiontypes/{name} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
SessionTypes
Class: com.opencloud.sentinel.rest.server.resources.SessionTypesResource$SessionTypes
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="sessionType" type="SessionTypeEntryType"/>
<xs:element name="sessionTypes" type="SessionTypesType"/>
<xs:complexType name="SessionTypesType">
<xs:sequence>
<xs:element ref="sessionType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="SessionTypeEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>SessionType
Class: com.opencloud.sentinel.provisioning.sessiontypes.SessionType
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="sessionType" type="SessionTypeType"/>
<xs:complexType name="SessionTypeType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>Subscriber Data REST API
Resource Subscriber Data
Resource |
Subscriber Data |
|---|---|
Workspace |
Sentinel Services |
Path |
/subscriberdata |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/subscriberdata |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/subscriberdata/lookupconfig
Operation |
Retrieve an existing Subscriber Data Config entry or a listing of Subscriber Data Config entries |
|---|---|
Request Method |
GET |
Path |
/subscriberdata/lookupconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: SubscriberDataLookupLookupConfig Otherwise: SubscriberDataLookupLookupConfigs |
Operation |
Update an existing Subscriber Data Config entry |
|---|---|
Request Method |
PUT |
Path |
/subscriberdata/lookupconfig |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Subscriber Data Config entry |
|---|---|
Request Method |
DELETE |
Path |
/subscriberdata/lookupconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Create a new Subscriber Data Config entry |
|---|---|
Request Method |
POST |
Path |
/subscriberdata/lookupconfig |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
/subscriberdata/sqlconfig
Operation |
Update an existing Subscriber Data Config entry |
|---|---|
Request Method |
PUT |
Path |
/subscriberdata/sqlconfig |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Subscriber Data Config entry |
|---|---|
Request Method |
DELETE |
Path |
/subscriberdata/sqlconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Create a new Subscriber Data Config entry |
|---|---|
Request Method |
POST |
Path |
/subscriberdata/sqlconfig |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing Subscriber Data Config entry or a listing of Subscriber Data Config entries |
|---|---|
Request Method |
GET |
Path |
/subscriberdata/sqlconfig |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: SubscriberDataLookupSqlConfig Otherwise: SubscriberDataLookupSqlConfigs |
/subscriberdata/records
Operation |
Create a new subscriber data record |
|---|---|
Request Method |
POST |
Path |
/subscriberdata/records |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing subscriber data record |
|---|---|
Request Method |
GET |
Path |
/subscriberdata/records/{subscriberId} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Retrieve IMS public user identities for an existing subscriber data record |
|---|---|
Request Method |
GET |
Path |
/subscriberdata/records/{subscriberId}/imsPublicUserIdentities |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing subscriber data record |
|---|---|
Request Method |
PUT |
Path |
/subscriberdata/records/{subscriberId} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Update IMS public user identities for an existing subscriber data record |
|---|---|
Request Method |
PUT |
Path |
/subscriberdata/records/{subscriberId}/imsPublicUserIdentities |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Add an IMS public user identity for an existing subscriber data record |
|---|---|
Request Method |
POST |
Path |
/subscriberdata/records/{subscriberId}/imsPublicUserIdentities |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Remove an IMS public user identity from an existing subscriber data record |
|---|---|
Request Method |
DELETE |
Path |
/subscriberdata/records/{subscriberId}/imsPublicUserIdentities/{imsPublicUserIdentity} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing subscriber data record |
|---|---|
Request Method |
DELETE |
Path |
/subscriberdata/records/{subscriberId} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
/subscriberdata/fields
Operation |
Create a new subscriber data lookup fields config |
|---|---|
Request Method |
POST |
Path |
/subscriberdata/fields |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing subscriber data lookup fields config or a listing of subscriber data lookup fields configs |
|---|---|
Request Method |
GET |
Path |
/subscriberdata/fields |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: SubscriberDataLookupFields Otherwise: SubscriberDataLookupFieldsListing |
Operation |
Update an existing subscriber data lookup fields config |
|---|---|
Request Method |
PUT |
Path |
/subscriberdata/fields |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing subscriber data lookup fields config |
|---|---|
Request Method |
DELETE |
Path |
/subscriberdata/fields |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>SubscriberDataLookupLookupConfig
Class: com.opencloud.sentinel.provisioning.subscriberdata.SubscriberDataLookupLookupConfig
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="subscriberDataLookupLookupConfig" type="SubscriberDataLookupLookupConfigType"/>
<xs:complexType name="SubscriberDataLookupLookupConfigType">
<xs:sequence>
<xs:element name="lookupType" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>SubscriberDataLookupLookupConfigs
Class: com.opencloud.sentinel.rest.server.resources.SubscriberDataLookupConfigResource$SubscriberDataLookupLookupConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="subscriberDataLookupLookupConfig" type="SubscriberDataLookupLookupConfigsEntryType"/>
<xs:element name="subscriberDataLookupLookupConfigs" type="SubscriberDataLookupLookupConfigsType"/>
<xs:complexType name="SubscriberDataLookupLookupConfigsType">
<xs:sequence>
<xs:element ref="subscriberDataLookupLookupConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="SubscriberDataLookupLookupConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>SubscriberDataLookupSqlConfig
Class: com.opencloud.sentinel.provisioning.subscriberdata.SubscriberDataLookupSqlConfig
JSON
{
"type" : "object",
"properties" : {
"listSQL" : {
"type" : "string"
},
"loadSQL" : {
"type" : "string"
},
"updateSQL" : {
"type" : "string"
},
"deleteSQL" : {
"type" : "string"
},
"insertSQL" : {
"type" : "string"
},
"loadByImsPublicUserIdentitySQL" : {
"type" : "string"
},
"listImsPublicUserIdentitiesSQL" : {
"type" : "string"
},
"insertImsPublicUserIdentitySQL" : {
"type" : "string"
},
"deleteImsPublicUserIdentitySQL" : {
"type" : "string"
},
"deleteAllImsPublicUserIdentitiesForSubscriberSQL" : {
"type" : "string"
},
"databaseRequestTimeout" : {
"type" : "integer"
},
"asynchronousQuery" : {
"type" : "boolean",
"required" : true
},
"useImsPublicUserIdentities" : {
"type" : "boolean",
"required" : true
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="subscriberDataLookupSqlConfig" type="SubscriberDataLookupSqlConfigType"/>
<xs:complexType name="SubscriberDataLookupSqlConfigType">
<xs:sequence>
<xs:element name="listSQL" type="xs:string" minOccurs="0"/>
<xs:element name="loadSQL" type="xs:string" minOccurs="0"/>
<xs:element name="updateSQL" type="xs:string" minOccurs="0"/>
<xs:element name="deleteSQL" type="xs:string" minOccurs="0"/>
<xs:element name="insertSQL" type="xs:string" minOccurs="0"/>
<xs:element name="loadByImsPublicUserIdentitySQL" type="xs:string" minOccurs="0"/>
<xs:element name="listImsPublicUserIdentitiesSQL" type="xs:string" minOccurs="0"/>
<xs:element name="insertImsPublicUserIdentitySQL" type="xs:string" minOccurs="0"/>
<xs:element name="deleteImsPublicUserIdentitySQL" type="xs:string" minOccurs="0"/>
<xs:element name="deleteAllImsPublicUserIdentitiesForSubscriberSQL" type="xs:string" minOccurs="0"/>
<xs:element name="databaseRequestTimeout" type="xs:int"/>
<xs:element name="asynchronousQuery" type="xs:boolean"/>
<xs:element name="useImsPublicUserIdentities" type="xs:boolean"/>
</xs:sequence>
</xs:complexType>
</xs:schema>SubscriberDataLookupSqlConfigs
Class: com.opencloud.sentinel.rest.server.resources.SubscriberDataSqlResource$SubscriberDataLookupSqlConfigs
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="subscriberDataLookupSqlConfig" type="SubscriberDataLookupSqlConfigsEntryType"/>
<xs:element name="subscriberDataLookupSqlConfigs" type="SubscriberDataLookupSqlConfigsType"/>
<xs:complexType name="SubscriberDataLookupSqlConfigsType">
<xs:sequence>
<xs:element ref="subscriberDataLookupSqlConfig" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="SubscriberDataLookupSqlConfigsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>SubscriberDataRecord
Class: com.opencloud.sentinel.provisioning.subscriberdata.SubscriberDataRecord
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"subscriberData" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "String", "Boolean", "Integer", "String[]", "Date", "Date[]" ]
},
"valueString" : {
"type" : "string"
},
"valueInt" : {
"type" : "integer"
},
"valueBoolean" : {
"type" : "boolean"
},
"valueArray" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"valueDate" : {
"type" : "number"
},
"valueDateArray" : {
"type" : "array",
"items" : {
"type" : "number"
}
}
}
}
},
"imsPublicUserIdentities" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="subscriberDataItem" type="SubscriberDataItemType"/>
<xs:element name="subscriberDataRecord" type="SubscriberDataRecordType"/>
<xs:complexType name="SubscriberDataRecordType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element ref="subscriberDataItem" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="imsPublicUserIdentities" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="imsPublicUserIdentity" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SubscriberDataItemType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="type" type="dataType" minOccurs="0"/>
<xs:element name="valueString" type="xs:string" minOccurs="0"/>
<xs:element name="valueInt" type="xs:int" minOccurs="0"/>
<xs:element name="valueBoolean" type="xs:boolean" minOccurs="0"/>
<xs:element name="valueArray" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="valueDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="valueDateArray" type="xs:dateTime" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="dataType">
<xs:restriction base="xs:string">
<xs:enumeration value="String"/>
<xs:enumeration value="Boolean"/>
<xs:enumeration value="Integer"/>
<xs:enumeration value="String[]"/>
<xs:enumeration value="Date"/>
<xs:enumeration value="Date[]"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>ImsPublicUserIdentities
Class: com.opencloud.sentinel.rest.subscriberdata.ImsPublicUserIdentities
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="imsPublicUserIdentities" type="ImsPublicUserIdentitiesType"/>
<xs:complexType name="ImsPublicUserIdentitiesType">
<xs:sequence>
<xs:element name="imsPublicUserIdentity" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:schema>SubscriberDataLookupFields
Class: com.opencloud.sentinel.provisioning.subscriberdata.SubscriberDataLookupFields
JSON
{
"type" : "object",
"properties" : {
"fields" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "String", "Boolean", "Integer", "String[]", "Date", "Date[]" ]
},
"sessionStateFieldName" : {
"type" : "string"
},
"resFieldName" : {
"type" : "string"
},
"colIdx" : {
"type" : "string"
},
"insertParamIdx" : {
"type" : "integer"
},
"updateParamIdx" : {
"type" : "integer"
},
"displayName" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"required" : {
"type" : "boolean",
"required" : true
},
"idField" : {
"type" : "boolean",
"required" : true
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="subscriberDataLookupField" type="SubscriberDataLookupFieldType"/>
<xs:element name="subscriberDataLookupFields" type="SubscriberDataLookupFieldsType"/>
<xs:complexType name="SubscriberDataLookupFieldsType">
<xs:sequence>
<xs:element ref="subscriberDataLookupField" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SubscriberDataLookupFieldType">
<xs:sequence>
<xs:element name="type" type="dataType" minOccurs="0"/>
<xs:element name="sessionStateFieldName" type="xs:string" minOccurs="0"/>
<xs:element name="resFieldName" type="xs:string" minOccurs="0"/>
<xs:element name="colIdx" type="xs:string" minOccurs="0"/>
<xs:element name="insertParamIdx" type="xs:int"/>
<xs:element name="updateParamIdx" type="xs:int"/>
<xs:element name="displayName" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" minOccurs="0"/>
<xs:element name="required" type="xs:boolean"/>
<xs:element name="idField" type="xs:boolean"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="dataType">
<xs:restriction base="xs:string">
<xs:enumeration value="String"/>
<xs:enumeration value="Boolean"/>
<xs:enumeration value="Integer"/>
<xs:enumeration value="String[]"/>
<xs:enumeration value="Date"/>
<xs:enumeration value="Date[]"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>SubscriberDataLookupFieldsListing
Class: com.opencloud.sentinel.rest.server.resources.SubscriberDataLookupFieldsResource$SubscriberDataLookupFieldsListing
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
},
"selectionKey" : {
"type" : "string"
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="subscriberDataLookupFieldsEntry" type="SubscriberDataLookupFieldsEntryType"/>
<xs:element name="subscriberDataLookupFieldsListing" type="SubscriberDataLookupFieldsListingType"/>
<xs:complexType name="SubscriberDataLookupFieldsListingType">
<xs:sequence>
<xs:element ref="subscriberDataLookupFieldsEntry" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="SubscriberDataLookupFieldsEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence>
<xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Subscriptions REST API
Resource Subscriptions
Resource |
Subscriptions |
|---|---|
Workspace |
Sentinel Services |
Path |
/subscriptions |
Operations
Operation |
Retrieve a listing of subscriptions |
|---|---|
Request Method |
GET |
Path |
/subscriptions |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new subscription |
|---|---|
Request Method |
POST |
Path |
/subscriptions |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing subscription |
|---|---|
Request Method |
GET |
Path |
/subscriptions/{name} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing subscription |
|---|---|
Request Method |
PUT |
Path |
/subscriptions/{name} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing subscription |
|---|---|
Request Method |
DELETE |
Path |
/subscriptions/{name} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Subscriptions
Class: com.opencloud.sentinel.rest.server.resources.SubscriptionsResource$Subscriptions
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="subscription" type="SubscriptionEntryType"/>
<xs:element name="subscriptions" type="SubscriptionsType"/>
<xs:complexType name="SubscriptionsType">
<xs:sequence>
<xs:element ref="subscription" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="SubscriptionEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>Subscription
Class: com.opencloud.sentinel.provisioning.subscriptions.Subscription
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="subscription" type="SubscriptionType"/>
<xs:complexType name="SubscriptionType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>XCAP Server Configuration REST API
Resource XCAP Server Configuration
Resource |
XCAP Server Configuration |
|---|---|
Workspace |
Sentinel Services |
Path |
/xcap |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/xcap |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/xcap/hostmappings
Operation |
Retrieve a listing of XCAP host mappings |
|---|---|
Request Method |
GET |
Path |
/xcap/hostmappings |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Create a new XCAP host mapping |
|---|---|
Request Method |
POST |
Path |
/xcap/hostmappings |
Parameters |
|
Request Body |
|
Success Result |
201 Created |
Response Headers |
Location — contains the URL to access the created record |
Response Body |
Not used |
Operation |
Retrieve an existing XCAP host mapping |
|---|---|
Request Method |
GET |
Path |
/xcap/hostmappings/{hostname} |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
Operation |
Update an existing XCAP host mapping |
|---|---|
Request Method |
PUT |
Path |
/xcap/hostmappings/{hostname} |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing XCAP host mapping |
|---|---|
Request Method |
DELETE |
Path |
/xcap/hostmappings/{hostname} |
Parameters |
|
Request Body |
Not used |
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Schemas
Feature
Class: com.opencloud.sentinel.rest.common.Feature
JSON
{
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="feature" type="FeatureType"/>
<xs:element name="link" type="LinkType"/>
<xs:complexType name="FeatureType">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>XcapHostMappings
Class: com.opencloud.sentinel.rest.server.resources.XcapHostMappingResource$XcapHostMappings
JSON
{
"type" : "object",
"properties" : {
"entries" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"resources" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"rel" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"title" : {
"type" : "string"
}
}
}
}
}
}
},
"next" : {
"type" : "string"
},
"prev" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="link" type="LinkType"/>
<xs:element name="xcapHostMapping" type="XcapHostMappingEntryType"/>
<xs:element name="xcapHostMappings" type="XcapHostMappingsType"/>
<xs:complexType name="XcapHostMappingsType">
<xs:sequence>
<xs:element ref="xcapHostMapping" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="next" type="xs:string"/>
<xs:attribute name="prev" type="xs:string"/>
</xs:complexType>
<xs:complexType name="XcapHostMappingEntryType">
<xs:complexContent>
<xs:extension base="simpleEntry">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="simpleEntry" abstract="true">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
<xs:element name="resources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LinkType">
<xs:sequence/>
<xs:attribute name="rel" type="xs:string"/>
<xs:attribute name="href" type="xs:string"/>
<xs:attribute name="title" type="xs:string"/>
</xs:complexType>
</xs:schema>XcapHostMappingDto
Class: com.opencloud.sentinel.provisioning.xcap.XcapHostMappingDto
JSON
{
"type" : "object",
"properties" : {
"hostname" : {
"type" : "string"
},
"rhinoInstanceId" : {
"type" : "string"
},
"networkOperator" : {
"type" : "string"
},
"remUserAccount" : {
"type" : "string"
}
}
}XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="xcapHostMapping" type="XcapHostMappingType"/>
<xs:complexType name="XcapHostMappingType">
<xs:sequence>
<xs:element name="hostname" type="xs:string"/>
<xs:element name="rhinoInstanceId" type="xs:string"/>
<xs:element name="networkOperator" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="remUserAccount" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>