Sentinel Express 4.0.0 :: Sentinel Provisioning REST API :: Feature Execution Scripts REST API

Resource Feature Execution Scripts

Resource	Feature Execution Scripts
Workspace	Sentinel Services
Path	/featureexecutionscripts

Resource

Feature Execution Scripts

Workspace

Sentinel Services

Path

/featureexecutionscripts

Operations

Operation	Retrieve a list of sub-resources offered by this resource
Request Method	GET
Path	/featureexecutionscripts
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

/featureexecutionscripts

Parameters

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

Feature

/featureexecutionscripts/executionpoints

Operation	Create a new Feature Execution Scripts Config entry
Request Method	POST
Path	/featureexecutionscripts/executionpoints
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	FeatureExecutionScriptAssociation
Success Result	201 Created
Response Headers	Location — contains the URL to access the created record
Response Body	Not used

Operation

Create a new Feature Execution Scripts Config entry

Request Method

POST

Path

/featureexecutionscripts/executionpoints

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

FeatureExecutionScriptAssociation

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation	Retrieve a listing of Feature Execution Scripts Config entries
Request Method	GET
Path	/featureexecutionscripts/executionpoints
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	FeatureExecutionScriptAssociations

Operation

Retrieve a listing of Feature Execution Scripts Config entries

Request Method

GET

Path

/featureexecutionscripts/executionpoints

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

FeatureExecutionScriptAssociations

Operation	Retrieve an existing Feature Execution Scripts Config entry
Request Method	GET
Path	/featureexecutionscripts/executionpoints/{featureExecutionPointName}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use 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	FeatureExecutionScriptAssociation

Operation

Retrieve an existing Feature Execution Scripts Config entry

Request Method

GET

Path

/featureexecutionscripts/executionpoints/{featureExecutionPointName}

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use
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

FeatureExecutionScriptAssociation

Operation	Update an existing Feature Execution Scripts Config entry
Request Method	PUT
Path	/featureexecutionscripts/executionpoints/{featureExecutionPointName}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	FeatureExecutionScriptAssociation
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Update an existing Feature Execution Scripts Config entry

Request Method

PUT

Path

/featureexecutionscripts/executionpoints/{featureExecutionPointName}

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

FeatureExecutionScriptAssociation

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation	Delete an existing Feature Execution Scripts Config entry
Request Method	DELETE
Path	/featureexecutionscripts/executionpoints/{featureExecutionPointName}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	Not used
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Delete an existing Feature Execution Scripts Config entry

Request Method

DELETE

Path

/featureexecutionscripts/executionpoints/{featureExecutionPointName}

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

Not used

Success Result

204 No content

Response Headers

None

Response Body

Not used

/featureexecutionscripts/scripts

Operation	Retrieve a listing of feature execution scripts
Request Method	GET
Path	/featureexecutionscripts/scripts
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use 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	FeatureExecutionScripts

Operation

Retrieve a listing of feature execution scripts

Request Method

GET

Path

/featureexecutionscripts/scripts

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use
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

FeatureExecutionScripts

Operation	Create a new feature execution script
Request Method	POST
Path	/featureexecutionscripts/scripts
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	FeatureExecutionScript
Success Result	201 Created
Response Headers	Location — contains the URL to access the created record
Response Body	Not used

Operation

Create a new feature execution script

Request Method

POST

Path

/featureexecutionscripts/scripts

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

FeatureExecutionScript

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation	Retrieve an existing feature execution script
Request Method	GET
Path	/featureexecutionscripts/scripts/{scriptName}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	Not used
Success Result	200 OK
Response Headers	None
Response Body	FeatureExecutionScript

Operation

Retrieve an existing feature execution script

Request Method

GET

Path

/featureexecutionscripts/scripts/{scriptName}

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

FeatureExecutionScript

Operation	Update an existing feature execution script
Request Method	PUT
Path	/featureexecutionscripts/scripts/{scriptName}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	FeatureExecutionScript
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Update an existing feature execution script

Request Method

PUT

Path

/featureexecutionscripts/scripts/{scriptName}

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

FeatureExecutionScript

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation	Delete an existing feature execution script
Request Method	DELETE
Path	/featureexecutionscripts/scripts/{scriptName}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	Not used
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Delete an existing feature execution script

Request Method

DELETE

Path

/featureexecutionscripts/scripts/{scriptName}

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

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>

FeatureExecutionScriptAssociation

Class: com.opencloud.sentinel.provisioning.featurescript.FeatureExecutionScriptAssociation

JSON

{
  "type" : "object",
  "properties" : {
    "featureExecutionPointName" : {
      "type" : "string"
    },
    "featureExecutionScriptName" : {
      "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="featureExecutionScriptAssociation" type="FeatureExecutionScriptAssociationType"/>

  <xs:complexType name="FeatureExecutionScriptAssociationType">
    <xs:sequence>
      <xs:element name="featureExecutionPointName" type="xs:string" minOccurs="0"/>
      <xs:element name="featureExecutionScriptName" type="xs:string" nillable="true" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

FeatureExecutionScriptAssociations

Class: com.opencloud.sentinel.rest.server.resources.FeatureExecutionScriptAssociationResource$FeatureExecutionScriptAssociations

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="featureExecutionScriptAssociation" type="FeatureExecutionScriptAssociationsEntryType"/>

  <xs:element name="featureExecutionScriptAssociations" type="FeatureExecutionScriptAssociationsType"/>

  <xs:element name="link" type="LinkType"/>

  <xs:complexType name="FeatureExecutionScriptAssociationsType">
    <xs:sequence>
      <xs:element ref="featureExecutionScriptAssociation" 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="FeatureExecutionScriptAssociationsEntryType">
    <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>

FeatureExecutionScripts

Class: com.opencloud.sentinel.rest.common.FeatureExecutionScripts

JSON

{
  "type" : "object",
  "properties" : {
    "scripts" : {
      "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="featureExecutionScript" type="FeatureExecutionScriptsEntryType"/>

  <xs:element name="featureExecutionScripts" type="FeatureExecutionScriptsType"/>

  <xs:element name="link" type="LinkType"/>

  <xs:complexType name="FeatureExecutionScriptsType">
    <xs:sequence>
      <xs:element ref="featureExecutionScript" 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="FeatureExecutionScriptsEntryType">
    <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>

FeatureExecutionScript

Class: com.opencloud.sentinel.provisioning.featurescript.FeatureExecutionScript

JSON

{
  "type" : "object",
  "properties" : {
    "name" : {
      "type" : "string"
    },
    "src" : {
      "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="featureExecutionScript" type="FeatureExecutionScriptType"/>

  <xs:complexType name="FeatureExecutionScriptType">
    <xs:sequence>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="src" type="xs:string" nillable="true" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Previous page Next page