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

Feature

/sentinelcore/config

Operation

Create a new Sentinel core config

Request Method

POST

Path

/sentinelcore/config

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

Request Body

SentinelCoreConfig

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

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

  • page — the page to retrieve if results span multiple pages (default = 1 if not provided)

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

SentinelCoreConfig

Operation

Update the existing Sentinel core config

Request Method

PUT

Path

/sentinelcore/config

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

Request Body

SentinelCoreConfig

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

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

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"
    },
    "periodicWorkInterval" : {
      "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:element name="periodicWorkInterval" type="xs:int"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>
Previous page Next page