wfm.GetSubstitutes

This job determines substitutes for any number of users and roles.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization

UserIds

STRING

Yes

Comma-separated list of IDs of users/roles for whom substitute information is requested

2. Output Parameters

Name Type Dependency Description

Substitutes

BASE64

—

Requested substitute information in XML format (see below)

3. Return Value

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

4. Example

Structure of Substitutes:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Substitutes>
  <Object Id="BB4FF62D3FE24DD790DE342585917A36">
    <Substitute Id="8CD236F862644DAD904CD8C228EF4F23" Name="LEHMANN" Absent="1"
                UserGUID="4FEEDE694EB94E7E9C4A847FC32D10E4" Login="Lehmann"/>
  </Object>
</Substitutes>

Description of the XML structure:

  • Object: object ID of the user

    • Id (STRING): object ID of the user

  • Substitute: all substitute assignments for a specific user/role

    • Id (STRING): object ID of the substitute for user/role

    • Name (STRING): login name of the substitute

    • Absent (INT): 1 = user is absent, 0 = otherwise

    • UserGUID (STRING): GUID of the user from the user table

    • Login (STRING): login of the user from the user table

5. See Also

wfm.GetOrganisations, wfm.GetOrganisationObjects, wfm.SetSubstitutes