Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetObjectsList

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetObjectsList

 

Gets a list of a specified object from the server.

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetObjectsList

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ LoadItemsList

 

mandatory nillable

The list of objects to load from the Thereforeâ„¢ with settings like permissions or additional flags

≡ WSGetObjectsParams

 

list nillable


â–  Flags

 

mandatory

restriction enum (xs:string)

- GetNoFolders (1)

- GetAllFolders (2)

Specifies if a folder should be part of the retrieved items or not.

â–  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)

- RetentionPolicy (26)

- Count (27)

- UniversalConnectorProfile (29)

- CaseDefinition (37)

- Case (38)

- Stamp (40)

- 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

nillable

Sets the access mask of the permissions. See also: operation GetRolePermissionConstants.

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetObjectsListResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ AllItemsList

 

nillable

The list of objects and folders loaded from the Thereforeâ„¢

≡ WSGetObjectsResponse

 

list nillable


â–¡ FolderList

 

nillable

Contains the list of all folders for the specified object type.

≡ WSFolder

 

list nillable


â–  FolderNo

xs:int

mandatory

Gets the folder number.

â–  Foldertype

xs:int

 

Gets the type of the folder.

â–  Guid

xs:string

 

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

nillable

Gets the name of the folder.

â–  ParentFolderNo

xs:int

mandatory

Gets the number of the parent folder.

â–¡ ItemList

 

nillable

Contains the list of retrieved objects from the server.

≡ WSFolderItem

 

list nillable


â–  Data

xs:int

 

Gets additional context sensitive meta data of the item.

â–  Flags

xs:int

 

Gets flags of the item.

â–  FolderNo

xs:int

mandatory

Gets the folder number of the folder containing the item.

â–  Guid

xs:string

 

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.

â–  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)

- RetentionPolicy (26)

- Count (27)

- UniversalConnectorProfile (29)

- CaseDefinition (37)

- Case (38)

- Stamp (40)

- 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.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.