wfm.GetOrganisationObjects

This job returns information about the objects in 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 objects
1 = search by IDs in parameter ObjectIds
2 = search by names in parameter ObjectName
3 = search by IDs in parameter ClassIds
4 = search by names in parameter ClassName
5 = search for parent objects by names in parameter ObjectName
6 = search for child objects by names in parameter ObjectName
7 = search for parent objects by names in parameter ClassName
8 = search for child objects by names in parameter ClassName

ObjectIds

STRING

Yes

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

ObjectName

STRING

Yes

Object name (relevant when RequestType = 2, 5, 6)

ClassIds

STRING

Yes

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

ClassName

STRING

Yes

Class name (relevant when RequestType = 4, 7, 8)

AttributeId

STRING

Yes

Currently not supported — pass 0.

AttributeValue

STRING

Yes

Currently not supported — pass 0.

RequestData

INT

Yes

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

2. Output Parameters

Name Type Dependency Description

Objects

BASE64

—

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

3. Return Value

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

4. Example

Structure of Objects:

<Objects>
  <Object Id="" Name="" ClassId="">
    <Attributes>
      <Attribute Id="" Name="" AttributeClassId="">
        <AttributeValue><![CDATA[]]></AttributeValue>
      </Attribute>
    </Attributes>
    <ParentObjects>
      <ParentObject Id="" Name="" ClassId=""/>
    </ParentObjects>
    <ChildObjects>
      <ChildObject Id="" Name="" ClassId=""/>
    </ChildObjects>
  </Object>
</Objects>

Description of the XML structure:

  • Object: Information about an organization object

    • Id (STRING): ID of the object

    • Name (STRING): Name of the object

    • ClassId (STRING): Class ID of the object

  • 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 object in the organization tree

    • Id (STRING): ID of the object

    • Name (STRING): Name of the object

    • ClassId (STRING): Class ID of the object

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

    • Id (STRING): ID of the object

    • Name (STRING): Name of the object

    • ClassId (STRING): Class ID of the object

5. See Also

wfm.GetOrganisations, wfm.GetOrganisationClasses