...
| Code Block | ||
|---|---|---|
| ||
$.ajax({
url: '/loom-portal/rest/HttpRestManager?hostName='+URL+"&method=GET&additionalHeaders=[%5B" + "NAME_OF_VARIABLE=" + variable + ";" + "NAME_OF_VARIABLE2=" + variable2 + "]%5D",
type: 'GET',
success: function(data) {
if (data.status && data.status == "200") {
console.log(data);
}
}
}); |
Parameter
Parametername | Standardwert | Beschreibung | Gültige Beispiele |
|---|---|---|---|
hostName | Dieser Parameter enthält die URl des angeforderten Servers. | ||
method | “POST” | Dieser Parameter bestimmt, welche Methode remote aufgerufen wird. "Post" bedeutet, dass der Server eine Eingabe im XML-Format erwartet, die er verarbeitet und zurückgibt. "Get" hingegen bedeutet, dass der Server Daten sendet, ohne dass eine Eingabe erforderlich ist. | Other possibilities are “delete”, “get”, “head”, “options”, “patch”, “post”, “put”. |
postParameter | Dieser Parameter enthält die Eingabe für den Server im JSON-Format. | "json", "XML", "HTML", "text", "auto" | |
responseVariable | "SYS.HttpRestManager_response" | Dieser Parameter enthält die Prozessvariable, in der die Serverantwort gespeichert werden soll. | demoResponseVariable |
user | Dieser Parameter ist nur erforderlich, wenn der Server eine Identifizierung erfordert und den Benutzernamen des Benutzers enthält. | demoUser | |
pass | Dieser Parameter wird nur benötigt, wenn der Server eine Identifikation benötigt und das Kennwort des Benutzers enthält. | demoPassword | |
authMethod | "basic" | Dieser Parameter wird nur benötigt, wenn der Server eine Identifizierung erfordert und die Verschlüsselung enthält, die angewendet werden soll. Eine mögliche Verschlüsselung ist base64, die angewendet wird, indem dieser Parameter auf "basic" gesetzt wird. | "oauth" "basic" |
oAuthTokenUrl | Nur erforderlich, wenn authMethod = "oauth" URL, von der das oauth-Token abgerufen werden soll. | ||
access | "" | Definiert, welche Gruppen oder Benutzer die Schnittstelle aufrufen und Daten daraus abrufen können. Alle anderen Anrufe von nicht autorisierten Benutzern/Gruppen werden abgelehnt. Mehrere Benutzer/Gruppen können über ',' getrennt werden. | group(exampleGroup), user(exampleUser) |
additionalHeaders | Hinzufügen zusätzlicher Header zum Rest-Aufruf | "&method=GET&additionalHeaders= |
%5B" + "NAME_OF_VARIABLE=" + variable + ";" + "NAME_OF_VARIABLE2=" + variable2 + " |
%5D" |
Beispiel
Javascript (JavaScript)
...
| Code Block | ||
|---|---|---|
| ||
URL: '/loom-portal/rest/HttpRestManager/<<name_of_tim.propertie_endpoint>> |
Parameter
Parametername | Standardwert | Beschreibung | Gültige Beispiele |
|---|---|---|---|
hostName | Dieser Parameter enthält die URl des angeforderten Servers. | ||
method | "POST" | Dieser Parameter bestimmt, welche Methode remote aufgerufen wird. "Post" bedeutet, dass der Server eine Eingabe im XML-Format erwartet, die er verarbeitet und zurückgibt. "Get" hingegen bedeutet, dass der Server Daten sendet, ohne dass eine Eingabe erforderlich ist. | Other possibilities are “delete”, “get”, “head”, “options”, “patch”, “post”, “put”. |
postParameter | Dieser Parameter enthält die Eingabe für den Server im JSON-Format. | "json", "xml", "html", "text", "auto" | |
responseVariable | "SYS.HttpRestManager_response" | Dieser Parameter enthält die Prozessvariable, in der die Serverantwort gespeichert werden soll. | demoResponseVariable |
user | Dieser Parameter ist nur erforderlich, wenn der Server eine Identifizierung erfordert und den Benutzernamen des Benutzers enthält. | demoUser | |
pass | Dieser Parameter wird nur benötigt, wenn der Server eine Identifikation benötigt und das Kennwort des Benutzers enthält. | demoPassword | |
authMethod | "basic" | Dieser Parameter wird nur benötigt, wenn der Server eine Identifizierung erfordert und die Verschlüsselung enthält, die angewendet werden soll. Eine mögliche Verschlüsselung ist base64, die angewendet wird, indem dieser Parameter auf "basic" gesetzt wird. | "oauth" "basic" |
oAuthTokenUrl | Nur erforderlich, wenn authMethod = "oauth" URL, von der das oauth-Token abgerufen werden soll. | ||
access | "" | Definiert, welche Gruppen oder Benutzer die Schnittstelle aufrufen und Daten daraus abrufen können. Alle anderen Anrufe von nicht autorisierten Benutzern/Gruppen werden abgelehnt. Mehrere Benutzer/Gruppen können über ',' getrennt werden. | group(exampleGroup), user(exampleUser) |
Beispiel
Javascript (JavaScript)
...
| Code Block | ||
|---|---|---|
| ||
var URL = "https://demo.com/interface/getExampleData";
var USER = "$enc$-605bc19777d129d182d0c467a54b129";
var PASSWORD = "$enc$-eda084ca7ea688d6454add9f9e4bd84";
var demoVariable = "Demo";
jQ.ajax({
url: '/loom-portal/rest/HttpRestManager' +
'?hostName=' + URL +
'&method=POST' +
'&authMethod=basic' +
'&user=' + USER +
'&pass=' + PASSWORD +
'&responseVariable=variableNameToSaveResponseTo' +
'&templatePath=httpBodyGetHeadDataByDemoVariables.json' +
'&customVariables=[%5B' + 'custom_variable_name=' + demoVariable + ',custom_variable_name_two=' + demoVariableTwo + ']%5D',
type: 'GET',
}).done(function(data){
//todo!
}).success(function(data) {
//todo!
}).fail(function(data) { //Error Handling }); |
...