wfm.GetOrganisations

This job returns all defined organizations and indicates which organization is activated. Only one organization can be activated at a time via the enaio® editor-for-workflow.

1. Input Parameters

This job does not expect any input parameters.

2. Output Parameters

Name Type Dependency Description

Organisations

BASE64

—

Information about all available organizations in XML format (see Structure of Organisations). The value is transmitted BASE64-encoded by the server; after decoding, the content is UTF-8-encoded XML.

3. Return Value

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

4. Structure of Organisations

<Organisations>
  <Organisation Id="1" Name="Standard" Active="1"/>
  <Organisation Id="2" Name="Archiv" Active="0"/>
</Organisations>

4.1. Attributes of Organisation

Attribute Type Description

Id

STRING

Unique ID of the organization. Used as an input parameter for other wfm.* jobs, e.g. OrganisationId in wfm.GetAbsentUsers or wfm.GetOrganisationClasses.

Name

STRING

Display name of the organization, as configured in the enaio® editor-for-workflow.

Active

INT

Indicates whether the organization is active (1) or not (0). It is guaranteed server-side that exactly one organization carries the value 1.

5. Notes

  • Exactly one organization is always active. This invariant is enforced server-side by the enaio® editor-for-workflow.

  • If the workflow engine (wfm) is not licensed or not loaded, the job fails with an error code — no empty list is returned.

6. See Also