boards
Post organisations board instances trigger execution
Trigger a board to execute specific start-nodes.
POST
/
organisations
/
{organisationId}
/
board-instances
/
{boardId}
/
trigger-execution
cURL
curl --request POST \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"nodeIds": [
"<string>"
]
}
'import requests
url = "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution"
payload = { "nodeIds": ["<string>"] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({nodeIds: ['<string>']})
};
fetch('https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'nodeIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution"
payload := strings.NewReader("{\n \"nodeIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"nodeIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nodeIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"nodes": [
{
"ok": true,
"message": "<string>"
}
]
}{
"code": "<string>",
"message": "<string>",
"extensions": {}
}Body
application/json
TriggerBoardExecutionRequest is the payload to trigger a Board to be executed
Response
TriggerBoardExecutionResponse is returned after triggering a board to execute.
BoardTriggered is used to indicate if the trigger request has been accepted. The actual scheduling is done in the background and does not indicate the board has finished execution yet.
⌘I
cURL
curl --request POST \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"nodeIds": [
"<string>"
]
}
'import requests
url = "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution"
payload = { "nodeIds": ["<string>"] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({nodeIds: ['<string>']})
};
fetch('https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'nodeIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution"
payload := strings.NewReader("{\n \"nodeIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"nodeIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/board-instances/{boardId}/trigger-execution")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nodeIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"nodes": [
{
"ok": true,
"message": "<string>"
}
]
}{
"code": "<string>",
"message": "<string>",
"extensions": {}
}