X4 Produktdokumentation

Atlassian Jira Connector ReST API

Atlassian Jira Connector: Bietet einen Low-Level-Zugriff auf die Atlassian Jira ReST-API.

Properties (Eigenschaften)

Operation

Bestimmt, welche Operation der Adapter durchführt

Mögliche Werte:

  • Execute: Adapter mit der vorgenommenen Parametrierung ausführen

Parameter

Adapter

Hauptklasse des Adapters (nicht verändern!)

Mögliche Werte:  de.softproject.integration.nativeadapter.NativeAdapter : Hauptklasse (Standard)

Repository

Virtuelles Repository des Adapter-Projekts. Der Wert kann nicht geändert werden.

host

Erforderlich. URL des Jira-Servers

Mögliche Werte: Beliebige gültige URL, z. B.  jira.example.com

port

Port der ReST-API

Mögliche Werte:

  • Beliebige positive ganze Zahl

  • 443 : Standardport 

path

Erforderlich. Ressourcen-Pfad für die Anfrage

Mögliche Werte: URL-Part in Jira (Weitere Informationen unter https://docs.atlassian.com/software/jira/docs/api/REST/7.13.0/#api/2), z.B. /rest/api/2/{issueIdOrKey}

secure

Angabe, ob die Kommunikation über HTTPS stattfinden soll oder nicht

Mögliche Werte: true (Standard) / false

username

Erforderlich. Jira-Benutzer, der für die Authentifizierung verwendet wird

password

Erforderlich, falls token nicht verwendet wird. Passwort des Jira-Benutzers für die Authentifizierung

token

Erforderlich, falls password nicht verwendet wird. Für die Authentifizierung verwendetes Token. Das Token kann anstelle eines Passworts verwendet werden.

method

Erforderlich. HTTP-Methode, die für die Anfrage verwendet wird

Mögliche Werte:

  • Get (Standard)

  • Post

  • Put

  • Delete

  • Patch

query

URL-kodierte Abfrage, z. B. query="project={projectKey} ORDER BY createdDate ASC"

Statuswerte 

1

>Die Operation wurde erfolgreich ausgeführt.

-1

Es kam zu einem Fehler während der Ausführung.

Input

Der Adapter erwartet einen Input im XML-Format. Im Wurzelelement muss die Namespace-Definition xmlns:j=http://www.softproject.de/schemas/2020/json-converter enthalten sein. Der genaue Aufbau findet sich unter https://docs.atlassian.com/software/jira/docs/api/REST/7.13.0/#api/2.

Output

Der Adapter gibt ein Dokument mit der Struktur, die unter https://docs.atlassian.com/software/jira/docs/api/REST/7.13.0/#api/2 beschrieben wird, aber im XML-Format. Wenn kein Inhalt vorhanden ist, der ausgegeben werden kann, dann wird die Nachricht The operation was successful! ausgegeben.