API-Vorlagen übergeben

In REST-Anforderungen referenzieren die Parameter _templateKey und _templateId Vorlagen, die in der Datenbank gespeichert sind. Da auf die Vorlagen über Referenzen zugegriffen wird, sind REST-Anforderungen, die Vorlagen verwenden, einfach aufgebaut und mehrere Benutzer können eine einzelne zentral verwaltete Vorlage gemeinsam nutzen.

Vorlagen in der Datenbank verwalten

Sie können API-Vorlagen mithilfe von drei APIs erstellen, lesen, aktualisieren und löschen. Detaillierte Informationen zu diesen APIs finden Sie in den API-Javadoc-Dateien.

  • manageApiTemplate
  • getApiTemplateDetails
  • getApiTemplateList

Sie können auf "ApiTemplate"-APIs zugreifen, indem Sie den Ressourcennamen api_template in den REST-Anforderungen zum Auflisten ("list"), zum detaillierten Beschreiben ("detail"), zum Ändern ("modify"), zum Erstellen ("create") oder zum Löschen ("delete") angeben.

Das folgende Beispiel zeigt eine REST-Anforderung zum Erstellen einer API-Vorlage:
POST https://host:port/contextRoot/restapi/api_template

Nachdem eine Vorlage in der Datenbank erstellt wurde, werden die zugehörigen Daten in der Tabelle PLT_API_TEMPLATE gespeichert:

Einstiegsspeichermedien Beschreibung
ORGANIZATION_CODE Organisations-ID, die in Architekturen mit mehreren Mandanten verwendet wird
TEMPLATE_TYPE

00 für eine API-Vorlage

01 für eine Ressource
API_NAME Name der API oder Ressource
TEMPLATE_ID ID in org+type+name
DESCRIPTION Zusätzliche beschreibende Informationen
TEMPLATE_DATA Spalte für große Zeichenobjekte, in der die Vorlage enthalten ist

Vorlagen referenzieren

Fordern Sie bestimmte Vorlagen in API-Aufrufen in "YFSEnvironment" mit dieser Methode an:
public void setApiTemplate(String apiName, String templateFileName)
Zum Referenzieren einer Vorlage aus der REST-Ebene verwenden Sie einen Abfrageparameter, der dem Format von templateFileName entspricht:
templateFileName-Format Format des REST-Abfrageparameters
"key:primaryKey" _templateKey=primaryKey
"id:orgCode,templateId" _templateId=orgCode,templateId
Hinweis: Das Attribut organisationscode ist optional und hat standardmäßig den Wert DEFAULT.