wfm.SetSubstitutes

This job sets substitutes for multiple users or roles.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization

Substitutes

BASE64

Yes

User-substitute assignments in XML format (see below)

2. Return Value

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

3. Example

Structure of Substitutes:

<Substitutes>
  <Substitute Id="12345678901234567890123456789010">
    <SubstituteIds>789012345678901A,123456778901B</SubstituteIds>
  </Substitute>
  <Substitute Id="12345678901234567890123456789011">
    <SubstituteIds>123456789012345,123452345678901C</SubstituteIds>
  </Substitute>
</Substitutes>

4. Note

Substitute structure with all substitute assignments for a specific user:

  • Id (STRING): Object ID of the user/role

  • SubstituteIds (STRING): comma-separated list of object IDs of all substitutes for the user/role; can be empty

5. See Also

wfm.GetOrganisations, wfm.GetOrganisationObjects, wfm.GetSubstitutes