RESTService Class

REST service to access and manage CMS data

Inheritance Hierarchy

System.Object
  CMS.WebServices.BaseRESTService
    CMS.WebServices.RESTService
      CMS.DocumentWebServices.ObjectTranslationRESTService

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

Syntax

public class RESTService : BaseRESTService, 
	IRESTService

The RESTService type exposes the following members.

Constructors

	Name	Description
Public method	RESTService

Properties

	Name	Description
Public property	AllowedObjectTypes	Gets the list of allowed object types separated by semicolon. Empty string means all object types are allowed. (Inherited from BaseRESTService.)
Public property	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.)
Protected property	CurrentSite	Gets current site object received from the domain. (Inherited from BaseRESTService.)
Protected property	CurrentSiteName	Gets current site name (retrieved from domain accessed). (Inherited from BaseRESTService.)
Protected property	CurrentUser	Gets current user object received from auth cookie. (Inherited from BaseRESTService.)
Protected property	CurrentUserName	Gets current user name received from auth cookie. (Inherited from BaseRESTService.)
Public property	DefaultEncoding	Returns default Encoding from settings. (Inherited from BaseRESTService.)

Methods

	Name	Description
Protected method	CheckQueryStringParameters	Checks WHERE, ORDER BY and COLUMNS query string parameters so non-admin users cannot use malicious code (= SQL injection protection). (Inherited from BaseRESTService.)
Public method	CreateCurrentSiteObject	Creates an object of given type specified by it's parameters.
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 an object of given type specified by it's parameters.
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.
Protected method	DeleteObjectInternal	Deletes given objects and returns it as a result. (Inherited from BaseRESTService.)
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.
Protected method	EnsureCorrectFormat(DataSet, String)	Ensures correct serialization format of given DataSet. (Inherited from BaseRESTService.)
Protected method	EnsureCorrectFormat(DataTable, String)	Ensures correct serialization format of given DataTable. (Inherited from BaseRESTService.)
Protected method	EnsureSensitiveColumns	Clears sensitive column values if needed. (Inherited from BaseRESTService.)
Public method	GetAllObjects	Returns all objects of given object type.
Public method	GetBindings	Returns list of binding objects of given type.
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 list of child objects of given type.
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.
Protected method	GetExportSettings	Creates ExportObjectSettings object from query string parameters. (Inherited from BaseRESTService.)
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.
Protected method	GetObjectByIDInternal(String, String)	Returns object of given type with specified ID. (Inherited from BaseRESTService.)
Protected method	GetObjectByIDInternal(String, String, Boolean)	Returns object of given type with specified ID. (Inherited from BaseRESTService.)
Protected method	GetObjectByNameInternal(String, String, String)	Returns object of given type with specified name from specified site. (Inherited from BaseRESTService.)
Protected method	GetObjectByNameInternal(String, String, String, Boolean)	Returns object of given type with specified name from specified site. (Inherited from BaseRESTService.)
Protected method	GetObjectDataSetFeed	Returns SyndicationFeed of object dataset. (Inherited from BaseRESTService.)
Public method	GetObjects(String)	Returns list of objects of given type.
Protected method	GetObjects(String, TraverseObjectSettings)	Returns list of objects of given type. (Inherited from BaseRESTService.)
Protected method	GetResponse	Returns response for modifying methods - ID and GUID of the modified object. (Inherited from BaseRESTService.)
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.
Protected method	GetStream	Returns proper stream from given object. (Inherited from BaseRESTService.)
Protected method	GetTotalRecordsTable	Returns table containing one column and one row with total records number. (Inherited from BaseRESTService.)
Protected method	IsAuthorizedForObject(String, String, PermissionsEnum)	Returns true if current user is granted with specified permission to process operation on the given objecttype. (Inherited from BaseRESTService.)
Protected method	IsAuthorizedForObject(BaseInfo, PermissionsEnum, String)	Returns true if current user is granted with specified permission to process operation on the given objecttype. (Inherited from BaseRESTService.)
Protected method	IsObjectTypeAllowed	Returns true if given object type is allowed to be accessible by the service. (Inherited from BaseRESTService.)
Protected method	ReturnForbiddenStatus	Sets the response status to Forbidden. (Inherited from BaseRESTService.)
Protected method	ReturnNotFoundStatus	Sets the response status to Not found. (Inherited from BaseRESTService.)
Protected method	ReturnSiteNotFoundStatus	Sets the response status to Not found with a comment that the site does not exist. (Inherited from BaseRESTService.)
Protected method	SetObjectInternal	Deletes given objects and returns it as a result. (Inherited from BaseRESTService.)
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.