Create a model builder
curl --request POST \
--url https://api.ionworks.com/model_builders \
--header 'Content-Type: application/json' \
--data '
{
"model_id": "<string>",
"project_id": "<string>",
"name": "<string>",
"config": {},
"description": "<string>"
}
'import requests
url = "https://api.ionworks.com/model_builders"
payload = {
"model_id": "<string>",
"project_id": "<string>",
"name": "<string>",
"config": {},
"description": "<string>"
}
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({
model_id: '<string>',
project_id: '<string>',
name: '<string>',
config: {},
description: '<string>'
})
};
fetch('https://api.ionworks.com/model_builders', 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.ionworks.com/model_builders",
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([
'model_id' => '<string>',
'project_id' => '<string>',
'name' => '<string>',
'config' => [
],
'description' => '<string>'
]),
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.ionworks.com/model_builders"
payload := strings.NewReader("{\n \"model_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"description\": \"<string>\"\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.ionworks.com/model_builders")
.header("Content-Type", "application/json")
.body("{\n \"model_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/model_builders")
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 \"model_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"model_id": "<string>",
"name": "<string>",
"config": {},
"description": "<string>",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Model builders
Create a model builder
Create a builder whose config is a pipeline of entry and calculation elements.
Create a model builder
curl --request POST \
--url https://api.ionworks.com/model_builders \
--header 'Content-Type: application/json' \
--data '
{
"model_id": "<string>",
"project_id": "<string>",
"name": "<string>",
"config": {},
"description": "<string>"
}
'import requests
url = "https://api.ionworks.com/model_builders"
payload = {
"model_id": "<string>",
"project_id": "<string>",
"name": "<string>",
"config": {},
"description": "<string>"
}
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({
model_id: '<string>',
project_id: '<string>',
name: '<string>',
config: {},
description: '<string>'
})
};
fetch('https://api.ionworks.com/model_builders', 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.ionworks.com/model_builders",
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([
'model_id' => '<string>',
'project_id' => '<string>',
'name' => '<string>',
'config' => [
],
'description' => '<string>'
]),
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.ionworks.com/model_builders"
payload := strings.NewReader("{\n \"model_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"description\": \"<string>\"\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.ionworks.com/model_builders")
.header("Content-Type", "application/json")
.body("{\n \"model_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/model_builders")
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 \"model_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {},\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"model_id": "<string>",
"name": "<string>",
"config": {},
"description": "<string>",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Body for creating a model builder.
Model the builder produces parameters for.
Project the builder belongs to; names are unique per project.
Minimum string length:
1An ionworks_schema Pipeline config (Pipeline(...).to_config()) of entry and calculation elements. An entry that reads the cell spec is a DirectEntry cell spec entry without its cell_spec_id: {'element_type': 'entry', 'mapping': {parameter: 'dotted.path'}}.
Response
Successful Response
A model_builders row.
Pipeline config of entry and calculation elements.
Was this page helpful?