IRESTService Interface

REST service interface

Namespace: CMS.WebServices
Assembly: CMS.WebServices (in CMS.WebServices.dll) Version: 12.0.0

Syntax

public interface IRESTService

The IRESTService type exposes the following members.

Methods

	Name	Description
Public method	CreateCurrentSiteObject	Creates object of given type with given name and assigns it to current site.
Public method	CreateGlobalObject	Creates global object of given type.
Public method	CreateObject	Creates an object of given type specified by it's parameters.
Public method	CreateSiteObject	Creates object of given type with given name assigns it to specified site.
Public method	DeleteCurrentSiteObject	Deletes object of given type with given name from current site.
Public method	DeleteGlobalObject	Deletes global object of given type with given name.
Public method	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.
Public method	DeleteObjects	Deletes object of given type satisfying given parameters (WHERE/TOPN).
Public method	DeleteSiteObject	Deletes object of given type with given name from specified site.
Public method	GetAllObjects	Returns all objects of given object type.
Public method	GetBindings	Returns specific binding objects of an object of given type with specified ID.
Public method	GetBindingsObjectTypes	Returns list of binding object types of given object.
Public method	GetChildObjectTypes	Returns list of child object types of given object.
Public method	GetChildren	Returns specific child objects of an object of given type with specified ID.
Public method	GetCurrentSiteObject	Returns object of given type with given name from current site.
Public method	GetCurrentSiteObjects	Returns objects of given type from current site.
Public method	GetGlobalObject	Returns global object of given type with given name.
Public method	GetGlobalObjects	Returns global objects of given type.
Public method	GetHashForURL	Returns hash string which can be than used for given URL instead of authentication.
Public method	GetMacroResult	Returns the result of the macro expression.
Public method	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.
Public method	GetObjects	Returns objects of given type from current site.
Public method	GetServiceDocument	Exposes Service Document (available data).
Public method	GetSiteList	Exposes the list of all sites.
Public method	GetSiteObject	Returns object of given type with given name from specified site.
Public method	GetSiteObjects	Returns objects of given type from specified site.
Public method	SetToken	Validates user name and password and sets security token which will protect application against CSRF.
Public method	UpdateCurrentSiteObject	Updates object of given type with given name from current site.
Public method	UpdateGlobalObject	Updates global object of given type with given name.
Public method	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.
Public method	UpdateSiteObject	Updates object of given type with given name from specified site.