Get check entities
curl --request POST \
--url https://backstage.example.com/api/soundcheck/checks/entities \
--header 'Content-Type: application/json' \
--data '
{
"checkId": "<string>",
"trackId": "<string>",
"states": [],
"entityFilter": {},
"limit": 100,
"offset": 0
}
'import requests
url = "https://backstage.example.com/api/soundcheck/checks/entities"
payload = {
"checkId": "<string>",
"trackId": "<string>",
"states": [],
"entityFilter": {},
"limit": 100,
"offset": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
checkId: '<string>',
trackId: '<string>',
states: [],
entityFilter: {},
limit: 100,
offset: 0
})
};
fetch('https://backstage.example.com/api/soundcheck/checks/entities', 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://backstage.example.com/api/soundcheck/checks/entities",
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([
'checkId' => '<string>',
'trackId' => '<string>',
'states' => [
],
'entityFilter' => [
],
'limit' => 100,
'offset' => 0
]),
CURLOPT_HTTPHEADER => [
"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://backstage.example.com/api/soundcheck/checks/entities"
payload := strings.NewReader("{\n \"checkId\": \"<string>\",\n \"trackId\": \"<string>\",\n \"states\": [],\n \"entityFilter\": {},\n \"limit\": 100,\n \"offset\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
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://backstage.example.com/api/soundcheck/checks/entities")
.header("Content-Type", "application/json")
.body("{\n \"checkId\": \"<string>\",\n \"trackId\": \"<string>\",\n \"states\": [],\n \"entityFilter\": {},\n \"limit\": 100,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backstage.example.com/api/soundcheck/checks/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"checkId\": \"<string>\",\n \"trackId\": \"<string>\",\n \"states\": [],\n \"entityFilter\": {},\n \"limit\": 100,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"totalCount": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
},
"edges": [
{
"node": {
"entityRef": "<string>",
"state": "passed",
"hasError": true,
"details": {}
}
}
]
}{
"error": {
"name": "<string>",
"message": "<string>"
},
"response": {
"statusCode": 123
},
"request": {
"method": "<string>",
"url": "<string>"
}
}"<string>"{
"error": {
"name": "<string>",
"message": "<string>"
},
"response": {
"statusCode": 123
},
"request": {
"method": "<string>",
"url": "<string>"
}
}Checks
Get check entities
Get a paginated list of entities applicable to a check, each annotated with its check result state. Optionally scoped to a track, and filtered by result state and/or an entity filter.
POST
/
checks
/
entities
Get check entities
curl --request POST \
--url https://backstage.example.com/api/soundcheck/checks/entities \
--header 'Content-Type: application/json' \
--data '
{
"checkId": "<string>",
"trackId": "<string>",
"states": [],
"entityFilter": {},
"limit": 100,
"offset": 0
}
'import requests
url = "https://backstage.example.com/api/soundcheck/checks/entities"
payload = {
"checkId": "<string>",
"trackId": "<string>",
"states": [],
"entityFilter": {},
"limit": 100,
"offset": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
checkId: '<string>',
trackId: '<string>',
states: [],
entityFilter: {},
limit: 100,
offset: 0
})
};
fetch('https://backstage.example.com/api/soundcheck/checks/entities', 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://backstage.example.com/api/soundcheck/checks/entities",
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([
'checkId' => '<string>',
'trackId' => '<string>',
'states' => [
],
'entityFilter' => [
],
'limit' => 100,
'offset' => 0
]),
CURLOPT_HTTPHEADER => [
"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://backstage.example.com/api/soundcheck/checks/entities"
payload := strings.NewReader("{\n \"checkId\": \"<string>\",\n \"trackId\": \"<string>\",\n \"states\": [],\n \"entityFilter\": {},\n \"limit\": 100,\n \"offset\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
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://backstage.example.com/api/soundcheck/checks/entities")
.header("Content-Type", "application/json")
.body("{\n \"checkId\": \"<string>\",\n \"trackId\": \"<string>\",\n \"states\": [],\n \"entityFilter\": {},\n \"limit\": 100,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backstage.example.com/api/soundcheck/checks/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"checkId\": \"<string>\",\n \"trackId\": \"<string>\",\n \"states\": [],\n \"entityFilter\": {},\n \"limit\": 100,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"totalCount": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
},
"edges": [
{
"node": {
"entityRef": "<string>",
"state": "passed",
"hasError": true,
"details": {}
}
}
]
}{
"error": {
"name": "<string>",
"message": "<string>"
},
"response": {
"statusCode": 123
},
"request": {
"method": "<string>",
"url": "<string>"
}
}"<string>"{
"error": {
"name": "<string>",
"message": "<string>"
},
"response": {
"statusCode": 123
},
"request": {
"method": "<string>",
"url": "<string>"
}
}Body
application/json
Minimum string length:
1Pattern:
^[a-zA-Z0-9._-]+$Scopes applicability and filters to this track.
Available options:
passed, failed, warning, not-applicable, not-reported, exempt, error - object
- object[]
Show child attributes
Show child attributes
Maximum number of entities to return. Defaults to 100, max 5000.
Required range:
1 <= x <= 5000Number of entities to skip. Defaults to 0.
Required range:
x >= 0