Invoke an action from an Action Template
curl --request POST \
--url http://10.2.4.166:8080/composer/api/actions/{id}/invoke \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"startVisMessage": {
"cid": "<string>",
"tags": {},
"sourceId": "<string>",
"sourceName": "<string>",
"queries": [
"<unknown>"
],
"time": {
"timeField": "<string>",
"from": "<string>",
"to": "<string>"
},
"player": {
"stopTime": "<string>",
"speed": 123,
"pauseAfterRead": true
},
"ttl": 123,
"auditInfo": {
"dashboardId": "<string>",
"visualId": "<string>",
"formula": "<string>",
"expression": "<string>"
},
"composite": true
},
"fields": [
{
"field": {
"name": "<string>"
}
}
],
"postProcessingRawExpressions": [
{
"name": "<string>",
"expression": {
"path": {
"name": "<string>"
},
"value": "<unknown>"
}
}
],
"sorts": [
{
"field": {
"field": {
"name": "<string>"
}
}
}
],
"offset": 123,
"limit": 123
}
'import requests
url = "http://10.2.4.166:8080/composer/api/actions/{id}/invoke"
payload = {
"startVisMessage": {
"cid": "<string>",
"tags": {},
"sourceId": "<string>",
"sourceName": "<string>",
"queries": ["<unknown>"],
"time": {
"timeField": "<string>",
"from": "<string>",
"to": "<string>"
},
"player": {
"stopTime": "<string>",
"speed": 123,
"pauseAfterRead": True
},
"ttl": 123,
"auditInfo": {
"dashboardId": "<string>",
"visualId": "<string>",
"formula": "<string>",
"expression": "<string>"
},
"composite": True
},
"fields": [{ "field": { "name": "<string>" } }],
"postProcessingRawExpressions": [
{
"name": "<string>",
"expression": {
"path": { "name": "<string>" },
"value": "<unknown>"
}
}
],
"sorts": [{ "field": { "field": { "name": "<string>" } } }],
"offset": 123,
"limit": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
startVisMessage: {
cid: '<string>',
tags: {},
sourceId: '<string>',
sourceName: '<string>',
queries: ['<unknown>'],
time: {timeField: '<string>', from: '<string>', to: '<string>'},
player: {stopTime: '<string>', speed: 123, pauseAfterRead: true},
ttl: 123,
auditInfo: {
dashboardId: '<string>',
visualId: '<string>',
formula: '<string>',
expression: '<string>'
},
composite: true
},
fields: [{field: {name: '<string>'}}],
postProcessingRawExpressions: [{name: '<string>', expression: {path: {name: '<string>'}, value: '<unknown>'}}],
sorts: [{field: {field: {name: '<string>'}}}],
offset: 123,
limit: 123
})
};
fetch('http://10.2.4.166:8080/composer/api/actions/{id}/invoke', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/actions/{id}/invoke",
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([
'startVisMessage' => [
'cid' => '<string>',
'tags' => [
],
'sourceId' => '<string>',
'sourceName' => '<string>',
'queries' => [
'<unknown>'
],
'time' => [
'timeField' => '<string>',
'from' => '<string>',
'to' => '<string>'
],
'player' => [
'stopTime' => '<string>',
'speed' => 123,
'pauseAfterRead' => true
],
'ttl' => 123,
'auditInfo' => [
'dashboardId' => '<string>',
'visualId' => '<string>',
'formula' => '<string>',
'expression' => '<string>'
],
'composite' => true
],
'fields' => [
[
'field' => [
'name' => '<string>'
]
]
],
'postProcessingRawExpressions' => [
[
'name' => '<string>',
'expression' => [
'path' => [
'name' => '<string>'
],
'value' => '<unknown>'
]
]
],
'sorts' => [
[
'field' => [
'field' => [
'name' => '<string>'
]
]
]
],
'offset' => 123,
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/actions/{id}/invoke"
payload := strings.NewReader("{\n \"startVisMessage\": {\n \"cid\": \"<string>\",\n \"tags\": {},\n \"sourceId\": \"<string>\",\n \"sourceName\": \"<string>\",\n \"queries\": [\n \"<unknown>\"\n ],\n \"time\": {\n \"timeField\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"player\": {\n \"stopTime\": \"<string>\",\n \"speed\": 123,\n \"pauseAfterRead\": true\n },\n \"ttl\": 123,\n \"auditInfo\": {\n \"dashboardId\": \"<string>\",\n \"visualId\": \"<string>\",\n \"formula\": \"<string>\",\n \"expression\": \"<string>\"\n },\n \"composite\": true\n },\n \"fields\": [\n {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"postProcessingRawExpressions\": [\n {\n \"name\": \"<string>\",\n \"expression\": {\n \"path\": {\n \"name\": \"<string>\"\n },\n \"value\": \"<unknown>\"\n }\n }\n ],\n \"sorts\": [\n {\n \"field\": {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n }\n ],\n \"offset\": 123,\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/actions/{id}/invoke")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"startVisMessage\": {\n \"cid\": \"<string>\",\n \"tags\": {},\n \"sourceId\": \"<string>\",\n \"sourceName\": \"<string>\",\n \"queries\": [\n \"<unknown>\"\n ],\n \"time\": {\n \"timeField\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"player\": {\n \"stopTime\": \"<string>\",\n \"speed\": 123,\n \"pauseAfterRead\": true\n },\n \"ttl\": 123,\n \"auditInfo\": {\n \"dashboardId\": \"<string>\",\n \"visualId\": \"<string>\",\n \"formula\": \"<string>\",\n \"expression\": \"<string>\"\n },\n \"composite\": true\n },\n \"fields\": [\n {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"postProcessingRawExpressions\": [\n {\n \"name\": \"<string>\",\n \"expression\": {\n \"path\": {\n \"name\": \"<string>\"\n },\n \"value\": \"<unknown>\"\n }\n }\n ],\n \"sorts\": [\n {\n \"field\": {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n }\n ],\n \"offset\": 123,\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/actions/{id}/invoke")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"startVisMessage\": {\n \"cid\": \"<string>\",\n \"tags\": {},\n \"sourceId\": \"<string>\",\n \"sourceName\": \"<string>\",\n \"queries\": [\n \"<unknown>\"\n ],\n \"time\": {\n \"timeField\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"player\": {\n \"stopTime\": \"<string>\",\n \"speed\": 123,\n \"pauseAfterRead\": true\n },\n \"ttl\": 123,\n \"auditInfo\": {\n \"dashboardId\": \"<string>\",\n \"visualId\": \"<string>\",\n \"formula\": \"<string>\",\n \"expression\": \"<string>\"\n },\n \"composite\": true\n },\n \"fields\": [\n {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"postProcessingRawExpressions\": [\n {\n \"name\": \"<string>\",\n \"expression\": {\n \"path\": {\n \"name\": \"<string>\"\n },\n \"value\": \"<unknown>\"\n }\n }\n ],\n \"sorts\": [\n {\n \"field\": {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n }\n ],\n \"offset\": 123,\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_bodyInvoke an action from an Action Template
Invoke an action from an Action Template
curl --request POST \
--url http://10.2.4.166:8080/composer/api/actions/{id}/invoke \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"startVisMessage": {
"cid": "<string>",
"tags": {},
"sourceId": "<string>",
"sourceName": "<string>",
"queries": [
"<unknown>"
],
"time": {
"timeField": "<string>",
"from": "<string>",
"to": "<string>"
},
"player": {
"stopTime": "<string>",
"speed": 123,
"pauseAfterRead": true
},
"ttl": 123,
"auditInfo": {
"dashboardId": "<string>",
"visualId": "<string>",
"formula": "<string>",
"expression": "<string>"
},
"composite": true
},
"fields": [
{
"field": {
"name": "<string>"
}
}
],
"postProcessingRawExpressions": [
{
"name": "<string>",
"expression": {
"path": {
"name": "<string>"
},
"value": "<unknown>"
}
}
],
"sorts": [
{
"field": {
"field": {
"name": "<string>"
}
}
}
],
"offset": 123,
"limit": 123
}
'import requests
url = "http://10.2.4.166:8080/composer/api/actions/{id}/invoke"
payload = {
"startVisMessage": {
"cid": "<string>",
"tags": {},
"sourceId": "<string>",
"sourceName": "<string>",
"queries": ["<unknown>"],
"time": {
"timeField": "<string>",
"from": "<string>",
"to": "<string>"
},
"player": {
"stopTime": "<string>",
"speed": 123,
"pauseAfterRead": True
},
"ttl": 123,
"auditInfo": {
"dashboardId": "<string>",
"visualId": "<string>",
"formula": "<string>",
"expression": "<string>"
},
"composite": True
},
"fields": [{ "field": { "name": "<string>" } }],
"postProcessingRawExpressions": [
{
"name": "<string>",
"expression": {
"path": { "name": "<string>" },
"value": "<unknown>"
}
}
],
"sorts": [{ "field": { "field": { "name": "<string>" } } }],
"offset": 123,
"limit": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
startVisMessage: {
cid: '<string>',
tags: {},
sourceId: '<string>',
sourceName: '<string>',
queries: ['<unknown>'],
time: {timeField: '<string>', from: '<string>', to: '<string>'},
player: {stopTime: '<string>', speed: 123, pauseAfterRead: true},
ttl: 123,
auditInfo: {
dashboardId: '<string>',
visualId: '<string>',
formula: '<string>',
expression: '<string>'
},
composite: true
},
fields: [{field: {name: '<string>'}}],
postProcessingRawExpressions: [{name: '<string>', expression: {path: {name: '<string>'}, value: '<unknown>'}}],
sorts: [{field: {field: {name: '<string>'}}}],
offset: 123,
limit: 123
})
};
fetch('http://10.2.4.166:8080/composer/api/actions/{id}/invoke', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/actions/{id}/invoke",
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([
'startVisMessage' => [
'cid' => '<string>',
'tags' => [
],
'sourceId' => '<string>',
'sourceName' => '<string>',
'queries' => [
'<unknown>'
],
'time' => [
'timeField' => '<string>',
'from' => '<string>',
'to' => '<string>'
],
'player' => [
'stopTime' => '<string>',
'speed' => 123,
'pauseAfterRead' => true
],
'ttl' => 123,
'auditInfo' => [
'dashboardId' => '<string>',
'visualId' => '<string>',
'formula' => '<string>',
'expression' => '<string>'
],
'composite' => true
],
'fields' => [
[
'field' => [
'name' => '<string>'
]
]
],
'postProcessingRawExpressions' => [
[
'name' => '<string>',
'expression' => [
'path' => [
'name' => '<string>'
],
'value' => '<unknown>'
]
]
],
'sorts' => [
[
'field' => [
'field' => [
'name' => '<string>'
]
]
]
],
'offset' => 123,
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/actions/{id}/invoke"
payload := strings.NewReader("{\n \"startVisMessage\": {\n \"cid\": \"<string>\",\n \"tags\": {},\n \"sourceId\": \"<string>\",\n \"sourceName\": \"<string>\",\n \"queries\": [\n \"<unknown>\"\n ],\n \"time\": {\n \"timeField\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"player\": {\n \"stopTime\": \"<string>\",\n \"speed\": 123,\n \"pauseAfterRead\": true\n },\n \"ttl\": 123,\n \"auditInfo\": {\n \"dashboardId\": \"<string>\",\n \"visualId\": \"<string>\",\n \"formula\": \"<string>\",\n \"expression\": \"<string>\"\n },\n \"composite\": true\n },\n \"fields\": [\n {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"postProcessingRawExpressions\": [\n {\n \"name\": \"<string>\",\n \"expression\": {\n \"path\": {\n \"name\": \"<string>\"\n },\n \"value\": \"<unknown>\"\n }\n }\n ],\n \"sorts\": [\n {\n \"field\": {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n }\n ],\n \"offset\": 123,\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/actions/{id}/invoke")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"startVisMessage\": {\n \"cid\": \"<string>\",\n \"tags\": {},\n \"sourceId\": \"<string>\",\n \"sourceName\": \"<string>\",\n \"queries\": [\n \"<unknown>\"\n ],\n \"time\": {\n \"timeField\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"player\": {\n \"stopTime\": \"<string>\",\n \"speed\": 123,\n \"pauseAfterRead\": true\n },\n \"ttl\": 123,\n \"auditInfo\": {\n \"dashboardId\": \"<string>\",\n \"visualId\": \"<string>\",\n \"formula\": \"<string>\",\n \"expression\": \"<string>\"\n },\n \"composite\": true\n },\n \"fields\": [\n {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"postProcessingRawExpressions\": [\n {\n \"name\": \"<string>\",\n \"expression\": {\n \"path\": {\n \"name\": \"<string>\"\n },\n \"value\": \"<unknown>\"\n }\n }\n ],\n \"sorts\": [\n {\n \"field\": {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n }\n ],\n \"offset\": 123,\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/actions/{id}/invoke")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"startVisMessage\": {\n \"cid\": \"<string>\",\n \"tags\": {},\n \"sourceId\": \"<string>\",\n \"sourceName\": \"<string>\",\n \"queries\": [\n \"<unknown>\"\n ],\n \"time\": {\n \"timeField\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"player\": {\n \"stopTime\": \"<string>\",\n \"speed\": 123,\n \"pauseAfterRead\": true\n },\n \"ttl\": 123,\n \"auditInfo\": {\n \"dashboardId\": \"<string>\",\n \"visualId\": \"<string>\",\n \"formula\": \"<string>\",\n \"expression\": \"<string>\"\n },\n \"composite\": true\n },\n \"fields\": [\n {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"postProcessingRawExpressions\": [\n {\n \"name\": \"<string>\",\n \"expression\": {\n \"path\": {\n \"name\": \"<string>\"\n },\n \"value\": \"<unknown>\"\n }\n }\n ],\n \"sorts\": [\n {\n \"field\": {\n \"field\": {\n \"name\": \"<string>\"\n }\n }\n }\n ],\n \"offset\": 123,\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
HTTP Basic authentication using global administrator credentials (username and password).
Path Parameters
Body
application/vnd.composer.v3+json
Raw Data Request By Start Vis Resource
Response
204
No Content
Was this page helpful?