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 . Benutzerdefinierte Content-Typen (mit Untertypen json oder xml) werden ebenfalls unterstützt. So werden zum Beispiel, application/vnd.collection+json und application/vnd.adobe.xdp+xml als JSON bzw. XML behandelt.

Wichtig:

Wenn das Anforderungstextformat nicht ein json- oder xml-Untertyp ist, verwenden Sie nur das Feld für den Anfragetext dataStream, um auf den Anforderungstext zuzugreifen. Das Verwenden des Anfragetextes data, dataString, nextEntry() oder hasNext() mit einem Nicht-JSON- oder Nicht-XML-Format führt zu einer Fehlerantwort 500.

Standardwerte werden festgelegt

Mit können Sie Standardwerte für die API festlegen Standardmäßig unterstützte Anforderungsformate Und Standardmäßig unterstützte Antwortformate Felder. Diese Felder definieren akzeptable Werte, die Benutzer in den Content-Type- bzw. in die Accept-Anforderungskopfzeilen übergeben können. Wenn ein anfordernder Anwender einen Accept- oder Content-Type-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:

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

Platzhalterwerte werden verwendet

Sie können Platzhalterwerte verwenden, wenn Sie gültige Content-Typen angeben.

• Verwenden Sie das Platzhalterzeichen (%), um eine Platzhaltersuche mit einem Zeichen durchzuführen. Dieser Platzhalter sucht nach Wörtern, die ein beliebiges Zeichen anstelle des Prozentzeichens enthalten. Um beispielsweise nach Wörtern wie „Text“ oder „Test“ zu suchen, suchen Sie nach Te%t.
• Verwenden Sie zum Ausführen einer Platzhaltersuche mit mehreren Zeichen das Sternchen (*). Dieser Platzhalter findet Wörter, die anstelle des Sternzeichens kein oder mehr Zeichen enthalten. Um beispielsweise Wörter wie „planned“ oder „placed“ zu finden, suchen Sie nach pl*d.

Mit dem Inhaltstyp x-www-Form-urlencodiert

Ob eine REST-API oder -Ressource den 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 die auf diese Parameter zu Request.queryParams Objekt.

Wenn zum Beispiel Ihre API so definiert ist, dass sie den Content Typ application/x-www-form-urlencoded akzeptiert, und Ihre API wie folgt implementiert ist,

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

 response.setBody(request.queryParams);

})(request, response);

… dann ergibt die folgende Anfrage 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

Wenn Sie einen binären Typ in einer Antwort senden, müssen Sie den Antwort-Content-Typ festlegen, und den binären Datenstrom direkt mit einem Objekt RESTAPIResponseStream schreiben. Sie können auf dieses Objekt zugreifen, indem Sie auf dem Antwortobjekt getStreamWriter() aufrufen. Weitere Informationen finden Sie unter .