wfm.AdhocGetTemplateList

Liefert eine oder mehrere Adhoc-Vorlagen für den angegebenen Benutzer.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

UserId

STRING

Ja

ID des Benutzers

OrgId

STRING

Ja

ID der Organisation

[TemplateId]

STRING

Nein

ID der Vorlage. Ist dieser Parameter leer, werden alle Adhoc-Vorlagen ermittelt, die für den Benutzer sichtbar sind (alle öffentlichen Vorlagen und die vom Benutzer privatisierten Vorlagen).

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Templates

BASE64

—

Liste der ermittelten Adhoc-Vorlagen im XML-Format (siehe Hinweis)

3. Rückgabe

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

4. Hinweis

Jede Vorlage in Templates hat folgende Struktur:

  • Template: Beschreibt eine Adhoc-Vorlage

    • TemplateId (STRING): ID der Adhoc-Vorlage

    • TemplateName (STRING): Name der Adhoc-Vorlage

    • Public (INT): 0 = Vorlage ist nicht öffentlich, 1 = Vorlage ist öffentlich

    • RoutingList: Laufliste (Struktur wie bei wfm.AdhocConfigTemplate)

Genauere Beschreibung von RoutingList und deren Unterelemente:

  • RoutingList: Laufliste mit folgender Struktur (oder Untermengen davon)

    • Id (STRING): ID der Laufliste. Dieser Wert wird vom Server gesetzt und darf nicht verändert werden.

    • ActivityId (STRING): Aktivitäts-ID

    • Expandable (INT): 0 = Laufliste kann nicht erweitert werden, 1 = Laufliste kann erweitert werden

  • Entries: Fasst Einträge der Laufliste zusammen. Ein Eintrag besteht aus mehreren Elementen, die parallel ausgeführt werden können.

  • Entry: Beschreibt einen Eintrag in der Laufliste.

    • Nr (INT): Dient der relativen Sortierung der Einträge innerhalb der Laufliste. Die absoluten Werte haben für den Client keine Bedeutung.

    • Expandable (INT): 0 = Eintrag kann nicht erweitert werden, 1 = Eintrag kann erweitert werden

  • Item: Beschreibt ein Element der Laufliste (Aktivität, ausführende Person und ggf. Termin).

    • Id (STRING): Dient der Identifizierung. Darf nicht verändert werden und muss bei allen Jobs identisch mitgeschickt werden. Wurde ein Item durch den Client erstellt, muss dieser hier eine ID angeben.

    • ActivityId (STRING): ID der Aktivität im Workflowmodell

    • ActivityName (STRING): Name der Aktivität (muss nicht mit dem Namen im Workflowmodell übereinstimmen)

    • ActivityModelName (STRING): Name der Aktivität im Workflowmodell

    • TimerId (STRING): ID einer Mahnfrist

    • TimerName (STRING): Name der Mahnfrist

    • TimerDuration (INT): Dauer der Frist

    • TimerDurationType (INT): 0 = keine Frist, 1 = relativ, 2 = absolut

    • Changeable (INT): 0 = keine Änderung möglich, 1 = Element darf vom Client verändert werden

    • Deleteable (INT): 0 = Löschen nicht erlaubt, 1 = Element darf gelöscht werden

    • Remark (STRING): Hinweis zur Bearbeitung (Text)

    • ObjectIds (STRING): Liste von GUIDs der Bearbeiter (Rollen oder Personen), durch Komma getrennt