Partner (REST API)

Allgemein: Siehe Abschnitt REST API.

images/download/thumbnails/137298813/image2020-3-12_14-40-21-version-1-modificationdate-1681889577503-api-v2.png

Sie können Partner per HTTP suchen, anlegen, ändern und löschen.

Logs für Anfragen dieser Art finden Sie in den Server-Logs unter internal/message.log.

Partner suchen


Über den Namen eines Partners wird dessen ID zurück gegeben.


URL (HTTP GET):

http://<IP oder URL des Integration Servers>/dw/auth/v1/relationSearch?name=<Partnername>

https://<IP oder URL des Integration Servers>/dw/auth/v1/relationSearch?name=<Partnername>

Hinweis: Siehe Abschnitt Hinzufügen eines HTTPS-Listeners.

Beispielhafte Response


Die Struktur der Response ist bei jeder erfolgreichen Partner-Operation identisch.

Die id ist die Partner-ID.


{
"response": {
"status": "ok",
"id": "1554894544117000"
}
}

Partner anlegen


URL (HTTP POST mit JSON):

http://<IP oder URL des Integration Servers>/dw/auth/v1/relation

https://<IP oder URL des Integration Servers>/dw/auth/v1/relation

JSON:

{
"operation": "add",
"id": 0,
"name": "My partner",
"active": true
}

Sie können hier entweder 0 für die id angeben oder die Zeile ganz weglassen, da die ID bei dieser Operation ja erst erzeugt wird.

Mit name wird der Name des zu erzeugenden Partners festgelegt.

Mit active können Sie den Partner aktiv oder inaktiv setzen.

Partner ändern


URL (HTTP POST mit JSON):

http://<IP oder URL des Integration Servers>/dw/auth/v1/relation

https://<IP oder URL des Integration Servers>/dw/auth/v1/relation

JSON:

Hinweis: Beim Parameter id kann statt der ID des Partners auch der Name des Partners angegeben werden.

{
"operation": "update",
"id": 1616381046459001,
"name": "My partner updated",
"active": false
}

Partner löschen


URL (HTTP POST mit JSON):

http://<IP oder URL des Integration Servers>/dw/auth/v1/relation

https://<IP oder URL des Integration Servers>/dw/auth/v1/relation

JSON:

Hinweis: Beim Parameter id kann statt der ID des Partners auch der Name des Partners angegeben werden.

{
"operation": "delete",
"id": 1616381046459001
}

Logs


Logs für Anfragen dieser Art finden Sie in den Server-Logs unter internal/message.log (bzw. in der Datei ./logs/services/message.log).