|
GetObjects |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetObjects
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetObjects
Gets a list of a specified object from the server.
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetObjects
Element Name |
Element Type |
Restrictions |
Description |
β parameters |
|
|
|
β Flags |
|
mandatory restriction enum (xs:string) - GetNoFolders (1) - GetAllFolders (2) |
Specifies if a folder should be part of the retrieved items or not. |
β PermType |
|
optional restriction flag (xs:string) β IgnorePermissions (0) β OperatorPermission (1) β AdminPermission (2) β SetPermPermission (4) β AccessPermission (8) β TheSystemConnectPermission (16) β TheSystemWritePermission (32) β CategoryArchivePermission (64) β QueryAdminPermission (128) β QueryExecutePermission (256) β QueryCtgrytabsPermission (512) β KeywordDictionaryChangePermission (1024) β QueryTemplatesReadPermission (2048) β DocViewinHitListPermission (4096) β DocViewDocPermission (8192) β DocPrintPermission (16384) β DocExportSendPermission (32768) β DocViewAnnotationPermission (65536) β DocHideAnnotationPermission (131072) β DocViewHistoryPermission (262144) β WfParticipatePermission (262144) β DocAddAnnotationsPermission (524288) β WfAddDocPermission (524288) β DocDeleteAnnotationsPermission (1048576) β WfViewHistoryPermission (1048576) β DocEditPermission (2097152) β WfDelegatePermission (2097152) β DocUpdateIndexDataPermission (4194304) β WfViewAllPermission (4194304) β DocAddPagePermission (8388608) β WfDeletePermission (8388608) β DocDeletePagePermission (16777216) β DocDeleteDocPermission (33554432) β CategoryFieldReadPermission (268435456) β CategoryFieldSetPermission (536870912) β CategoryFieldChangePermission (1073741824) |
DEPRECATED: Use the RoleAccessMask parameter instead. Sets filter on permissions the connected user has. Default value is 'IgnorePermissions'. |
β Type |
|
mandatory restriction enum (xs:string) - Unknown (-1) - Server (1) - Document (2) - Category (3) - Field (4) - DataType (5) - MediaPool (6) - Media (7) - IndexingProfile (8) - SpoolType (9) - Query (10) - User (11) - Group (12) - CaptureProfile (13) - PreProcessor (14) - COLDForm (15) - QueryTemplate (16) - Folder (17) - LoaderProfile (18) - WorkflowProcess (19) - WorkflowTask (20) - WorkflowInstance (21) - KeyDict (22) - StoragePolicy (23) - Device (24) - StorageArea (25) - Count (26) - CaseDefinition (37) - Case (38) - ReportDefinition (41) - eForm (47) - eFormSubmission (48) - FormImage (99) - Keyword (100) - Migrate (101) - Connectors (900) - StorageCtgry (901) - ServerMediaPools (902) - StorageAreaMedia (903) - ServerDevices (904) - ServerMedia (905) - TheSystem (1000) - COLD (1001) - ExchangeConnector (1002) - LotusConnector (1003) - SAPConnector (1004) |
Sets the type of the object. |
β‘ RoleAccessMask |
xs:unsignedLong |
optional nillable |
Sets the access mask of the permissions. See also: operation GetRolePermissionConstants. If not set the PermType parameter is used (or its default value). |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetObjectsResponse
Element Name |
Element Type |
Restrictions |
Description |
β parameters |
|
|
|
β‘ FolderList |
|
optional nillable |
Contains the list of all folders for the specified object type. |
β‘ WSFolder |
|
optional unbounded nillable |
|
β FolderNo |
xs:int |
mandatory |
Gets the folder number. |
β Foldertype |
xs:int |
optional |
Gets the type of the folder. |
β Guid |
xs:string |
optional GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} |
Gets the GUID of the folder. |
β‘ Name |
xs:string |
optional nillable |
Gets the name of the folder. |
β ParentFolderNo |
xs:int |
mandatory |
Gets the number of the parent folder. |
β‘ ItemList |
|
optional nillable |
Contains the list of retrieved objects from the server. |
β‘ WSFolderItem |
|
optional unbounded nillable |
|
β Data |
xs:int |
optional |
Gets additional context sensitive meta data of the item. |
β Flags |
xs:int |
optional |
Gets flags of the item. |
β FolderNo |
xs:int |
mandatory |
Gets the folder number of the folder containing the item. |
β Guid |
xs:string |
optional GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} |
Gets the unique GUID of the item. |
β ID |
xs:int |
mandatory |
Gets the unique ID of the item. |
β‘ Name |
xs:string |
mandatory nillable |
Gets the name of the folder item. |
Legend:
β |
Not nillable element. |
β‘ |
Nillable element. |
β‘ |
Unbounded element (List of elements). |
Normal |
Optional element. |
Bold |
Mandatory element. |
