Preview Group Import
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/imports/group/preview \
--header 'Content-Type: application/json' \
--data '
{
"importable_id": 123,
"group_definition_id": 123
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/imports/group/preview"
payload = {
"importable_id": 123,
"group_definition_id": 123
}
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({importable_id: 123, group_definition_id: 123})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/imports/group/preview', 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.{tenant}.getomneo.com/api/v3/imports/group/preview",
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([
'importable_id' => 123,
'group_definition_id' => 123
]),
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://api.{tenant}.getomneo.com/api/v3/imports/group/preview"
payload := strings.NewReader("{\n \"importable_id\": 123,\n \"group_definition_id\": 123\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://api.{tenant}.getomneo.com/api/v3/imports/group/preview")
.header("Content-Type", "application/json")
.body("{\n \"importable_id\": 123,\n \"group_definition_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/imports/group/preview")
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 \"importable_id\": 123,\n \"group_definition_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"group": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"type": "<string>"
},
"latest_snapshot": {
"id": 123,
"group_definition_id": 123,
"status": "<string>",
"source": "<string>",
"baseline_snapshot_id": 123,
"snapshot_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"failed_at": "<string>",
"error": "<string>",
"total_candidates": 123,
"total_excluded": 123,
"total_profiles": 123,
"total_added": 123,
"total_removed": 123,
"progress": {
"streams_done": 123,
"streams_total": 123
},
"events_dispatched_at": "<string>",
"inclusion_breakdown": [
"<unknown>"
],
"exclusion_breakdown": [
"<unknown>"
],
"duration_ms": 123,
"meta": [
"<unknown>"
],
"created_at": "<string>",
"updated_at": "<string>"
},
"calculated_rules": 123,
"members": 123,
"already_holding": 123,
"will_receive": 123,
"expiry": {
"period": 123,
"period_type": "<string>",
"absolute_expiry": "<string>",
"ignores_condition": true,
"ignores_auto_extend": true
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Group Import
Preview Group Import
A POST to the /imports/group/preview endpoint shows who would receive a reward or benefit definition if it were issued to a group now: the group’s members (a dynamic group’s last completed refresh, a static group’s current members), how many already hold an unexpired one, and how many would receive it. expiry is what an issue with no expiry of its own takes, the definition’s fixed period: an import never applies the definition’s expiry condition or the tenant’s reward_extend rule, and ignores_condition / ignores_auto_extend say when one is configured.
POST
/
v3
/
imports
/
group
/
preview
Preview Group Import
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/imports/group/preview \
--header 'Content-Type: application/json' \
--data '
{
"importable_id": 123,
"group_definition_id": 123
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/imports/group/preview"
payload = {
"importable_id": 123,
"group_definition_id": 123
}
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({importable_id: 123, group_definition_id: 123})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/imports/group/preview', 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.{tenant}.getomneo.com/api/v3/imports/group/preview",
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([
'importable_id' => 123,
'group_definition_id' => 123
]),
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://api.{tenant}.getomneo.com/api/v3/imports/group/preview"
payload := strings.NewReader("{\n \"importable_id\": 123,\n \"group_definition_id\": 123\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://api.{tenant}.getomneo.com/api/v3/imports/group/preview")
.header("Content-Type", "application/json")
.body("{\n \"importable_id\": 123,\n \"group_definition_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/imports/group/preview")
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 \"importable_id\": 123,\n \"group_definition_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"group": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"type": "<string>"
},
"latest_snapshot": {
"id": 123,
"group_definition_id": 123,
"status": "<string>",
"source": "<string>",
"baseline_snapshot_id": 123,
"snapshot_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"failed_at": "<string>",
"error": "<string>",
"total_candidates": 123,
"total_excluded": 123,
"total_profiles": 123,
"total_added": 123,
"total_removed": 123,
"progress": {
"streams_done": 123,
"streams_total": 123
},
"events_dispatched_at": "<string>",
"inclusion_breakdown": [
"<unknown>"
],
"exclusion_breakdown": [
"<unknown>"
],
"duration_ms": 123,
"meta": [
"<unknown>"
],
"created_at": "<string>",
"updated_at": "<string>"
},
"calculated_rules": 123,
"members": 123,
"already_holding": 123,
"will_receive": 123,
"expiry": {
"period": 123,
"period_type": "<string>",
"absolute_expiry": "<string>",
"ignores_condition": true,
"ignores_auto_extend": true
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}