wfm.GetOrganisationClasses

Dieser Job liefert Informationen zu den Klassen einer Organisation.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

OrganisationId

STRING

Ja

ID der Organisation

RequestType

INT

Ja

Flag, das die Anfrage spezifiziert — die nachfolgenden Parameter müssen entsprechend gesetzt werden:
0 = alle Klassen suchen
1 = Suche erfolgt für IDs im Parameter ClassIds
2 = Suche erfolgt für Namen im Parameter ClassName

ClassIds

STRING

Ja

Kommaseparierte Liste von Klassen-IDs (relevant bei RequestType = 1)

ClassName

STRING

Ja

Klassen-Name (relevant bei RequestType = 2)

AttributeId

STRING

Ja

Derzeit nicht unterstützt — 0 übergeben.

RequestData

INT

Ja

Spezifiziert die Ergebnisse der Anfrage:
1 = nur Index-Daten der Klassen ermitteln (Objekt-ID, Name, Klassen-ID)
3 = Index-Daten und Klassen-Attribute ermitteln
5 = Index-Daten und Klassen-Beziehungen ermitteln
7 = Index-Daten, Klassen-Attribute und Klassen-Beziehungen ermitteln

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Classes

BASE64

—

Informationen zu den angeforderten Klassen im XML-Format (siehe unten)

3. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode.

4. Beispiel

Aufbau von Classes:

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

Beschreibung der XML-Struktur:

  • Class: Informationen zu einer Organisations-Klasse

    • Id (STRING): ID der Klasse

    • Name (STRING): Name der Klasse

  • Attribute: Informationen zu einem Objekt-Attribut

    • Id (STRING): ID des Attributs

    • Name (STRING): Name des Attributs

    • AttributeClassId (STRING): Attribut-Klassen-ID des Attributs

    • AttributeValue: CDATA mit Attributwert, ggf. MIME-kodiert

  • ParentObject: Organisations-Objekt, das im Organisationsbaum direkt über der aktuellen Klasse steht

    • Id (STRING): ID des Objekts

    • Name (STRING): Name des Objekts

  • ChildClass: Organisations-Objekt, das im Organisationsbaum direkt unter der aktuellen Klasse steht

    • Id (STRING): ID des Objekts

    • Name (STRING): Name des Objekts

5. Siehe auch

wfm.GetOrganisations, wfm.GetOrganisationObjects