BaseRESTService Class

Base REST service to provide basic access and management of CMS data

Inheritance Hierarchy

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

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

Syntax

public class BaseRESTService

The BaseRESTService type exposes the following members.

Constructors

	Name	Description
Public method	BaseRESTService

Methods

	Name	Description
Protected method	DeleteObjectInternal	Deletes given objects and returns it as a result.
Protected method	EnsureCorrectFormat(DataSet, String)	Ensures correct serialization format of given DataSet.
Protected method	EnsureCorrectFormat(DataTable, String)	Ensures correct serialization format of given DataTable.
Protected method	EnsureSensitiveColumns	Clears sensitive column values if needed.
Public method Static member	GetCurrentSite	Returns current site info according to domain in query string.
Public method Static member	GetCurrentSiteName	Returns current site name.
Public method Static member	GetCurrentUser	Returns current user.
Public method Static member	GetCurrentUserName	Returns current user.
Public method Static member	GetDefaultEncoding	Returns default encoding according to settings in Site Manager.
Protected method	GetExportSettings	Creates ExportObjectSettings object from query string parameters.
Protected method Static member	GetItemUri	Returns Item Uri according to pattern.
Protected method	GetObjectByIDInternal(String, String)	Returns object of given type with specified ID.
Protected method	GetObjectByIDInternal(String, String, Boolean)	Returns object of given type with specified ID.
Protected method	GetObjectByNameInternal(String, String, String)	Returns object of given type with specified name from specified site.
Protected method	GetObjectByNameInternal(String, String, String, Boolean)	Returns object of given type with specified name from specified site.
Protected method	GetObjectDataSetFeed	Returns SyndicationFeed of object dataset.
Protected method	GetObjects	Returns list of objects of given type.
Protected method Static member	GetObjectUri(String, ExportObjectSettings)	Returns Uri of given object type.
Protected method Static member	GetObjectUri(GeneralizedInfo, ExportObjectSettings)	Returns Uri of given object type.
Protected method Static member	GetQueryParam	Returns query string parameter.
Public method Static member	GetRequestedEncoding	Returns requested encoding or default encoding if none was specified.
Protected method	GetResponse	Returns response for modifying methods - ID and GUID of the modified object.
Protected method	GetStream	Returns proper stream from given object.
Protected method	GetTotalRecordsTable	Returns table containing one column and one row with total records number.
Protected method	CheckQueryStringParameters	Checks WHERE, ORDER BY and COLUMNS query string parameters so non-admin users cannot use malicious code (= SQL injection protection).
Protected method	IsAuthorizedForObject(BaseInfo, PermissionsEnum)	Obsolete. Returns true if current user is granted with specified permission to process operation on the given objecttype.
Protected method	IsAuthorizedForObject(String, String, PermissionsEnum)	Returns true if current user is granted with specified permission to process operation on the given objecttype.
Protected method	IsAuthorizedForObject(BaseInfo, PermissionsEnum, String)	Returns true if current user is granted with specified permission to process operation on the given objecttype.
Protected method	IsObjectTypeAllowed	Returns true if given object type is allowed to be accessible by the service.
Protected method	ReturnForbiddenStatus	Sets the response status to Forbidden.
Protected method	ReturnNotFoundStatus	Sets the response status to Not found.
Public method Static member	RewriteRESTUrl	Handles the rewriting for REST service.
Protected method Static member	SetFormat	Sets the format according to content-type and querystring parameter (higher priority).
Protected method	SetObjectInternal	Deletes given objects and returns it as a result.
Protected method Static member	ToODATA	Serializes given DataSet to ODATA.
Protected method Static member	WrapJSONP	Wraps JSON result to a JSONP callback method if specified.

Extension Methods

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

Properties

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