Validar blocos de template
curl --request POST \
--url https://reporter.sandbox.lerian.net/v1/templates/validate \
--header 'Content-Type: application/json' \
--header 'X-Organization-id: <x-organization-id>' \
--data '
{
"blocks": [
{
"type": "loop",
"collection": "accounts",
"iterator": "account",
"children": [
{
"type": "field",
"field": "account.name"
}
]
}
]
}
'import requests
url = "https://reporter.sandbox.lerian.net/v1/templates/validate"
payload = { "blocks": [
{
"type": "loop",
"collection": "accounts",
"iterator": "account",
"children": [
{
"type": "field",
"field": "account.name"
}
]
}
] }
headers = {
"X-Organization-id": "<x-organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Organization-id': '<x-organization-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
blocks: [
{
type: 'loop',
collection: 'accounts',
iterator: 'account',
children: [{type: 'field', field: 'account.name'}]
}
]
})
};
fetch('https://reporter.sandbox.lerian.net/v1/templates/validate', 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://reporter.sandbox.lerian.net/v1/templates/validate",
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([
'blocks' => [
[
'type' => 'loop',
'collection' => 'accounts',
'iterator' => 'account',
'children' => [
[
'type' => 'field',
'field' => 'account.name'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Organization-id: <x-organization-id>"
],
]);
$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://reporter.sandbox.lerian.net/v1/templates/validate"
payload := strings.NewReader("{\n \"blocks\": [\n {\n \"type\": \"loop\",\n \"collection\": \"accounts\",\n \"iterator\": \"account\",\n \"children\": [\n {\n \"type\": \"field\",\n \"field\": \"account.name\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Organization-id", "<x-organization-id>")
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://reporter.sandbox.lerian.net/v1/templates/validate")
.header("X-Organization-id", "<x-organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"blocks\": [\n {\n \"type\": \"loop\",\n \"collection\": \"accounts\",\n \"iterator\": \"account\",\n \"children\": [\n {\n \"type\": \"field\",\n \"field\": \"account.name\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://reporter.sandbox.lerian.net/v1/templates/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Organization-id"] = '<x-organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"blocks\": [\n {\n \"type\": \"loop\",\n \"collection\": \"accounts\",\n \"iterator\": \"account\",\n \"children\": [\n {\n \"type\": \"field\",\n \"field\": \"account.name\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"valid": false,
"errors": [
{
"blockId": "block-2",
"field": "collection",
"message": "collection is required for loop blocks"
}
]
}Validar blocos de template
Use este endpoint para validar uma sequência de blocos de template antes de salvar um template.
Os problemas de validação são retornados na resposta 200 com valid definido como false e uma lista de mensagens por bloco. O código HTTP 400 é reservado para um corpo de requisição malformado.
POST
/
v1
/
templates
/
validate
Validar blocos de template
curl --request POST \
--url https://reporter.sandbox.lerian.net/v1/templates/validate \
--header 'Content-Type: application/json' \
--header 'X-Organization-id: <x-organization-id>' \
--data '
{
"blocks": [
{
"type": "loop",
"collection": "accounts",
"iterator": "account",
"children": [
{
"type": "field",
"field": "account.name"
}
]
}
]
}
'import requests
url = "https://reporter.sandbox.lerian.net/v1/templates/validate"
payload = { "blocks": [
{
"type": "loop",
"collection": "accounts",
"iterator": "account",
"children": [
{
"type": "field",
"field": "account.name"
}
]
}
] }
headers = {
"X-Organization-id": "<x-organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Organization-id': '<x-organization-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
blocks: [
{
type: 'loop',
collection: 'accounts',
iterator: 'account',
children: [{type: 'field', field: 'account.name'}]
}
]
})
};
fetch('https://reporter.sandbox.lerian.net/v1/templates/validate', 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://reporter.sandbox.lerian.net/v1/templates/validate",
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([
'blocks' => [
[
'type' => 'loop',
'collection' => 'accounts',
'iterator' => 'account',
'children' => [
[
'type' => 'field',
'field' => 'account.name'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Organization-id: <x-organization-id>"
],
]);
$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://reporter.sandbox.lerian.net/v1/templates/validate"
payload := strings.NewReader("{\n \"blocks\": [\n {\n \"type\": \"loop\",\n \"collection\": \"accounts\",\n \"iterator\": \"account\",\n \"children\": [\n {\n \"type\": \"field\",\n \"field\": \"account.name\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Organization-id", "<x-organization-id>")
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://reporter.sandbox.lerian.net/v1/templates/validate")
.header("X-Organization-id", "<x-organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"blocks\": [\n {\n \"type\": \"loop\",\n \"collection\": \"accounts\",\n \"iterator\": \"account\",\n \"children\": [\n {\n \"type\": \"field\",\n \"field\": \"account.name\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://reporter.sandbox.lerian.net/v1/templates/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Organization-id"] = '<x-organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"blocks\": [\n {\n \"type\": \"loop\",\n \"collection\": \"accounts\",\n \"iterator\": \"account\",\n \"children\": [\n {\n \"type\": \"field\",\n \"field\": \"account.name\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"valid": false,
"errors": [
{
"blockId": "block-2",
"field": "collection",
"message": "collection is required for loop blocks"
}
]
}Cabeçalhos
O token de autorização no formato 'Bearer '.
Importante: Este header é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.
O identificador único da Organização associada à requisição.
Corpo
application/json
Os blocos de template a validar.
Esta página foi útil?
⌘I

