Therefore Web API Programming Interface 1.0

Element Name

Element Type

Restrictions

Description

â–  parameters

â–  ObjectNo

xs:int

mandatory

Sets the identifier for the object (e.g. for documents this is the document number, for a category this is the category number).

â–  ObjectType

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.

â–  SubObjNo

xs:int

Sets the sub object number of the object. This is used for categories only.

â–¡ UserId

xs:int

nillable

Sets id of the user. If the UserId is set the following parameters are ignored: UserName, UserType, Domain.

â–¡ UserName

xs:string

nillable

Sets name of the user OR Sets user query string specifying conditions for the desired user (if Domain parameter is set). The UserName is ignored if the UserId parameter is set.

â–¡ UserType

nillable

restriction enum (xs:string)

- FindUsersInActiveDirectory (1)

- FindUsersInTherefore (4)

- FindAllUsers (5)

- FindUsersNotInTherefore (32)

- FindGroupsInActiveDirectory (64)

- FindGroupsInTherefore (256)

- FindAllGroups (320)

- FindAllUsersAndGroups (325)

- FindGroupsNotInTherefore (1024)

- FindSMTPUsersOnly (4096)

Sets type of the user. The UserType is ignored if the UserId parameter is set. Default is FindUsersInActiveDirectory.

â–¡ Domain

xs:string

nillable

Sets name of domain to search in. The Domain is ignored if the UserId parameter is set.

â–¡ DenyAll

xs:boolean

nillable

Set to True to deny all the available permissions. If this parameter is set to True the PermissionsToSet and the AllowAll parameters are ignored. Entries with inherited allow or deny permissions are skipped.

â–¡ AllowAll

xs:boolean

nillable

Set to True to allow all the available permissions. If this parameter is set to True the PermissionsToSet parameter is ignored. Entries with inherited allow or deny permissions are skipped. The AllowAll is ignored if the DenyAll is set.

â–¡ PermissionsToSet

nillable

Sets permissions to be allowed/denied for the given user on the given object. All the other permissions (which are not in the list) remain unchanged. All the items in the PermissionsToSet are ignored if the DenyAll (or AllowAll) parameter is set.

≡ WSPermissionToSet

list nillable

â–  Allowed

xs:boolean

Sets the allowed permission.

â–  Denied

xs:boolean

Sets the denied permission.

â–  Value

xs:unsignedLong

Sets permission integer code (permission type). To get the list of codes use the GetPermissionConstants WebAPI operation.

Element Name

Element Type

Restrictions

Description

â–  parameters

â–¡ Permissions

mandatory nillable

Gets actual permissions (the latest state).

≡ WSPermission

list nillable

â–  Allowed

xs:boolean

Gets whether permission is allowed.

â–  Denied

xs:boolean

Gets whether permission is denied.

â–  InheritAllowed

xs:boolean

Gets information indicating if the Allow permission is inherited.

â–  InheritDenied

xs:boolean

Gets information indicating if the Deny permission is inherited.

â–¡ Name

xs:string

nillable

Gets the localized name of the permission.

â–  Value

xs:unsignedLong

Get permission integer code. To get the list of codes use the GetPermissionConstants WebAPI operation.

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.