DocumentRESTService Class

REST service to access and manage documents.

Inheritance Hierarchy

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

Namespace: CMS.DocumentWebServices
Assembly: CMS.DocumentWebServices (in CMS.DocumentWebServices.dll) Version: 10.0.0

Syntax

public class DocumentRESTService : BaseRESTService, 
	IDocumentRESTService

The DocumentRESTService type exposes the following members.

Constructors

	Name	Description
Public method	DocumentRESTService

Properties

	Name	Description
Public property	AllowedDocumentTypes	Gets the list of allowed document types separated by semicolon. Empty string means all document types are allowed.
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	CombineDocTypes	Combines (intersection) requested and allowed document types to use in selecting documents methods.
Public method	CreateDocument	Creates new document.
Public method	DeleteDocument	Deletes given document.
Protected method	DeleteObjectInternal	Deletes given objects and returns it as a result. (Inherited from BaseRESTService.)
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	GetDocument	Selects tree node(s) according to provided parameters and returns them as dataset. Three oprations are supported: document (= select single document), all (= select documents), childrenof (= all children of given node). If classNames not specified, the result does not contain coupled data.
Protected method	GetDocumentExportSettings	Creates ExportObjectSettings object from query string parameters.
Protected method	GetExportSettings	Creates ExportObjectSettings object from query string parameters. (Inherited from BaseRESTService.)
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. (Overrides BaseRESTService.GetObjectDataSetFeed(DataSet, String, TraverseObjectSettings).)
Protected method	GetObjects	Returns list of objects of given type. (Inherited from BaseRESTService.)
Protected method	GetResponse(GeneralizedInfo, TraverseObjectSettings)	Returns response for modifying methods - ID and GUID of the modified object. (Inherited from BaseRESTService.)
Protected method	GetResponse(IEnumerable<TreeNode>, TraverseObjectSettings)	Returns response for modifying methods - ID and GUID of the modified object.
Protected method	GetStream	Returns proper stream from given object. (Overrides BaseRESTService.GetStream(Object, String, TraverseObjectSettings).)
Protected method	GetTotalRecordsTable	Returns table containing one column and one row with total records number. (Inherited from BaseRESTService.)
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.)
Protected method	IsAuthorizedForDocumentType	Returns true if given document type is allowed in settings.
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	Translate	Gateway for submitting an XLIFF document.
Public method	UpdateDocument	Processes given document.