List an organization's travel policy conditions
curl --request GET \
--url https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditionsimport requests
url = "https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions', 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://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"context": "TRAVEL",
"subjects": [
"AIR_TRIP"
],
"logic": [
"AND"
],
"operators": [
{
"operator": "GREATER_THAN",
"valueKind": "single",
"label": "maior que",
"description": "O campo é maior que o valor informado."
}
],
"fields": [
{
"field": "amount",
"type": "integer",
"operators": [
"EQUALS"
],
"viewOperator": [
"EQUALS"
],
"viewType": {
"type": "MONEY",
"prefix": "<string>",
"suffix": "<string>",
"options": [
{
"id": "PIX",
"label": "PIX",
"icon": "<string>"
}
],
"dynamicOptions": "WALLETS"
},
"label": "Valor",
"description": "Valor total da viagem, em centavos.",
"availability": "always",
"unit": "centavos",
"enumValues": [
"<string>"
],
"availabilityNote": "<string>",
"dateKind": "CALENDAR_DATE",
"customField": {
"id": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b",
"slug": "cost-center",
"type": "SELECT",
"required": false,
"entity": "transaction",
"location": "TRANSACTION",
"mask": "<string>"
}
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BUSINESS_POLICY_FORBIDDEN",
"origin": "RULE_ENGINE",
"message": "You do not have permission to manage business policies"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "RULE_ENGINE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "organizationId",
"message": "Invalid UUID",
"code": "ORGANIZATIONID_UUID"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "CUSTOM_FIELD_CATALOG_UNAVAILABLE",
"origin": "RULE_ENGINE",
"message": "Could not load the organization's custom fields — try again"
}List an organization's travel policy conditions
Lists the condition fields a TRAVEL business policy can use, with the operators and values each accepts.
GET
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
business-policies
/
travel-conditions
List an organization's travel policy conditions
curl --request GET \
--url https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditionsimport requests
url = "https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions', 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://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"context": "TRAVEL",
"subjects": [
"AIR_TRIP"
],
"logic": [
"AND"
],
"operators": [
{
"operator": "GREATER_THAN",
"valueKind": "single",
"label": "maior que",
"description": "O campo é maior que o valor informado."
}
],
"fields": [
{
"field": "amount",
"type": "integer",
"operators": [
"EQUALS"
],
"viewOperator": [
"EQUALS"
],
"viewType": {
"type": "MONEY",
"prefix": "<string>",
"suffix": "<string>",
"options": [
{
"id": "PIX",
"label": "PIX",
"icon": "<string>"
}
],
"dynamicOptions": "WALLETS"
},
"label": "Valor",
"description": "Valor total da viagem, em centavos.",
"availability": "always",
"unit": "centavos",
"enumValues": [
"<string>"
],
"availabilityNote": "<string>",
"dateKind": "CALENDAR_DATE",
"customField": {
"id": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b",
"slug": "cost-center",
"type": "SELECT",
"required": false,
"entity": "transaction",
"location": "TRANSACTION",
"mask": "<string>"
}
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BUSINESS_POLICY_FORBIDDEN",
"origin": "RULE_ENGINE",
"message": "You do not have permission to manage business policies"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "RULE_ENGINE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "organizationId",
"message": "Invalid UUID",
"code": "ORGANIZATIONID_UUID"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "CUSTOM_FIELD_CATALOG_UNAVAILABLE",
"origin": "RULE_ENGINE",
"message": "Could not load the organization's custom fields — try again"
}A
TRAVEL policy decides what happens when a flight or bus trip is sent for approval: approve it, deny it, or ask its approvals. This catalog is what its conditions are checked against on create and update: a field that is not listed here, an operator a field does not accept, or a value of the wrong type is refused.
Use it to build the condition editor of a policy that governs flight and bus trips: fields is the full list, operators describes every operator, and subjects names the trip types a policy can govern (AIR_TRIP, BUS_TRIP). Each field says whether every trip carries it (always) or only one kind of trip does (conditional, with a note saying which) — a condition on a field the trip does not carry is never true, whatever its operator.
The list ends with one field per active custom field of the organization that is used on trips (customFields.<slug>), in the order the organization created them. Each carries customField with its definition, so a client can group them apart from the fixed fields.
Fields that hold several values — the passengers, the cabin classes, the airlines, the bus service classes — match when ANY of them is one of the listed values (INCLUDES) or when NONE of them is (NOT_INCLUDES). Labels and descriptions are in Portuguese.
Any member of the organization can read the catalog.Path Parameters
ID of your realm.
Format: UUID
ID of the organization. Its active custom fields are added to the catalog.
Format: UUID
Response
Successful response
GET .../business-policies/travel-conditions response.
Always TRAVEL.
Available options:
TRAVEL Example:
"TRAVEL"
What a TRAVEL policy governs: AIR_TRIP (a flight) and BUS_TRIP (a bus trip).
Example: ["AIR_TRIP","BUS_TRIP"]
The values conditions.logic and each group's logic accept.
Example: ["AND","OR"]
Every operator, with the kind of value it takes.
Show child attributes
Show child attributes
Every field a condition can test: the fixed fields, then one per active custom field the organization uses on trips (text, number, boolean, date and selection custom fields only).
Show child attributes
Show child attributes