Search on visualization

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/stream/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "streamSourceId": "<string>",
  "fields": [
    "<string>"
  ],
  "restrictions": [
    {
      "sourceId": "<string>",
      "path": "<string>",
      "form": "<string>",
      "value": "<unknown>",
      "custom": {},
      "label": "<string>"
    }
  ],
  "query": "<string>",
  "sort": {
    "dir": "<string>",
    "name": "<string>",
    "metric": {
      "name": "<string>"
    }
  },
  "offset": 123,
  "pageSize": 123
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/stream/search"

payload = {
    "streamSourceId": "<string>",
    "fields": ["<string>"],
    "restrictions": [
        {
            "sourceId": "<string>",
            "path": "<string>",
            "form": "<string>",
            "value": "<unknown>",
            "custom": {},
            "label": "<string>"
        }
    ],
    "query": "<string>",
    "sort": {
        "dir": "<string>",
        "name": "<string>",
        "metric": { "name": "<string>" }
    },
    "offset": 123,
    "pageSize": 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({
    streamSourceId: '<string>',
    fields: ['<string>'],
    restrictions: [
      {
        sourceId: '<string>',
        path: '<string>',
        form: '<string>',
        value: '<unknown>',
        custom: {},
        label: '<string>'
      }
    ],
    query: '<string>',
    sort: {dir: '<string>', name: '<string>', metric: {name: '<string>'}},
    offset: 123,
    pageSize: 123
  })
};

fetch('http://10.2.4.166:8080/composer/api/stream/search', 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/stream/search",
  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([
    'streamSourceId' => '<string>',
    'fields' => [
        '<string>'
    ],
    'restrictions' => [
        [
                'sourceId' => '<string>',
                'path' => '<string>',
                'form' => '<string>',
                'value' => '<unknown>',
                'custom' => [
                                
                ],
                'label' => '<string>'
        ]
    ],
    'query' => '<string>',
    'sort' => [
        'dir' => '<string>',
        'name' => '<string>',
        'metric' => [
                'name' => '<string>'
        ]
    ],
    'offset' => 123,
    'pageSize' => 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/stream/search"

	payload := strings.NewReader("{\n  \"streamSourceId\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"restrictions\": [\n    {\n      \"sourceId\": \"<string>\",\n      \"path\": \"<string>\",\n      \"form\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"custom\": {},\n      \"label\": \"<string>\"\n    }\n  ],\n  \"query\": \"<string>\",\n  \"sort\": {\n    \"dir\": \"<string>\",\n    \"name\": \"<string>\",\n    \"metric\": {\n      \"name\": \"<string>\"\n    }\n  },\n  \"offset\": 123,\n  \"pageSize\": 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/stream/search")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"streamSourceId\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"restrictions\": [\n    {\n      \"sourceId\": \"<string>\",\n      \"path\": \"<string>\",\n      \"form\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"custom\": {},\n      \"label\": \"<string>\"\n    }\n  ],\n  \"query\": \"<string>\",\n  \"sort\": {\n    \"dir\": \"<string>\",\n    \"name\": \"<string>\",\n    \"metric\": {\n      \"name\": \"<string>\"\n    }\n  },\n  \"offset\": 123,\n  \"pageSize\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/stream/search")

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  \"streamSourceId\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"restrictions\": [\n    {\n      \"sourceId\": \"<string>\",\n      \"path\": \"<string>\",\n      \"form\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"custom\": {},\n      \"label\": \"<string>\"\n    }\n  ],\n  \"query\": \"<string>\",\n  \"sort\": {\n    \"dir\": \"<string>\",\n    \"name\": \"<string>\",\n    \"metric\": {\n      \"name\": \"<string>\"\n    }\n  },\n  \"offset\": 123,\n  \"pageSize\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "hasNext": true,
  "documents": [
    {}
  ],
  "totalCount": 123
}

Search on visualization

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/stream/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "streamSourceId": "<string>",
  "fields": [
    "<string>"
  ],
  "restrictions": [
    {
      "sourceId": "<string>",
      "path": "<string>",
      "form": "<string>",
      "value": "<unknown>",
      "custom": {},
      "label": "<string>"
    }
  ],
  "query": "<string>",
  "sort": {
    "dir": "<string>",
    "name": "<string>",
    "metric": {
      "name": "<string>"
    }
  },
  "offset": 123,
  "pageSize": 123
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/stream/search"

payload = {
    "streamSourceId": "<string>",
    "fields": ["<string>"],
    "restrictions": [
        {
            "sourceId": "<string>",
            "path": "<string>",
            "form": "<string>",
            "value": "<unknown>",
            "custom": {},
            "label": "<string>"
        }
    ],
    "query": "<string>",
    "sort": {
        "dir": "<string>",
        "name": "<string>",
        "metric": { "name": "<string>" }
    },
    "offset": 123,
    "pageSize": 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({
    streamSourceId: '<string>',
    fields: ['<string>'],
    restrictions: [
      {
        sourceId: '<string>',
        path: '<string>',
        form: '<string>',
        value: '<unknown>',
        custom: {},
        label: '<string>'
      }
    ],
    query: '<string>',
    sort: {dir: '<string>', name: '<string>', metric: {name: '<string>'}},
    offset: 123,
    pageSize: 123
  })
};

fetch('http://10.2.4.166:8080/composer/api/stream/search', 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/stream/search",
  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([
    'streamSourceId' => '<string>',
    'fields' => [
        '<string>'
    ],
    'restrictions' => [
        [
                'sourceId' => '<string>',
                'path' => '<string>',
                'form' => '<string>',
                'value' => '<unknown>',
                'custom' => [
                                
                ],
                'label' => '<string>'
        ]
    ],
    'query' => '<string>',
    'sort' => [
        'dir' => '<string>',
        'name' => '<string>',
        'metric' => [
                'name' => '<string>'
        ]
    ],
    'offset' => 123,
    'pageSize' => 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/stream/search"

	payload := strings.NewReader("{\n  \"streamSourceId\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"restrictions\": [\n    {\n      \"sourceId\": \"<string>\",\n      \"path\": \"<string>\",\n      \"form\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"custom\": {},\n      \"label\": \"<string>\"\n    }\n  ],\n  \"query\": \"<string>\",\n  \"sort\": {\n    \"dir\": \"<string>\",\n    \"name\": \"<string>\",\n    \"metric\": {\n      \"name\": \"<string>\"\n    }\n  },\n  \"offset\": 123,\n  \"pageSize\": 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/stream/search")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"streamSourceId\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"restrictions\": [\n    {\n      \"sourceId\": \"<string>\",\n      \"path\": \"<string>\",\n      \"form\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"custom\": {},\n      \"label\": \"<string>\"\n    }\n  ],\n  \"query\": \"<string>\",\n  \"sort\": {\n    \"dir\": \"<string>\",\n    \"name\": \"<string>\",\n    \"metric\": {\n      \"name\": \"<string>\"\n    }\n  },\n  \"offset\": 123,\n  \"pageSize\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/stream/search")

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  \"streamSourceId\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"restrictions\": [\n    {\n      \"sourceId\": \"<string>\",\n      \"path\": \"<string>\",\n      \"form\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"custom\": {},\n      \"label\": \"<string>\"\n    }\n  ],\n  \"query\": \"<string>\",\n  \"sort\": {\n    \"dir\": \"<string>\",\n    \"name\": \"<string>\",\n    \"metric\": {\n      \"name\": \"<string>\"\n    }\n  },\n  \"offset\": 123,\n  \"pageSize\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "hasNext": true,
  "documents": [
    {}
  ],
  "totalCount": 123
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Body

application/vnd.composer.v3+json

Visualization search request

streamSourceId

string

fields

string[]

restrictions

object[]

Show child attributes

query

string

sort

object

Sort configuration

Show child attributes

offset

integer<int32>

pageSize

integer<int32>

Response

200 - application/vnd.composer.v3+json

Source preview response

hasNext

boolean

documents

object[]

Show child attributes

totalCount

integer<int64>

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Search on visualization

Authorizations

Body

Response