PORTAL und PPS Knowledge Base

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

ZUR ABNAHME Former user (Deleted)

Zusammenfassung

Webservice

REST

Objekt

JSON

Trigger

GET, POST, PUT, DELETE

Anbieter

PEIQ

Syntax

Routing-API

Die API des Routing-Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von URL-Redirects verwendet werden.

Produkt (Label)

Portal

Übergeordnetes Modul (Label)

API, Redirects

Inhaltsverzeichnis

 Inhaltsverzeichnis anzeigen

Interne Beschreibung

Basis URL 

https://yourdomain.com/api/v2/routing/redirects

Die Routing API ermöglicht es systemgesteuert Redirects (URL Umleitung) zu lesen, anzulegen, zu löschen oder zu manipulieren. Dabei ist zu beachten, dass ein Redirect keine Systemseiten übersteuern kann.

Verfügbare Endpunkte

GET

  • Get Redirects by Filter

    • tag

    • page

    • page_size

  • Get Redirects by redirect_id

    • redirect_id

Response

{
  "id": "1",
  "source": "/example/source",
  "target": "https://www.example.com/example/source",
  "tag": "Test Redirect Tag"
}

POST

  • Create Redirect

PUT

  • Update Redirect

DELETE

  • Delete Redirect by ID

Request Body

{
  "source": "/example/source/import",
  "target": "https://www.example.com/example/source/import",
  "tag": "Test Redirect Tag Import"
}

HTTP Status Codes

200 - Success           Alles hat wie erwartet funktioniert
201 - Redirect Successfully Created
204 - Redirect Successfully Updated/Deleted
400 - Bad Reqest        Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body
404 - Redirect Not Found 
409 - Duplicate Entry   Das Feld "source" muss einzigartig sein.

Setup & Konfiguration

Aktivierung Feature

Aufwand Technik

Als Change Request (Releaseunabhängig)

https://docs.google.com/document/d/1loSYAex--vFIdZ0OAAfcw8buiiCKFlZpdm3QpkvcIr0/edit?ts=5d9c7c36#heading=h.9blbyv4a4qgm

0,25PH

Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”

Der Zugang zur /wiki/spaces/CORE/pages/44400763 selbst ist jedoch pro Modul aktivierbar. Siehe hierfür die jeweiligen Angaben zum Setup.

Konfigurationsparameter

Es sind keine Konfigurationsmöglichkeiten für die Schnittstelle vorhanden.

Bekannte Einschränkungen

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

Modul im Einsatz bei

Alte Version (V1) genutzt von:

Verwandte Themen

Verwandte Seiten

Filter by label

There are no items with the selected labels at this time.

Verwandte Labels

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten EXTERN

In diesem Teil werden über sogenannte Auszüge Snippets für die extern zugänglichen Dokumente und Seiten erstellt. Diese Auszüge werden vom Customer Success auf weitere Seiten kuratiert.

Neue Auszüge können über /auszug erstellt werden.

Änderungen an bereits bestehenden Auszügen dürfen nicht vorgenommen werden. Siehe hierzu die Anleitung /wiki/spaces/CORE/pages/44204087.

Allgemeine Beschreibung EXTERN

Beschreibt in wenigen Sätzen die Ziele bzw. Vorteile des Moduls / Features sowie als Stichwortliste dessen Leistungsumfang. Die Allgemeine Beschreibung ist als Einstieg für den Kunden zu verstehen und beantwortet folgende Fragen: Warum brauche ich das? Was kann das?

Details EXTERN

Externe Produktdokumentation für die Kunden (Customer Success): Inhalt der aktuell FAQ benannten Dokumente, aber nicht als Frage-Antwort, sondern einfach als Dokumentation für den (potenziellen) Kunden (ohne kritische interne Hinweise, ohne Aufwände, vor allem ohne Links auf die interne CORE-Umgebung).

Release-Notes EXTERN

Monat 202X - Zusammenfassung

Text

Monat 202X - Zusammenfassung

Text

Anleitung zum Setup EXTERN

Historie

Version Date Comment
Current Version (v. 1) 2020-09-27 08:36 Boris Braun
v. 11 2024-02-09 14:48 Kathrin Janka
v. 10 2024-02-08 14:35 Kathrin Janka
v. 9 2022-08-18 08:46 Former user
v. 8 2022-03-15 15:26 Former user
v. 7 2020-11-02 10:37 Franziska Franz
v. 6 2020-10-27 15:11 Former user
v. 5 2020-10-22 05:08 Franziska Franz
v. 4 2020-10-22 05:06 Franziska Franz
v. 3 2020-10-06 08:56 Boris Braun
v. 2 2020-09-28 07:06 Boris Braun
v. 1 2020-09-27 08:36 Boris Braun

  • No labels

Impressum