RestAddPathParam

value RestAddPathParam ( value rest, string strName, string strValue );

Rückgabewert

Rückgabewert

Beschreibung

TRUE / true / 1

Der Pfadparameter strName wurde erfolgreich mit dem Wert strValue ersetzt bzw. hinzugefügt.

FALSE / false / 0

Das Hinzufügen bzw. Ersetzen des Pfadparameters strName ist fehlgeschlagen.

Parameter

rest

Das REST-Objekt, dem ein Pfadparameter hinzugefügt bzw. ersetzt  werden soll.

strName

Der Name des Pfadparameters, der hinzugefügt bzw. ersetzt werden soll.

strValue

Die Zeichenkette, die dem Pfadparameter strName als Wert zugewiesen werden soll.

Bemerkungen

Fügt den Pfadparameter strName mit dem Wert strValue hinzu oder ersetzt diesen.

Der Pfadparameter strName wird in den Zeichenketten, die bei nachfolgenden Funktionsaufrufen als Übergabeparameter strUriPath übergeben werden, mit dem Wert von strValue ersetzt. Wenn der Pfadparameter beispielsweise "fileId" und der Wert "D6VUkqqTO8zSqpHGcyem" ist, wird ein strUriPath-Argument mit "/drive/2.0/files/fileId" in "/drive/2.0/files/D6VUkqqTO8zSqpHGcyem" umgewandelt.

Beispiel

//postman-echo.com liefert als Antwort eine Auswertung der empfangenen REST-Anfrage

value rest;
string strLastError, strResponse;
if (!RestConnect(rest, "https://postman-echo.com", 443, true))
    RestGetLastError(rest, strLastError, true);
    return;
end
RestAddPathParam(rest, "idRes", "headers"); //Platzhalter 'idRes' durch 'headers' ersetzen
RestFullRequest(rest, "GET", "/idRes", NULL, strResponse);
strResponse = JsonExpand(strResponse);
//Inhalt von strResponse:
//{
//  "headers": {
//    "x-forwarded-proto": "https",
//    "host": "postman-echo.com",
//    "header1": "test",
//    "x-forwarded-port": "443"
//  }
//}
RestRemoveAllPathParams(rest);

RestAddPathParam(rest, "idRes", "ip"); //Platzhalter 'idRes' durch 'ip' ersetzen
RestFullRequest(rest, "GET", "/idRes", NULL, strResponse);
strResponse = JsonExpand(strResponse);
//Inhalt von strResponse:
//{
//  "ip": "82.165.12.98"
//}
RestDisconnect(rest);
 

Die REST-Funktionen

Siehe auch  RestAddHeader, RestAddQueryParam, RestAddQueryParams, RestSetBasicAuth, RestSetIdleTimeout, RestRemoveAllHeaders, RestRemoveAllPathParams, RestRemoveAllQueryParams, RestRemoveBasicAuth