ListEntityTypeDefs
curl --request POST \
--url https://developer.synq.io/api/entities/typedefs/v1/entity-types/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://developer.synq.io/api/entities/typedefs/v1/entity-types/list"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://developer.synq.io/api/entities/typedefs/v1/entity-types/list', 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://developer.synq.io/api/entities/typedefs/v1/entity-types/list",
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([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://developer.synq.io/api/entities/typedefs/v1/entity-types/list"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://developer.synq.io/api/entities/typedefs/v1/entity-types/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/typedefs/v1/entity-types/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"entityTypeDefs": [
{
"entityType": "ENTITY_TYPE_UNSPECIFIED",
"name": "<string>",
"shortName": "<string>",
"shortPluralName": "<string>",
"fullName": "<string>",
"fullPluralName": "<string>",
"description": "<string>",
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"traits": {
"flags": {},
"strings": {}
},
"typeId": 123
}
]
}synq.entities.typedefs.v1.TypeDefsService
ListEntityTypeDefs
List every kind of entity in your workspace, the built-in types and your own.
The built-in half covers every value of synq.entities.v1.EntityType this
server serves, so this is also how you discover a type that your generated code
is too old to name. Your own types have no enum value of their own — each one
is identified by its type_id.
POST
/
api
/
entities
/
typedefs
/
v1
/
entity-types
/
list
ListEntityTypeDefs
curl --request POST \
--url https://developer.synq.io/api/entities/typedefs/v1/entity-types/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://developer.synq.io/api/entities/typedefs/v1/entity-types/list"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://developer.synq.io/api/entities/typedefs/v1/entity-types/list', 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://developer.synq.io/api/entities/typedefs/v1/entity-types/list",
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([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://developer.synq.io/api/entities/typedefs/v1/entity-types/list"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://developer.synq.io/api/entities/typedefs/v1/entity-types/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/typedefs/v1/entity-types/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"entityTypeDefs": [
{
"entityType": "ENTITY_TYPE_UNSPECIFIED",
"name": "<string>",
"shortName": "<string>",
"shortPluralName": "<string>",
"fullName": "<string>",
"fullPluralName": "<string>",
"description": "<string>",
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"traits": {
"flags": {},
"strings": {}
},
"typeId": 123
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The body is of type ListEntityTypeDefsRequest · object.
Response
200 - application/json
Success
Every entity type in your workspace, built-in and your own, ordered by entity type value. Your own types sort together after the built-in ones, and two calls against an unchanged workspace return the same order.
Show child attributes
Show child attributes