Skip to main content
PUT
/
v3
/
groups
/
rule-definitions
/
{ruleDefinition}
cURL
curl --request PUT \
  --url https://api.{tenant}.getomneo.com/api/v3/groups/rule-definitions/{ruleDefinition} \
  --header 'Content-Type: application/json' \
  --data '
{
  "handle": "<string>",
  "name": "<string>",
  "description": "<string>",
  "evaluator": "jsonlogic",
  "rule": [
    "<string>"
  ],
  "default_arguments": [
    "<string>"
  ],
  "context_requirements": [
    "<string>"
  ],
  "meta": [
    "<string>"
  ],
  "is_active": true
}
'
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/groups/rule-definitions/{ruleDefinition}"

payload = {
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"evaluator": "jsonlogic",
"rule": ["<string>"],
"default_arguments": ["<string>"],
"context_requirements": ["<string>"],
"meta": ["<string>"],
"is_active": True
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
handle: '<string>',
name: '<string>',
description: '<string>',
evaluator: 'jsonlogic',
rule: ['<string>'],
default_arguments: ['<string>'],
context_requirements: ['<string>'],
meta: ['<string>'],
is_active: true
})
};

fetch('https://api.{tenant}.getomneo.com/api/v3/groups/rule-definitions/{ruleDefinition}', 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/groups/rule-definitions/{ruleDefinition}",
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([
'handle' => '<string>',
'name' => '<string>',
'description' => '<string>',
'evaluator' => 'jsonlogic',
'rule' => [
'<string>'
],
'default_arguments' => [
'<string>'
],
'context_requirements' => [
'<string>'
],
'meta' => [
'<string>'
],
'is_active' => true
]),
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/groups/rule-definitions/{ruleDefinition}"

payload := strings.NewReader("{\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"evaluator\": \"jsonlogic\",\n \"rule\": [\n \"<string>\"\n ],\n \"default_arguments\": [\n \"<string>\"\n ],\n \"context_requirements\": [\n \"<string>\"\n ],\n \"meta\": [\n \"<string>\"\n ],\n \"is_active\": true\n}")

req, _ := http.NewRequest("PUT", 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.put("https://api.{tenant}.getomneo.com/api/v3/groups/rule-definitions/{ruleDefinition}")
.header("Content-Type", "application/json")
.body("{\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"evaluator\": \"jsonlogic\",\n \"rule\": [\n \"<string>\"\n ],\n \"default_arguments\": [\n \"<string>\"\n ],\n \"context_requirements\": [\n \"<string>\"\n ],\n \"meta\": [\n \"<string>\"\n ],\n \"is_active\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/groups/rule-definitions/{ruleDefinition}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"evaluator\": \"jsonlogic\",\n \"rule\": [\n \"<string>\"\n ],\n \"default_arguments\": [\n \"<string>\"\n ],\n \"context_requirements\": [\n \"<string>\"\n ],\n \"meta\": [\n \"<string>\"\n ],\n \"is_active\": true\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": 123,
    "handle": "<string>",
    "name": "<string>",
    "description": "<string>",
    "evaluator": "<string>",
    "rule": [
      "<unknown>"
    ],
    "default_arguments": [
      "<unknown>"
    ],
    "context_requirements": [
      "<unknown>"
    ],
    "meta": [
      "<unknown>"
    ],
    "is_active": true,
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>",
"errors": {}
}

Path Parameters

ruleDefinition
integer
required

The rule definition ID

Body

application/json
handle
string
Maximum string length: 255
name
string
Maximum string length: 255
description
string | null
evaluator
enum<string>
Available options:
jsonlogic
rule
string[]
default_arguments
string[] | null
context_requirements
string[] | null
meta
string[] | null
is_active
boolean

Response

GroupRuleDefinition

data
GroupRuleDefinition · object
required