Drücke „Enter”, um zum Inhalt zu springen.

JIRA Custom Service Broker (Teil 4)

0

In diesem Teil der Beschreibung des JIRA Service Broker werden zwei weitere Methoden für eine Suche mit JQL beschrieben.

Das Besondere an diesen beiden Methoden ist, dass diese eine Deserialisierte Version des Suchergebnisses zurückgibt. Da die Suchergebnisse in vollem Umfang jedoch sehr umfangreich sein können, beschränkt sich die Ergebnismenge bei diesen beiden Versionen auf die aus unserer Sicht wichtigsten Informationen.

JQLSearchStatic

Diese Methode unterscheidet sich auf den ersten Blick nicht zur Methode JQLSearch.

Sie erfordert dieselben Parameter für die Suche – allerdings gibt die Methode nicht einfach ein JSON-Objekt zurück, sondern jeweils einen Datensatz für jeden gefundenen Issue.

Eingabe Parameter:

  • SearchJQL – wie bei den anderen JQL-Methoden auch, kann hier die JQL-Query definiert werden
  • SearchStartAt – der Index ab dem die Ausgabe der gefundenen Ergebnissen zurück gegeben werden soll
  • SearchMaxResults – maximale Anzahl der Ergebnisse, die zurück gegeben werden sollen
  • SearchValidateQuery –  legt fest ob die Query validiert werden soll oder nicht
  • SeaarchFields – definiert, welche Felder (getrennt mit einem Komma) für die Suchergebnisse zurückgegeben werden sollen. Prinzipiell können bei dieser Methode alle möglichen Felder A8auch CustomFields) einbezogen werden, jedoch werden maximal nur diese Felder in die Ergebnismenge einbezogen: summary,description,duedate,created,updated,issuetype,assignee,project
  • SearchExpand – eine Komma separierte Liste von Parametern, um die die Anforderung erweitert werden soll

Ergbnisse:

In dieser Version gibt die Methode folgende Informationen zurück (wird der Parameter „SearchFields“ nicht befüllt, werden die Standardfelder, die an der Serviceinstanz mit der Eigenschaft „DefaultSearchFields“ festgelegt wurden verwendet):

  • Total – Anzahl aller Issues die auf die Suchanfrage passen
  • Id – Id des Vorgangs (Issue)
  • Key – Key des Vorgangs
  • Summary – Kurzusammenfassung des Vorgangs
  • Description – Beschreibung des Vorgangs
  • IssueUrl – URL zum Vorgang
  • DueDate – Fälligkeitsdatum
  • Created – Erstelldatum des Vorgangs
  • Updated – Letztes Aktualisierungsdatum
  • IssueTypeId– Id des Vorgangstyps
  • IssueTypeName – Name des Vorgangstyps (z.B. Epic, Task …)
  • IssueTypeSubtask – true falls es es ich um eine Unteraufgabe handelt, andernfalls false
  • AssigneeKey – Key des Benutzers, dem der Vorgang zugewiesen ist
  • AssigneeName – Name des Benutzers, dem der Vorgang zugewiesen ist
  • AssigneeEmailAddress – EMail-Adresse des Benutzers, dem der Vorgang zugewiesen ist
  • AssigneeDisplayname – Anzeigename des Benutzers, dem der Vorgang zugewiesen ist
  • ProjectId – ID des Projektes, in dem der Vorgang angelegt wurde
  • ProjectName – Name des Projektes, in dem der Vorgang angelegt wurde
  • ProjectKey – Key des Projektes, in dem der Vorgang angelegt wurde
  • ProjectTypeKey – Projekttyp des Projektes, in dem der Vorgang angelegt wurde

Die Methode gibt immer ein Ergebnis mit allen Spalten zurück – jedoch kann mit der Reduzierung der gewünschten Felder mit dem Parameter „SearchFields“ die Abfrage „verschlankt“ werden, da in diesem Fall nicht alle Informationen von der JIRA Rest-API angefordert werden und damit der Response der API entsprechend schlanker ausfällt – die nicht aufgeführten Felder bleiben dann einfach leer.

Beispiel mit alle Feldern:

Beispiel nur mit „summary“:

Bei den Felder „issuetype„, „assignee“ und „project“ müssen jeweils nur diese Suchfelder angeben werden. Die jeweiligen Eigenschaften werden anhand dieser Felder automatisch befüllt:

Beispiel mit der Angabe des Issuetypes:

 

JQLSearchStaticSimple

Diese Methode funktioniert in der selben Weise wie die zuvor beschriebene Methode JQLSearchStatic – allerdings erfordert die Methode nur 3 Parameter und gibt lediglich nur eine kleine Menge an Werten zurück.

Eingabe Parameter:

  • SearchJQL – wie bei den anderen JQL-Methoden auch, kann hier die JQL-Query definiert werden
  • SearchStartAt – der Index ab dem die Ausgabe der gefundenen Ergebnissen zurück gegeben werden soll
  • SearchMaxResults – maximale Anzahl der Ergebnisse, die zurück gegeben werden sollen

Ergbnisse:

  • Total – Anzahl aller Issues die auf die Suchanfrage passen
  • Key – Key des Vorgangs
  • Summary – Kurzusammenfassung des Vorgangs
  • IssueUrl – URL zum Vorgang
  • DueDate – Fälligkeitsdatum
  • IssueTypeName – Name des Vorgangstyps (z.B. Epic, Task …)

Bei dieser Methode werden immer die o.a. aufgeführten Felder zurückgegeben.

Beispiel:


ArtikelbildBild von Markus Winkler auf Pixabay

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.