Dialog Launch Component
Uruchomienie komponentu na dialogu zestawionym
PUT /dialog/{dialog_uuid}/launch_component
URL Parameters
Nazwa | Rodzaj | Przykład | Opis |
---|---|---|---|
dialog_uuid | <STRING> |
a52cb58b-2442-4650-8ef8-4ca4dd78a390 | Identyfikator połączenia (dialogu) w systemie - Dialog Konsultanta |
Body
Nazwa | Rodzaj | Przykład | Opis |
---|---|---|---|
component_id | <STRING> |
5dc889d2f0od5469be07k82a | Identyfikator systemowy komponentu |
component_name | <STRING> |
Autentykacja1 | Nazwa komponentu |
input | <OBJECT> |
{"parameter_a": "xyz", "parameter_b": "abc"} | Ustawienie parametrów dla wykonywania aplikacji w kontekście local . W tym przypadku {local.parameter_a} i `{local |
.parameter_b} |
Response Body
{
"success": <BOOLEAN>
}
Nazwa | Rodzaj | Przykład | Opis |
---|---|---|---|
success | <BOOLEAN> |
True | Wykonano poprawnie. |
Response Code
Status | Opis |
---|---|
202 | Żądanie przyjęte do realizacji |
403 | Nie można wykonać takiej akcji |
404 | Nie znaleziono zasobu |
Example
curl -X PUT \
$CONPEEK_URL/dialog/a52cb58b-2442-4650-8ef8-4ca4dd78a390/launch_component \
-H 'Authorization: '$CONPEEK_KEY \
-H 'Content-Type: application/json' \
-d '{"component_id": "5dc889d2f0od5469be07k82a", "input": {"parameter_a": "xyz""}}'
import requests
import json
import os
from urllib import parse
url = parse.urljoin(os.environ["CONPEEK_URL"], "/dialog/%(dialog_uuid)s/launch_component" % {
"dialog_uuid": "a52cb58b-2442-4650-8ef8-4ca4dd78a390"
})
payload = {
"component_id": "5dc889d2f0od5469be07k82a",
"input": {
"parameter_a": "xyz"
}
}
headers = {
'Content-Type': "application/json",
'Authorization': os.environ["CONPEEK_KEY"]
}
response = requests.request("PUT", url, data=json.dumps(payload), headers=headers)
print(response.text)
<?php
$curl = curl_init();
$payload = array(
"component_id" => "5dc889d2f0od5469be07k82a",
"input" => array(
"parameter_a" => "xyz"
)
);
$dialog_uuid = "a52cb58b-2442-4650-8ef8-4ca4dd78a390";
curl_setopt_array($curl, array(
CURLOPT_URL => getenv("CONPEEK_URL")."/dialog/$dialog_uuid/launch_component",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_PUTFIELDS => json_encode($payload),
CURLOPT_HTTPHEADER => array(
"Authorization: ".getenv("CONPEEK_KEY"),
"Content-Type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Response
202 Accepted
{
"success": true
}