Resource Sentinel Registrar
Resource |
Sentinel Registrar |
|---|---|
Workspace |
Sentinel Services |
Path |
/sentinelregistrar |
Operations
Operation |
Retrieve a list of sub-resources offered by this resource |
|---|---|
Request Method |
GET |
Path |
/sentinelregistrar |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
/sentinelregistrar/config
Operation |
Create a new Sentinel Registrar Config entry |
|---|---|
Request Method |
POST |
Path |
/sentinelregistrar/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 Sentinel Registrar Config entry or a listing of Sentinel Registrar Config entries |
|---|---|
Request Method |
GET |
Path |
/sentinelregistrar/config |
Parameters |
|
Request Body |
Not used |
Success Result |
200 OK |
Response Headers |
None |
Response Body |
If scope is provided: SentinelRegistrarConfig Otherwise: SentinelRegistrarConfigs |
Operation |
Update an existing Sentinel Registrar Config entry |
|---|---|
Request Method |
PUT |
Path |
/sentinelregistrar/config |
Parameters |
|
Request Body |
|
Success Result |
204 No content |
Response Headers |
None |
Response Body |
Not used |
Operation |
Delete an existing Sentinel Registrar Config entry |
|---|---|
Request Method |
DELETE |
Path |
/sentinelregistrar/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>SentinelRegistrarConfig
Class: com.opencloud.sentinel.provisioning.registrar.SentinelRegistrarConfig
JSON
{
"type" : "object",
"properties" : {
"atuSti" : {
"type" : "string"
},
"atcfUpdateTimeout" : {
"type" : "number"
},
"subscriberDataFacadeType" : {
"type" : "string"
},
"stnSr" : {
"type" : "string"
},
"writeAuditCdr" : {
"type" : "boolean",
"required" : true
},
"auditCdrPrivateIdFilter" : {
"type" : "string"
},
"cdrStreamName" : {
"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="sentinelRegistrarConfig" type="SentinelRegistrarConfigType"/>
<xs:complexType name="SentinelRegistrarConfigType">
<xs:sequence>
<xs:element name="atuSti" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="atcfUpdateTimeout" type="xs:long"/>
<xs:element name="subscriberDataFacadeType" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="stnSr" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="writeAuditCdr" type="xs:boolean"/>
<xs:element name="auditCdrPrivateIdFilter" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="cdrStreamName" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>SentinelRegistrarConfigs
Class: com.opencloud.sentinel.rest.server.resources.registrar.SentinelRegistrarConfigResource$SentinelRegistrarConfigs
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="sentinelRegistrarConfig" type="SentinelRegistrarConfigsEntryType"/>
<xs:element name="sentinelRegistrarConfigs" type="SentinelRegistrarConfigsType"/>
<xs:complexType name="SentinelRegistrarConfigsType">
<xs:sequence>
<xs:element ref="sentinelRegistrarConfig" 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="SentinelRegistrarConfigsEntryType">
<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>