App Framework Reference

Model API

class SplunkAppObjModel

The SplunkAppObjModel class provides a model wrapper around both REST resources and metadata attached to those resources, including access control, sharing, ownership, and mutability.

Note: New models should almost always be derived from this class, except when it is necessary to use the SplunkRESTManager class.

Language Binding

Python

Inheritance

object -> SplunkRESTModel -> SplunkAppObjModel

Implementation Location

$SPLUNK_HOME\etc\apps\<appName>\appserver\controllers

Constructor

Methods

create() Creates a new version of the current object.
from_entity() Populates the current model with the specified entity.
share_app() Sets the sharing level to app .
share_global() Sets the sharing level to global .
unshare() Sets the sharing level to user .

See Also

class ObjectMetadataModel
class SplunkQuerySet
class SplunkRESTManager
class SplunkRESTModel