Create command
curl --request POST \
--url https://api.example.com/v1/commands \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commandType": {
"id": "<string>"
},
"parameters": "<string>"
}
'import requests
url = "https://api.example.com/v1/commands"
payload = {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commandType": { "id": "<string>" },
"parameters": "<string>"
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
commandType: {id: '<string>'},
parameters: '<string>'
})
};
fetch('https://api.example.com/v1/commands', 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://api.example.com/v1/commands",
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([
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'commandType' => [
'id' => '<string>'
],
'parameters' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+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://api.example.com/v1/commands"
payload := strings.NewReader("{\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commandType\": {\n \"id\": \"<string>\"\n },\n \"parameters\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+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://api.example.com/v1/commands")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commandType\": {\n \"id\": \"<string>\"\n },\n \"parameters\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/commands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commandType\": {\n \"id\": \"<string>\"\n },\n \"parameters\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"dashboard": {
"id": 123,
"name": "<string>",
"isDisabled": true,
"position": 123,
"path": "<string>",
"representations": "<array>"
},
"dataset": {
"id": 123,
"name": "<string>",
"isDisabled": true,
"position": 123,
"path": "<string>",
"states": [
{
"id": 123,
"dataset": "<unknown>",
"name": "<string>",
"color": 123,
"position": 123
}
],
"properties": [
{
"id": 123,
"dataset": "<unknown>",
"propertyType": {
"id": "<string>",
"isAutomatic": true,
"isPlural": true,
"isSortable": true,
"position": 123
},
"name": "<string>",
"isUsedAsTitle": true,
"isRequired": true,
"parameters": "<string>",
"position": 123,
"options": [
{
"id": 123,
"property": "<unknown>",
"text": "<string>",
"color": 123
}
]
}
],
"representations": "<array>"
},
"representationType": {
"id": "<string>",
"isAggregated": true,
"position": 123
},
"name": "<string>",
"parameters": "<string>",
"position": 123
}Commands
Create command
Creates a new command (and executes it via SignalR).
POST
/
v1
/
commands
Create command
curl --request POST \
--url https://api.example.com/v1/commands \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commandType": {
"id": "<string>"
},
"parameters": "<string>"
}
'import requests
url = "https://api.example.com/v1/commands"
payload = {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commandType": { "id": "<string>" },
"parameters": "<string>"
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
commandType: {id: '<string>'},
parameters: '<string>'
})
};
fetch('https://api.example.com/v1/commands', 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://api.example.com/v1/commands",
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([
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'commandType' => [
'id' => '<string>'
],
'parameters' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+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://api.example.com/v1/commands"
payload := strings.NewReader("{\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commandType\": {\n \"id\": \"<string>\"\n },\n \"parameters\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+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://api.example.com/v1/commands")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commandType\": {\n \"id\": \"<string>\"\n },\n \"parameters\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/commands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commandType\": {\n \"id\": \"<string>\"\n },\n \"parameters\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"dashboard": {
"id": 123,
"name": "<string>",
"isDisabled": true,
"position": 123,
"path": "<string>",
"representations": "<array>"
},
"dataset": {
"id": 123,
"name": "<string>",
"isDisabled": true,
"position": 123,
"path": "<string>",
"states": [
{
"id": 123,
"dataset": "<unknown>",
"name": "<string>",
"color": 123,
"position": 123
}
],
"properties": [
{
"id": 123,
"dataset": "<unknown>",
"propertyType": {
"id": "<string>",
"isAutomatic": true,
"isPlural": true,
"isSortable": true,
"position": 123
},
"name": "<string>",
"isUsedAsTitle": true,
"isRequired": true,
"parameters": "<string>",
"position": 123,
"options": [
{
"id": 123,
"property": "<unknown>",
"text": "<string>",
"color": 123
}
]
}
],
"representations": "<array>"
},
"representationType": {
"id": "<string>",
"isAggregated": true,
"position": 123
},
"name": "<string>",
"parameters": "<string>",
"position": 123
}Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
⌘I