Zum Hauptinhalt springen

Payloads der Reporting-API verstehen

Der Endpunkt für Listenberichte, POST /api/repositories/{repository}/reporting/list, gibt Berichtsdaten in einer kompakten, Array-basierten Form zurück. Weil ein Bericht Daten beliebig tief verschachteln kann, beschreibt die Antwort ihre eigene Struktur, statt ein festes Schema zu verwenden. So kann ein Client jeden Bericht lesen, sobald er das Muster verstanden hat.

Überblick​

Sie senden einen Anfragetext mit der Berichtsdefinition:

{
"approvedOnly": true,
"filters": ["type=ObjectType.PROCESS and isSupportedBy.object.type=ObjectType.RESOURCE"],
"properties": ["isSupportedBy"]
}
  • filters – der Zeilenfilter, geschrieben in iGrafx Query Language (IQL).
  • properties – die Spalten, die zusätzlich zur Identität des Objekts selbst enthalten sein sollen.
  • approvedOnly – bei true wird der Bericht auf freigegebene Versionen beschränkt.

Die Antwort besteht aus zwei Teilen: einem heading, das die Spalten beschreibt, und einem body, der die Zeilen enthält.

Wichtige Konzepte​

Heading. Ein Array von Spaltenbeschreibungen. Jede hat einen name und einen type (zum Beispiel Int32 oder NString). Eine Spalte, die eine Sammlung verknüpfter Objekte enthält, hat zusätzlich einen collectionType (etwa Set) und ein eigenes verschachteltes heading, das die Spalten jedes verknüpften Objekts beschreibt.

[
{ "name": "ID", "type": "Int32" },
{ "name": "name", "type": "NString" },
{ "name": "isSupportedBy", "type": "IsSupportedBy", "collectionType": "Set",
"heading": [ { "name": "ID", "type": "Int32" }, { "name": "name", "type": "NString" } ] }
]

Body. Ein Array von Zeilen. Jede Zeile ist selbst ein Array von Werten, in derselben Reihenfolge wie das heading. Der Wert einer Sammlungsspalte ist selbst ein Array verschachtelter Zeilen, die dem verschachtelten Heading entsprechen.

[
[ 1, "Process 1", [ [2, "Application 1"], [3, "Application 2"] ] ],
[ 4, "Process 2", [ [5, "Application 3"], [6, "Person 1"] ] ]
]

Zuordnung über die Position. Werte tragen keine Namen – Sie lesen jeden Wert über seine Position im passenden Heading. In der ersten Zeile ist 1 die ID, "Process 1" der name, und das dritte Element ist die Menge isSupportedBy, in der jeder Eintrag ([2, "Application 1"]) der ID und dem name des verschachtelten Headings entspricht.

Zeilen als Arrays statt als benannte Objekte zurückzugeben, hält die Payload klein. Das ist bei Berichten mit vielen Zeilen wichtig.