DocumentRESTService Class |
Namespace: CMS.DocumentWebServices
public class DocumentRESTService : BaseRESTService, IDocumentRESTService
The DocumentRESTService type exposes the following members.
Name | Description | |
---|---|---|
DocumentRESTService |
Name | Description | |
---|---|---|
AllowedDocumentTypes |
Gets the list of allowed document types separated by semicolon. Empty string means all document types are allowed.
| |
AllowedObjectTypes |
Gets the list of allowed object types separated by semicolon. Empty string means all object types are allowed.
(Inherited from BaseRESTService.) | |
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.) | |
CurrentSite |
Gets current site object received from the domain.
(Inherited from BaseRESTService.) | |
CurrentSiteName |
Gets current site name (retrieved from domain accessed).
(Inherited from BaseRESTService.) | |
CurrentUser |
Gets current user object received from auth cookie.
(Inherited from BaseRESTService.) | |
CurrentUserName |
Gets current user name received from auth cookie.
(Inherited from BaseRESTService.) | |
DefaultEncoding |
Returns default Encoding from settings.
(Inherited from BaseRESTService.) |
Name | Description | |
---|---|---|
CheckQueryStringParameters |
Checks WHERE, ORDER BY and COLUMNS query string parameters so non-admin users cannot use malicious code (= SQL injection protection).
(Inherited from BaseRESTService.) | |
CombineDocTypes |
Combines (intersection) requested and allowed document types to use in selecting documents methods.
| |
CreateDocument |
Creates new document.
| |
DeleteDocument |
Deletes given document.
| |
DeleteObjectInternal |
Deletes given objects and returns it as a result.
(Inherited from BaseRESTService.) | |
EnsureCorrectFormat(DataSet, String) |
Ensures correct serialization format of given DataSet.
(Inherited from BaseRESTService.) | |
EnsureCorrectFormat(DataTable, String) |
Ensures correct serialization format of given DataTable.
(Inherited from BaseRESTService.) | |
EnsureSensitiveColumns |
Clears sensitive column values if needed.
(Inherited from BaseRESTService.) | |
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.
| |
GetDocumentExportSettings |
Creates ExportObjectSettings object from query string parameters.
| |
GetExportSettings |
Creates ExportObjectSettings object from query string parameters.
(Inherited from BaseRESTService.) | |
GetObjectByIDInternal(String, String) |
Returns object of given type with specified ID.
(Inherited from BaseRESTService.) | |
GetObjectByIDInternal(String, String, Boolean) |
Returns object of given type with specified ID.
(Inherited from BaseRESTService.) | |
GetObjectByNameInternal(String, String, String) |
Returns object of given type with specified name from specified site.
(Inherited from BaseRESTService.) | |
GetObjectByNameInternal(String, String, String, Boolean) |
Returns object of given type with specified name from specified site.
(Inherited from BaseRESTService.) | |
GetObjectDataSetFeed |
Returns SyndicationFeed of object dataset.
(Overrides BaseRESTServiceGetObjectDataSetFeed(DataSet, String, TraverseObjectSettings).) | |
GetObjects |
Returns list of objects of given type.
(Inherited from BaseRESTService.) | |
GetResponse(GeneralizedInfo, TraverseObjectSettings) |
Returns response for modifying methods - ID and GUID of the modified object.
(Inherited from BaseRESTService.) | |
GetResponse(IEnumerableTreeNode, TraverseObjectSettings) |
Returns response for modifying methods - ID and GUID of the modified object.
| |
GetStream |
Returns proper stream from given object.
(Overrides BaseRESTServiceGetStream(Object, String, TraverseObjectSettings).) | |
GetTotalRecordsTable |
Returns table containing one column and one row with total records number.
(Inherited from BaseRESTService.) | |
IsAuthorizedForDocumentType |
Returns true if given document type is allowed in settings.
| |
IsAuthorizedForObject(String, String, PermissionsEnum) |
Returns true if current user is granted with specified permission to process operation on the given objecttype.
(Inherited from BaseRESTService.) | |
IsAuthorizedForObject(BaseInfo, PermissionsEnum, String) |
Returns true if current user is granted with specified permission to process operation on the given objecttype.
(Inherited from BaseRESTService.) | |
IsObjectTypeAllowed |
Returns true if given object type is allowed to be accessible by the service.
(Inherited from BaseRESTService.) | |
ReturnForbiddenStatus |
Sets the response status to Forbidden.
(Inherited from BaseRESTService.) | |
ReturnNotFoundStatus |
Sets the response status to Not found.
(Inherited from BaseRESTService.) | |
ReturnSiteNotFoundStatus |
Sets the response status to Not found with a comment that the site does not exist.
(Inherited from BaseRESTService.) | |
SetObjectInternal |
Deletes given objects and returns it as a result.
(Inherited from BaseRESTService.) | |
Translate |
Gateway for submitting an XLIFF document.
| |
UpdateDocument |
Processes given document.
|