RESTService Members

Kentico 8.1 API Reference

The RESTService type exposes the following members.

Constructors

	Name	Description
	RESTService

Methods

	Name	Description
	CreateCurrentSiteObject	Creates an object of given type specified by it's parameters.
	CreateGlobalObject	Creates global object of given type.
	CreateObject	Creates an object of given type specified by it's parameters.
	CreateSiteObject	Creates an object of given type specified by it's parameters.
	DeleteCurrentSiteObject	Deletes object of given type with given name from current site.
	DeleteGlobalObject	Deletes global object of given type with given name.
	DeleteObject	Deletes object of given type with specified ID. If ID is not integer, than it's considered object name and object from current site with given name is returned.
	DeleteObjectInternal	Deletes given objects and returns it as a result. (Inherited from BaseRESTService.)
	DeleteObjects	Deletes object of given type satisfying given parameters (WHERE/TOPN).
	DeleteSiteObject	Deletes object of given type with given name from specified site.
	EnsureCorrectFormat(DataSet, String)	Ensures corrent serialization format of given DataSet. (Inherited from BaseRESTService.)
	EnsureCorrectFormat(DataTable, String)	Ensures corrent serialization format of given DataTable. (Inherited from BaseRESTService.)
	EnsureSensitiveColumns	Cleares sensitive column values if needed. (Inherited from BaseRESTService.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAllObjects	Returns all objects of given object type.
	GetBindings	Returns list of binding objects of given type.
	GetBindingsObjectTypes	Returns list of binding object types of given object.
	GetCurrentSiteObject	Returns object of given type with given name from current site.
	GetCurrentSiteObjects	Returns objects of given type from current site.
	GetExportSettings	Creates ExportObjectSettings object from query string parameters. (Inherited from BaseRESTService.)
	GetGlobalObject	Returns global object of given type with given name.
	GetGlobalObjects	Returns global objects of given type.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHashForURL(String)	Returns hash string which can be than used for given URL instead of authetication.
	GetHashForURL(String, String)	Returns hash string which can be than used for given URL instead of authetication.
	GetChildObjectTypes	Returns list of child object types of given object.
	GetChildren	Returns list of child objects of given type.
	GetMacroResult	Returns the result of the macro expression.
	GetObject	Returns object of given type with specified ID. If ID is not integer, than it's considered object name and object from current site with given name is returned.
	GetObjectByIDInternal(String, String)	Returns object of given type with specified ID. (Inherited from BaseRESTService.)
	GetObjectByIDInternal(String, String, Boolean)	Returns object of given type with specified ID. (Inherited from BaseRESTService.)
	GetObjectByNameInternal(String, String, String)	Returns object of given type with specified name from specified site. (Inherited from BaseRESTService.)
	GetObjectByNameInternal(String, String, String, Boolean)	Returns object of given type with specified name from specified site. (Inherited from BaseRESTService.)
	GetObjectDataSetFeed	Returns SyndicationFeed of object dataset. (Inherited from BaseRESTService.)
	GetObjects(String)	Returns list of objects of given type.
	GetObjects(String, ExportObjectSettings)	Returns list of objects of given type. (Inherited from BaseRESTService.)
	GetResponse	Returns response for modifying methods - ID and GUID of the modified object. (Inherited from BaseRESTService.)
	GetServiceDocument	Exposes Service Document (available data).
	GetSiteList	Exposes the list of all sites.
	GetSiteObject	Returns object of given type with given name from specified site.
	GetSiteObjects	Returns objects of given type from specified site.
	GetStream	Returns proper stream from given object. (Inherited from BaseRESTService.)
	GetTotalRecordsTable	Returns table containing one olumn and one row with total records number. (Inherited from BaseRESTService.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetTypeInfo	Returns TypeInfo of given object type.
	CheckQueryStringParameters	Checks WHERE, ORDER BY and COLUMNS query string parameters so non-admin users cannot use malitious code (= SQL injection protection). (Inherited from BaseRESTService.)
	IsAuthorizedForObject(BaseInfo, PermissionsEnum)	Returns true if current user is granted with specified permission to process operation on the given objecttype. (Inherited from BaseRESTService.)
	IsAuthorizedForObject(String, String, PermissionsEnum)	Returns true if current user is granted with specified permission to process operation on the given objecttype. (Inherited from BaseRESTService.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReturnForbiddenStatus	Sets the response status to Forbidden. (Inherited from BaseRESTService.)
	SetObjectInternal	Deletes given objects and returns it as a result. (Inherited from BaseRESTService.)
	SetToken	Validates user name and password and sets security token which will protect application against CSRF.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateCurrentSiteObject	Updates object of given type with given name from current site.
	UpdateGlobalObject	Updates global object of given type with given name.
	UpdateObject	Updates object of given type with specified ID. If ID is not integer, than it's considered object name and object from current site with given name is returned.
	UpdateSiteObject	Updates object of given type with given name from specified site.

Extension Methods

	Name	Description
	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
	AllowedObjectTypes	Gets the list of allowed object types separated by semicolon. Empty string means all object types are allowed. (Inherited from BaseRESTService.)
	AllowedSensitiveColumns	If true, global administrators will be able to work with sensitive columns (such as UserPassword) via REST service. Other users than global administrators cannot work with these columns regardless this setting value. (Inherited from BaseRESTService.)
	CurrentSite	Gets current site object recieved from the domain. (Inherited from BaseRESTService.)
	CurrentSiteName	Gets current site name (retrieved from domain accessed). (Inherited from BaseRESTService.)
	CurrentUser	Gets current user object recieved from auth cookie. (Inherited from BaseRESTService.)
	CurrentUserName	Gets current user name recieved from auth cookie. (Inherited from BaseRESTService.)
	DefaultEncoding	Returns default Encoding from settings. (Inherited from BaseRESTService.)