wfm.GetUserSubstitutes

This job returns all users that the requesting user represents.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization

UserId

STRING

Yes

ID of the user for whom the information is requested

2. Output Parameters

Name Type Dependency Description

Objects

BASE64

Requested information in XML format (see below)

3. Return Value

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

4. Example

Structure of Objects:

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

5. Note

Detailed description of Objects:

  • Object — contains all users to be represented:

    • Id (STRING): object ID of the user

  • Substitute — describes a substitute:

    • 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