Inhaltstyp für Kontrollanforderung und -Antwort

Steuert, welche Inhaltstypen in geskripteten REST-API-Anforderungen und -Antworten zulässig sind.

Standardmäßig werden geskriptete REST-APIs unterstützt Anwendung/JSON , Anwendung/XML , Und Text/XML . Anwenderdefinierte Inhaltstypen (mit json Oder xml Untertypen) werden ebenfalls unterstützt. Beispiel: Application/vnd.Collection+JSON Und Application/vnd.adobe.xdp+xml Werden als JSON bzw. XML behandelt.

Wichtig:

Wenn der Anforderungstext kein Format aufweist json Oder xml Untertyp: Verwenden Sie nur den Anforderungstext Datenstrom Feld für den Zugriff auf den Anforderungstext. Anforderungstext wird verwendet Daten , Datenzeichenfolge , NextEntry() , Oder HasNext() Mit einem nicht-JSON- oder nicht-XML-Format ergibt ein 500 Fehlerantwort.

Standardwerte werden festgelegt

Sie können Standardwerte für die API mit festlegen Standardmäßig unterstützte Anforderungsformate Und Standardmäßig unterstützte Antwortformate Felder. Diese Felder definieren zulässige Werte, die Anwender in den Headern „Inhaltstyp“ und „Anforderungs-Header akzeptieren“ übergeben können. Wenn ein anfordernder Anwender einen Accept- oder Inhaltstyp-Header angibt, der von der API oder Ressource nicht unterstützt wird, antwortet die Instanz mit einem HTTP-Fehlercode von 406 Oder 415 .

Sie können diese Werte für jede Ressource mit überschreiben Unterstützte Anforderungsformate Und Unterstützte Antwortformate Im Formular „Geskripteter REST-Service“.

Hinweis:

Die Unterstützte Anforderungsformate Feld wird nur für PUT-, POST- und PATCH-Ressourcen angezeigt.

Platzhalterwerte werden verwendet

Sie können Platzhalterwerte verwenden, wenn Sie gültige Inhaltstypen angeben.

• Verwenden Sie zum Durchführen einer einzeiligen Platzhaltersuche das Prozentzeichen (%). Dieser Platzhalter sucht nach Wörtern, die ein beliebiges Zeichen anstelle des Prozentzeichen-Zeichens enthalten. Um beispielsweise Wörter wie Text oder Test zu finden, suchen Sie nach: te%t .
• Verwenden Sie das Sternchen (*), um eine Platzhaltersuche mit mehreren Zeichen durchzuführen. Dieser Platzhalter findet Wörter, die null oder mehr Zeichen anstelle des Sternchens enthalten. Um beispielsweise Wörter wie geplant oder platziert zu finden, suchen Sie nach: pl*d .

Mit dem Inhaltstyp „x-www-Form-urlencodiert“

Ob eine REST-API oder -Ressource akzeptiert Application/x-www-Form-urlencoded Inhaltstyp: Sie können die in der Anforderung bereitgestellten urlencodierten Werte als JSON-Zuordnung abrufen. Sie können diese urlencodierten Schlüssel-Wert-Paare dann als Abfrageparameter, im Anforderungstext oder beides angeben. Sie werden kombiniert und in den Anforderungsparametern gespeichert. Greifen Sie über auf diese Parameter zu Request.queryParameter Objekt.

Beispiel: Wenn Ihre API so definiert ist, dass sie akzeptiert Application/x-www-Form-urlencoded Inhaltstyp und Ihre API werden wie folgt implementiert:

(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {

 response.setBody(request.queryParams);

})(request, response);

… Dann ergibt die folgende Anforderung die entsprechende Antwort:

POST to localhost:8080/api/now/some_api/some_resource?name3=value3&name4=value4

Textkörper:

name1=value1&name2=value2

Antwort:

{ "result":
    { "name4": [ "value4" ], "name3": [ "value3" ], "name2": [ "value2" ],
      "name1": [ "value1" ]
    }
}

Binärtyp wird in einer Antwort gesendet

Beim Senden eines Binärtyps in einer Antwort müssen Sie den Antwortinhaltstyp festlegen und den Binärstrom direkt mit schreiben RESTAPIResponseStream Objekt. Sie können auf dieses Objekt zugreifen, indem Sie aufrufen GetStreamWriter() Im Antwortobjekt. Weitere Informationen finden Sie unter .