Click or drag to resize
ObjectTranslationRESTService Class
REST service to access and manage translations of objects.
Inheritance Hierarchy

Namespace: CMS.DocumentWebServices
Assembly: CMS.DocumentWebServices (in CMS.DocumentWebServices.dll) Version: 12.0.0
Syntax
C#
public class ObjectTranslationRESTService : RESTService

The ObjectTranslationRESTService type exposes the following members.

Constructors
  NameDescription
Public methodObjectTranslationRESTService
Top
Properties
  NameDescription
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
Methods
  NameDescription
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.)
Public methodCreateCurrentSiteObject
Creates an object of given type specified by it's parameters.
(Inherited from RESTService.)
Public methodCreateGlobalObject
Creates global object of given type.
(Inherited from RESTService.)
Public methodCreateObject
Creates an object of given type specified by it's parameters.
(Inherited from RESTService.)
Public methodCreateSiteObject
Creates an object of given type specified by it's parameters.
(Inherited from RESTService.)
Public methodDeleteCurrentSiteObject
Deletes object of given type with given name from current site.
(Inherited from RESTService.)
Public methodDeleteGlobalObject
Deletes global object of given type with given name.
(Inherited from RESTService.)
Public methodDeleteObject
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.
(Inherited from RESTService.)
Protected methodDeleteObjectInternal
Deletes given objects and returns it as a result.
(Inherited from BaseRESTService.)
Public methodDeleteObjects
Deletes object of given type satisfying given parameters (WHERE/TOPN).
(Inherited from RESTService.)
Public methodDeleteSiteObject
Deletes object of given type with given name from specified site.
(Inherited from RESTService.)
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 methodGetAllObjects
Returns all objects of given object type.
(Inherited from RESTService.)
Public methodGetBindings
Returns list of binding objects of given type.
(Inherited from RESTService.)
Public methodGetBindingsObjectTypes
Returns list of binding object types of given object.
(Inherited from RESTService.)
Public methodGetChildObjectTypes
Returns list of child object types of given object.
(Inherited from RESTService.)
Public methodGetChildren
Returns list of child objects of given type.
(Inherited from RESTService.)
Public methodGetCurrentSiteObject
Returns object of given type with given name from current site.
(Inherited from RESTService.)
Public methodGetCurrentSiteObjects
Returns objects of given type from current site.
(Inherited from RESTService.)
Protected methodGetExportSettings
Creates ExportObjectSettings object from query string parameters.
(Overrides BaseRESTServiceGetExportSettings(String).)
Public methodGetGlobalObject
Returns global object of given type with given name.
(Inherited from RESTService.)
Public methodGetGlobalObjects
Returns global objects of given type.
(Inherited from RESTService.)
Public methodGetHashForURL
Returns hash string which can be than used for given URL instead of authentication.
(Inherited from RESTService.)
Public methodGetMacroResult
Returns the result of the macro expression.
(Inherited from RESTService.)
Public methodGetObject
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.
(Inherited from RESTService.)
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.
(Inherited from BaseRESTService.)
Public methodGetObjects(String)
Returns list of objects of given type.
(Inherited from RESTService.)
Protected methodGetObjects(String, TraverseObjectSettings)
Returns list of objects of given type.
(Inherited from BaseRESTService.)
Protected methodGetResponse
Returns response for modifying methods - ID and GUID of the modified object.
(Inherited from BaseRESTService.)
Public methodGetServiceDocument
Exposes Service Document (available data).
(Inherited from RESTService.)
Public methodGetSiteList
Exposes the list of all sites.
(Inherited from RESTService.)
Public methodGetSiteObject
Returns object of given type with given name from specified site.
(Inherited from RESTService.)
Public methodGetSiteObjects
Returns objects of given type from specified site.
(Inherited from RESTService.)
Protected methodGetStream
Returns proper stream from given object.
(Overrides BaseRESTServiceGetStream(Object, String, TraverseObjectSettings).)
Protected methodGetTotalRecordsTable
Returns table containing one column and one row with total records number.
(Inherited from BaseRESTService.)
Public methodStatic memberGetTranslation
Returns XLIFF translation of the given object.
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 methodReturnSiteNotFoundStatus
Sets the response status to Not found with a comment that the site does not exist.
(Inherited from BaseRESTService.)
Protected methodSetObjectInternal
Deletes given objects and returns it as a result.
(Inherited from BaseRESTService.)
Public methodSetToken
Validates user name and password and sets security token which will protect application against CSRF.
(Inherited from RESTService.)
Public methodUpdateCurrentSiteObject
Updates object of given type with given name from current site.
(Inherited from RESTService.)
Public methodUpdateGlobalObject
Updates global object of given type with given name.
(Inherited from RESTService.)
Public methodUpdateObject
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.
(Inherited from RESTService.)
Public methodUpdateSiteObject
Updates object of given type with given name from specified site.
(Inherited from RESTService.)
Top
See Also