Sentinel IP-SM-GW 2.9.0 :: Sentinel IP-SM-GW Provisioning REST API

Resource Mappers

Resource	Mappers
Workspace	Sentinel Services
Path	/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	Feature

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

Feature

/mappers/mappersets

Operation	Retrieve a listing of mapper sets
Request Method	GET
Path	/mappers/mappersets
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	MapperSets

Operation

Retrieve a listing of mapper sets

Request Method

GET

Path

/mappers/mappersets

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

MapperSets

Operation	Create a new mapper set
Request Method	POST
Path	/mappers/mappersets
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
Request Body	MapperSetConfig
Success Result	201 Created
Response Headers	Location — contains the URL to access the created record
Response Body	Not used

Operation

Create a new mapper set

Request Method

POST

Path

/mappers/mappersets

Parameters

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

Request Body

MapperSetConfig

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	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	MapperSetConfig

Operation

Retrieve an existing mapper set config

Request Method

GET

Path

/mappers/mappersets/{mapperSetName}

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

MapperSetConfig

Operation	Update an existing mapper set config
Request Method	PUT
Path	/mappers/mappersets/{mapperSetName}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
Request Body	MapperSetConfig
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Update an existing mapper set config

Request Method

PUT

Path

/mappers/mappersets/{mapperSetName}

Parameters

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

Request Body

MapperSetConfig

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	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

Delete an existing mapper set

Request Method

DELETE

Path

/mappers/mappersets/{mapperSetName}

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

/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	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	If scope is provided: MapperSetMapping Otherwise: MapperSetMappings

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

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

If scope is provided: MapperSetMapping Otherwise: MapperSetMappings

Operation	Create a new mapper set mapping
Request Method	POST
Path	/mappers/mappings
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
Request Body	MapperSetMapping
Success Result	201 Created
Response Headers	Location — contains the URL to access the created record
Response Body	Not used

Operation

Create a new mapper set mapping

Request Method

POST

Path

/mappers/mappings

Parameters

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

Request Body

MapperSetMapping

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	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

Delete an existing mapper set mapping

Request Method

DELETE

Path

/mappers/mappings;mapperSetName=?;mapperName=?;mapperExecutionPoint=?;sessionType=?;planId=?

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>

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>

Previous page Next page

Mappers REST API

Resource Mappers

Operations

/mappers/mappersets

/mappers/mappings

Schemas

Feature

JSON

XML

MapperSets

JSON

XML

MapperSetConfig

JSON

XML

MapperSetMapping

JSON

XML

MapperSetMappings

JSON

XML