Compile a policy document.
curl --request POST \
--url https://{workspace}.klef.ai/api/policies/compile \
--header 'Content-Type: application/json' \
--cookie klef.session= \
--data '
{
"source": "<string>",
"policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://{workspace}.klef.ai/api/policies/compile"
payload = {
"source": "<string>",
"policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"cookie": "klef.session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'klef.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({source: '<string>', policyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://{workspace}.klef.ai/api/policies/compile', 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://{workspace}.klef.ai/api/policies/compile",
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([
'source' => '<string>',
'policyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_COOKIE => "klef.session=",
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://{workspace}.klef.ai/api/policies/compile"
payload := strings.NewReader("{\n \"source\": \"<string>\",\n \"policyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "klef.session=")
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://{workspace}.klef.ai/api/policies/compile")
.header("cookie", "klef.session=")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"<string>\",\n \"policyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.klef.ai/api/policies/compile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'klef.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": \"<string>\",\n \"policyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"succeeded": true,
"diagnostics": [
{
"code": "<string>",
"severity": "error",
"message": "<string>",
"start": 123,
"end": 123,
"candidates": [
"<string>"
],
"unresolved": "segment"
}
],
"policy": {
"name": "<string>",
"category": "<string>",
"segmentId": "<string>",
"states": [
{
"stage": "pre_start",
"targets": [
{
"system": "adp_workforce_now",
"objectType": "<string>",
"maps": {}
}
],
"notifications": [
{
"name": "<string>",
"send": "once",
"content": {
"kind": "email",
"subject": "<string>",
"body": "<string>",
"title": "<string>",
"aggregation": "worker",
"recipients": [
{
"recipient": {
"kind": "path",
"key": "<string>"
},
"kind": "to"
}
]
}
}
]
}
]
},
"formatted": "<string>",
"edits": {
"values": {},
"entries": {},
"blocks": {}
}
},
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}Policies
Compile a policy document.
Checks the document against this workspace’s catalogs and returns what it means. A document with errors still compiles to whatever was understood, so an editor can show a half-written policy; nothing is saved either way.
POST
/
policies
/
compile
Compile a policy document.
curl --request POST \
--url https://{workspace}.klef.ai/api/policies/compile \
--header 'Content-Type: application/json' \
--cookie klef.session= \
--data '
{
"source": "<string>",
"policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://{workspace}.klef.ai/api/policies/compile"
payload = {
"source": "<string>",
"policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"cookie": "klef.session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'klef.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({source: '<string>', policyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://{workspace}.klef.ai/api/policies/compile', 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://{workspace}.klef.ai/api/policies/compile",
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([
'source' => '<string>',
'policyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_COOKIE => "klef.session=",
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://{workspace}.klef.ai/api/policies/compile"
payload := strings.NewReader("{\n \"source\": \"<string>\",\n \"policyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "klef.session=")
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://{workspace}.klef.ai/api/policies/compile")
.header("cookie", "klef.session=")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"<string>\",\n \"policyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.klef.ai/api/policies/compile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'klef.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": \"<string>\",\n \"policyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"succeeded": true,
"diagnostics": [
{
"code": "<string>",
"severity": "error",
"message": "<string>",
"start": 123,
"end": 123,
"candidates": [
"<string>"
],
"unresolved": "segment"
}
],
"policy": {
"name": "<string>",
"category": "<string>",
"segmentId": "<string>",
"states": [
{
"stage": "pre_start",
"targets": [
{
"system": "adp_workforce_now",
"objectType": "<string>",
"maps": {}
}
],
"notifications": [
{
"name": "<string>",
"send": "once",
"content": {
"kind": "email",
"subject": "<string>",
"body": "<string>",
"title": "<string>",
"aggregation": "worker",
"recipients": [
{
"recipient": {
"kind": "path",
"key": "<string>"
},
"kind": "to"
}
]
}
}
]
}
]
},
"formatted": "<string>",
"edits": {
"values": {},
"entries": {},
"blocks": {}
}
},
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}Authorizations
cookieAuthapiKeyAuth
Cookie-based session. Obtain by completing the /auth/login/{provider} OAuth flow; the /auth/callback response sets the klef.session cookie that subsequent requests send automatically.
Body
application/json
Response
OK
The envelope for a single-resource response: T? ApiResponse<T>.Result on success, otherwise null
with one or more IReadOnlyList<ApiError> ApiResponse<T>.Errors.
Was this page helpful?