Click or drag to resize
DocumentRESTService Class
REST service to access and manage documents.
Inheritance Hierarchy
SystemObject
  CMS.WebServicesBaseRESTService
    CMS.DocumentWebServicesDocumentRESTService

Namespace: CMS.DocumentWebServices
Assembly: CMS.DocumentWebServices (in CMS.DocumentWebServices.dll) Version: 8.2.23
Syntax
C#
public class DocumentRESTService : BaseRESTService, 
	IDocumentRESTService

The DocumentRESTService type exposes the following members.

Constructors
  NameDescription
Public methodDocumentRESTService
Top
Methods
  NameDescription
Protected methodCombineDocTypes
Combines (intersection) requested and allowed document types to use in SelectDocuments methods.
Public methodCreateDocument
Creates new document.
Public methodDeleteDocument
Deletes given document.
Protected methodDeleteObjectInternal
Deletes given objects and returns it as a result.
(Inherited from BaseRESTService.)
Protected methodEnsureCorrectFormat(DataSet, String)
Ensures correct serialization format of given DataSet.
(Inherited from BaseRESTService.)
Protected methodEnsureCorrectFormat(DataTable, String)
Ensures correct serialization format of given DataTable.
(Inherited from BaseRESTService.)
Protected methodEnsureSensitiveColumns
Clears sensitive column values if needed.
(Inherited from BaseRESTService.)
Public methodGetDocument
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 methodGetExportSettings
Creates ExportObjectSettings object from query string parameters.
(Overrides BaseRESTServiceGetExportSettings(String).)
Protected methodGetObjectByIDInternal(String, String)
Returns object of given type with specified ID.
(Inherited from BaseRESTService.)
Protected methodGetObjectByIDInternal(String, String, Boolean)
Returns object of given type with specified ID.
(Inherited from BaseRESTService.)
Protected methodGetObjectByNameInternal(String, String, String)
Returns object of given type with specified name from specified site.
(Inherited from BaseRESTService.)
Protected methodGetObjectByNameInternal(String, String, String, Boolean)
Returns object of given type with specified name from specified site.
(Inherited from BaseRESTService.)
Protected methodGetObjectDataSetFeed
Returns SyndicationFeed of object dataset.
(Overrides BaseRESTServiceGetObjectDataSetFeed(DataSet, String, ExportObjectSettings).)
Protected methodGetObjects
Returns list of objects of given type.
(Inherited from BaseRESTService.)
Protected methodGetResponse(GeneralizedInfo, ExportObjectSettings)
Returns response for modifying methods - ID and GUID of the modified object.
(Inherited from BaseRESTService.)
Protected methodGetResponse(IEnumerableTreeNode, ExportObjectSettings)
Returns response for modifying methods - ID and GUID of the modified object.
Protected methodGetStream
Returns proper stream from given object.
(Overrides BaseRESTServiceGetStream(Object, String, ExportObjectSettings).)
Protected methodGetTotalRecordsTable
Returns table containing one column and one row with total records number.
(Inherited from BaseRESTService.)
Protected methodCheckQueryStringParameters
Checks WHERE, ORDER BY and COLUMNS query string parameters so non-admin users cannot use malicious code (= SQL injection protection).
(Inherited from BaseRESTService.)
Protected methodIsAuthorizedForDocumentType
Returns true if given document type is allowed in settings.
Protected methodIsAuthorizedForObject(BaseInfo, PermissionsEnum) Obsolete.
Returns true if current user is granted with specified permission to process operation on the given objecttype.
(Inherited from BaseRESTService.)
Protected methodIsAuthorizedForObject(String, String, PermissionsEnum)
Returns true if current user is granted with specified permission to process operation on the given objecttype.
(Inherited from BaseRESTService.)
Protected methodIsAuthorizedForObject(BaseInfo, PermissionsEnum, String)
Returns true if current user is granted with specified permission to process operation on the given objecttype.
(Inherited from BaseRESTService.)
Protected methodIsObjectTypeAllowed
Returns true if given object type is allowed to be accessible by the service.
(Inherited from BaseRESTService.)
Protected methodReturnForbiddenStatus
Sets the response status to Forbidden.
(Inherited from BaseRESTService.)
Protected methodReturnNotFoundStatus
Sets the response status to Not found.
(Inherited from BaseRESTService.)
Protected methodSetObjectInternal
Deletes given objects and returns it as a result.
(Inherited from BaseRESTService.)
Public methodTranslate
Gateway for submitting an XLIFF document.
Public methodUpdateDocument
Processes given document.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Public propertyAllowedDocumentTypes
Gets the list of allowed document types separated by semicolon. Empty string means all document types are allowed.
Public propertyAllowedObjectTypes
Gets the list of allowed object types separated by semicolon. Empty string means all object types are allowed.
(Inherited from BaseRESTService.)
Public propertyAllowedSensitiveColumns
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 propertyCurrentSite
Gets current site object received from the domain.
(Inherited from BaseRESTService.)
Protected propertyCurrentSiteName
Gets current site name (retrieved from domain accessed).
(Inherited from BaseRESTService.)
Protected propertyCurrentUser
Gets current user object received from auth cookie.
(Inherited from BaseRESTService.)
Protected propertyCurrentUserName
Gets current user name received from auth cookie.
(Inherited from BaseRESTService.)
Public propertyDefaultEncoding
Returns default Encoding from settings.
(Inherited from BaseRESTService.)
Top
See Also