wfm.AdhocGetTemplateList

Returns one or more ad hoc templates for the specified user.

1. Input Parameters

Name Type Required Description

UserId

STRING

Yes

ID of the user

OrgId

STRING

Yes

ID of the organization

[TemplateId]

STRING

No

ID of the template. If this parameter is empty, all ad hoc templates visible to the user are determined (all public templates and the user’s privatized templates).

2. Output Parameters

Name Type Dependency Description

Templates

BASE64

—

List of determined ad hoc templates in XML format (see note)

3. Return Value

(INT): 0 = Job successful, otherwise error code.

4. Note

Each template in Templates has the following structure:

  • Template: Describes an ad hoc template

    • TemplateId (STRING): ID of the ad hoc template

    • TemplateName (STRING): Name of the ad hoc template

    • Public (INT): 0 = template is not public, 1 = template is public

    • RoutingList: Routing list (structure as in wfm.AdhocConfigTemplate)

Detailed description of RoutingList and its sub-elements:

  • RoutingList: Routing list with the following structure (or subsets thereof)

    • Id (STRING): ID of the routing list. This value is set by the server and must not be changed.

    • ActivityId (STRING): Activity ID

    • Expandable (INT): 0 = routing list cannot be expanded, 1 = routing list can be expanded

  • Entries: Groups entries of the routing list. An entry consists of multiple elements that can be executed in parallel.

  • Entry: Describes an entry in the routing list.

    • Nr (INT): Used for relative sorting of entries within the routing list. Absolute values have no meaning for the client.

    • Expandable (INT): 0 = entry cannot be expanded, 1 = entry can be expanded

  • Item: Describes an item in the routing list (activity, performer and optionally deadline).

    • Id (STRING): Used for identification. Must not be changed and must be sent identically in all jobs. If an item is created by the client, this must specify an ID here.

    • ActivityId (STRING): ID of the activity in the workflow model

    • ActivityName (STRING): Name of the activity (need not match the name in the workflow model)

    • ActivityModelName (STRING): Name of the activity in the workflow model

    • TimerId (STRING): ID of a reminder period

    • TimerName (STRING): Name of the reminder period

    • TimerDuration (INT): Duration of the period

    • TimerDurationType (INT): 0 = no period, 1 = relative, 2 = absolute

    • Changeable (INT): 0 = no changes possible, 1 = item can be modified by the client

    • Deleteable (INT): 0 = deletion not allowed, 1 = item can be deleted

    • Remark (STRING): Note for processing (text)

    • ObjectIds (STRING): List of GUIDs of performers (roles or persons), separated by commas