Optionale Parameter

Die folgenden optionalen Parameter können in REST API-Methodenaufrufen angegeben werden:

Parameter	Beschreibung
detail	Abfragezeichenfolge-Parameter, der für alle API-Aufrufe gilt. Er akzeptiert einen von zwei Werten: high oder low. Hohe Detailgenauigkeit (high) führt zu umfassenderen API-Antworten. Geringe Detailgenauigkeit (low) führt zu minimalen API-Antworten. Der Zweck dieser Funktion ist es, das Laufzeitverhalten durch die Steuerung der Antwortgröße und der Rechenkomplexität zu verbessern.
f	Formatmatrix-Parameter, der festgelegt werden kann, wenn der HTTP-Request-Header "Accept" nicht gesetzt werden kann. Zulässige Werte sind xml. json. contents oder text. Verwenden Sie xml oder json, um eine Antwort in XML oder JSON darzustellen. text und contents sind für bestimmte API-Aufrufe reserviert, die den reinen Text-Download (z. B. Umsetzungs-Protokolldateien) oder den Datei-Download (z. B. Workspaces und Ressourcen) unterstützen.

Parameter

Beschreibung

detail

Abfragezeichenfolge-Parameter, der für alle API-Aufrufe gilt. Er akzeptiert einen von zwei Werten: high oder low. Hohe Detailgenauigkeit (high) führt zu umfassenderen API-Antworten. Geringe Detailgenauigkeit (low) führt zu minimalen API-Antworten. Der Zweck dieser Funktion ist es, das Laufzeitverhalten durch die Steuerung der Antwortgröße und der Rechenkomplexität zu verbessern.

Formatmatrix-Parameter, der festgelegt werden kann, wenn der HTTP-Request-Header "Accept" nicht gesetzt werden kann. Zulässige Werte sind xml. json. contents oder text. Verwenden Sie xml oder json, um eine Antwort in XML oder JSON darzustellen. text und contents sind für bestimmte API-Aufrufe reserviert, die den reinen Text-Download (z. B. Umsetzungs-Protokolldateien) oder den Datei-Download (z. B. Workspaces und Ressourcen) unterstützen.