Get the automation catalog
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema', 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://{companyName}.api.joinluminous.com/external/api/v1/automations/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{companyName}.api.joinluminous.com/external/api/v1/automations/schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"statuses": [
"active",
"paused",
"error"
],
"default_status": "paused",
"models": [
"order",
"invoice",
"fulfillment_order",
"supplier_purchase_order",
"supplier_purchase_order_shipment",
"transfer_order",
"order_item",
"oms_product",
"rfq",
"assembly_order",
"approval",
"work_order",
"production_batch",
"supplier_receiving_report"
],
"triggers": [
{
"name": "order_updated",
"model": "order",
"manually_triggerable": true
}
],
"conditions": [
{
"type": "field"
}
],
"actions": [
{
"type": "update_column"
}
],
"pipeline": {
"initial_values": [
"now",
"today",
"yesterday",
"tomorrow",
"value"
],
"functions": [
"add_days",
"date_modify",
"upper"
]
},
"model_field_paths": {
"work_order": [
"status"
]
}
}
}{
"message": "<string>"
}Automations
Get the automation catalog
The catalog that rule writes are validated against: rule statuses, tester models, every trigger (with the model it runs on and whether the live tester can fire it), condition types, action types, value-pipeline initial values and functions, and the leaf field paths for each model.
manually_triggerable is false for events the tester cannot fire (daily, hourly,
receiving, shipment_created, deal_created, deal_stage_changed) and for
sku_mapping_completed / sku_mapping_failed, which need extra context. Pipeline function names
are snake_case; the camelCase form (addDays) is also accepted.
When per-user permissions are enabled, the token’s owner needs automationRules.read (the same permission as the Automations page); otherwise 403.
GET
/
automations
/
schema
Get the automation catalog
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema', 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://{companyName}.api.joinluminous.com/external/api/v1/automations/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{companyName}.api.joinluminous.com/external/api/v1/automations/schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/automations/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"statuses": [
"active",
"paused",
"error"
],
"default_status": "paused",
"models": [
"order",
"invoice",
"fulfillment_order",
"supplier_purchase_order",
"supplier_purchase_order_shipment",
"transfer_order",
"order_item",
"oms_product",
"rfq",
"assembly_order",
"approval",
"work_order",
"production_batch",
"supplier_receiving_report"
],
"triggers": [
{
"name": "order_updated",
"model": "order",
"manually_triggerable": true
}
],
"conditions": [
{
"type": "field"
}
],
"actions": [
{
"type": "update_column"
}
],
"pipeline": {
"initial_values": [
"now",
"today",
"yesterday",
"tomorrow",
"value"
],
"functions": [
"add_days",
"date_modify",
"upper"
]
},
"model_field_paths": {
"work_order": [
"status"
]
}
}
}{
"message": "<string>"
}