Resource Plans

Resource

Plans

Workspace

Sentinel Services

Path

/plans

Operations

Operation

Create a new plan

Request Method

POST

Path

/plans

Parameters

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

  • networkOperator — the network operator scope to use

Request Body

Plan

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation

Retrieve a listing of plans

Request Method

GET

Path

/plans

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)

  • networkOperator — the network operator scope to use

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

Plans

Operation

Update an existing plan

Request Method

PUT

Path

/plans/{name}

Parameters

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

  • networkOperator — the network operator scope to use

Request Body

Plan

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Delete an existing plan

Request Method

DELETE

Path

/plans/{name}

Parameters

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

  • networkOperator — the network operator scope to use

Request Body

Not used

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Retrieve an existing plan

Request Method

GET

Path

/plans/{name}

Parameters

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

  • networkOperator — the network operator scope to use

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

Plan

Schemas

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>

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