wfm.GetOrganisationClasses

This job returns information about the classes of an organization.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization

RequestType

INT

Yes

Flag specifying the request — the following parameters must be set accordingly:
0 = search for all classes
1 = search by IDs in parameter ClassIds
2 = search by names in parameter ClassName

ClassIds

STRING

Yes

Comma-separated list of class IDs (relevant when RequestType = 1)

ClassName

STRING

Yes

Class name (relevant when RequestType = 2)

AttributeId

STRING

Yes

Currently not supported — pass 0.

RequestData

INT

Yes

Specifies the results of the request:
1 = only index data of the classes determine (object ID, name, class ID)
3 = index data and class attributes determine
5 = index data and class relationships determine
7 = index data, class attributes and class relationships determine

2. Output Parameters

Name Type Dependency Description

Classes

BASE64

—

Information about the requested classes in XML format (see below)

3. Return Value

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

4. Example

Structure of Classes:

<Classes>
  <Class Id="10B9A20E90244BB9B701354C1AB84F8A" Name="Department">
    <Attributes/>
    <ParentObjects>
      <ParentObject Id="894CB679F2ED480A89107BF33A1F" Name="Organization"/>
    </ParentObjects>
    <ChildClasses>
      <ChildClass Id="12AA95D1D8244E6BB56C70A8D5CEE675" Name="Role"/>
    </ChildClasses>
  </Class>
  <Class Id="9AB24246BB9040A29FCD6015CF4F4BD9" Name="Person">
    <Attributes>
      <Attribute Id="33D4AB4B39" Name="Last Name" AttributeClassId="07F405D">
        <AttributeValue><![CDATA[]]></AttributeValue>
      </Attribute>
    </Attributes>
    <ParentObjects>
      <ParentObject Id="12AA95D1D8244E6BB56C70A8D5CEE675" Name="Role"/>
    </ParentObjects>
    <ChildClasses/>
  </Class>
</Classes>

Description of the XML structure:

  • Class: Information about an organization class

    • Id (STRING): ID of the class

    • Name (STRING): Name of the class

  • Attribute: Information about an object attribute

    • Id (STRING): ID of the attribute

    • Name (STRING): Name of the attribute

    • AttributeClassId (STRING): Attribute class ID of the attribute

    • AttributeValue: CDATA with attribute value, possibly MIME-encoded

  • ParentObject: Organization object that stands directly above the current class in the organization tree

    • Id (STRING): ID of the object

    • Name (STRING): Name of the object

  • ChildClass: Organization object that stands directly under the current class in the organization tree

    • Id (STRING): ID of the object

    • Name (STRING): Name of the object

5. See Also

wfm.GetOrganisations, wfm.GetOrganisationObjects