wfm.GetOrganisationObjects

Dieser Job liefert Informationen zu den Objekten in 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 Objekte suchen
1 = Suche erfolgt für IDs im Parameter ObjectIds
2 = Suche erfolgt für Namen im Parameter ObjectName
3 = Suche erfolgt für IDs im Parameter ClassIds
4 = Suche erfolgt für Namen im Parameter ClassName
5 = Suche der Vorgänger-Objekte erfolgt für Namen im Parameter ObjectName
6 = Suche der Nachfolger-Objekte erfolgt für Namen im Parameter ObjectName
7 = Suche der Vorgänger-Objekte erfolgt für Namen im Parameter ClassName
8 = Suche der Nachfolger-Objekte erfolgt für Namen im Parameter ClassName

ObjectIds

STRING

Ja

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

ObjectName

STRING

Ja

Objekt-Name (relevant bei RequestType = 2, 5, 6)

ClassIds

STRING

Ja

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

ClassName

STRING

Ja

Klassen-Name (relevant bei RequestType = 4, 7, 8)

AttributeId

STRING

Ja

Derzeit nicht unterstützt — 0 übergeben.

AttributeValue

STRING

Ja

Derzeit nicht unterstützt — 0 übergeben.

RequestData

INT

Ja

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

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Objects

BASE64

—

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

3. Rückgabe

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

4. Beispiel

Aufbau von 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>

Beschreibung der XML-Struktur:

  • Object: Informationen zu einem Organisations-Objekt

    • Id (STRING): ID des Objekts

    • Name (STRING): Name des Objekts

    • ClassId (STRING): Klassen-ID des Objekts

  • 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 dem aktuellen Objekt steht

    • Id (STRING): ID des Objekts

    • Name (STRING): Name des Objekts

    • ClassId (STRING): Klassen-ID des Objekts

  • ChildObject: Organisations-Objekt, das im Organisationsbaum direkt unter dem aktuellen Objekt steht

    • Id (STRING): ID des Objekts

    • Name (STRING): Name des Objekts

    • ClassId (STRING): Klassen-ID des Objekts

5. Siehe auch

wfm.GetOrganisations, wfm.GetOrganisationClasses