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

  • 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

/correlation/{raEntityName}/config

Operation

Retrieve an existing correlation config

Request Method

GET

Path

/correlation/{raEntityName}/config

Parameters

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

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

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

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

  • 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

Operation

Create a new correlation config

Request Method

POST

Path

/correlation/{raEntityName}/config

Parameters

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

Request Body

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

/correlation/{raEntityName}/pools

Operation

Create a new correlation id pool

Request Method

POST

Path

/correlation/{raEntityName}/pools

Parameters

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

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

  • 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

Operation

Update an existing correlation id pool config

Request Method

PUT

Path

/correlation/{raEntityName}/pools/{poolName}

Parameters

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

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

  • 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

Operation

Retrieve an existing correlation id pool config

Request Method

GET

Path

/correlation/{raEntityName}/pools/{poolName}

Parameters

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

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>
Previous page Next page