Retenção e repasse
Definir retenção e repasse
Substitui as regras do override do evento
PUT
/
events
/
{event}
/
retention
Definir retenção e repasse
curl --request PUT \
--url http://localhost/api/v1/events/{event}/retention \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rules": [
{
"percent": 50,
"offset_days": 1825
}
]
}
'import requests
url = "http://localhost/api/v1/events/{event}/retention"
payload = { "rules": [
{
"percent": 50,
"offset_days": 1825
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({rules: [{percent: 50, offset_days: 1825}]})
};
fetch('http://localhost/api/v1/events/{event}/retention', 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 => "http://localhost/api/v1/events/{event}/retention",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'rules' => [
[
'percent' => 50,
'offset_days' => 1825
]
]
]),
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 := "http://localhost/api/v1/events/{event}/retention"
payload := strings.NewReader("{\n \"rules\": [\n {\n \"percent\": 50,\n \"offset_days\": 1825\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost/api/v1/events/{event}/retention")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rules\": [\n {\n \"percent\": 50,\n \"offset_days\": 1825\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost/api/v1/events/{event}/retention")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rules\": [\n {\n \"percent\": 50,\n \"offset_days\": 1825\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"hub_id": 123,
"event_id": 123,
"status": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"rules": [
{
"id": 123,
"percent": 123,
"anchor": "<string>",
"offset_days": 123
}
]
}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Authorizations
API key do hub com escopo manage. Header: Authorization: Bearer <api_key>.
Path Parameters
Body
application/json
PUT /api/v1/events/{event}/retention — substitui as regras do override do evento. As regras precisam somar 100% (validado no controller via RetentionPolicyWriter, que também aplica o piso de offset_days). Aqui só a estrutura de cada regra.
Minimum array length:
1Show child attributes
Show child attributes
Response
JsonResource
Show child attributes
Show child attributes
⌘I
Definir retenção e repasse
curl --request PUT \
--url http://localhost/api/v1/events/{event}/retention \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rules": [
{
"percent": 50,
"offset_days": 1825
}
]
}
'import requests
url = "http://localhost/api/v1/events/{event}/retention"
payload = { "rules": [
{
"percent": 50,
"offset_days": 1825
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({rules: [{percent: 50, offset_days: 1825}]})
};
fetch('http://localhost/api/v1/events/{event}/retention', 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 => "http://localhost/api/v1/events/{event}/retention",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'rules' => [
[
'percent' => 50,
'offset_days' => 1825
]
]
]),
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 := "http://localhost/api/v1/events/{event}/retention"
payload := strings.NewReader("{\n \"rules\": [\n {\n \"percent\": 50,\n \"offset_days\": 1825\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost/api/v1/events/{event}/retention")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rules\": [\n {\n \"percent\": 50,\n \"offset_days\": 1825\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost/api/v1/events/{event}/retention")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rules\": [\n {\n \"percent\": 50,\n \"offset_days\": 1825\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"hub_id": 123,
"event_id": 123,
"status": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"rules": [
{
"id": 123,
"percent": 123,
"anchor": "<string>",
"offset_days": 123
}
]
}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}