Build a parameter set from a cell spec
curl --request POST \
--url https://api.ionworks.com/model_builders/{model_builder_id}/build \
--header 'Content-Type: application/json' \
--data '
{
"cell_spec_id": "<string>",
"save": false,
"name": "<string>",
"description": "<string>",
"set_as_default": false
}
'import requests
url = "https://api.ionworks.com/model_builders/{model_builder_id}/build"
payload = {
"cell_spec_id": "<string>",
"save": False,
"name": "<string>",
"description": "<string>",
"set_as_default": False
}
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({
cell_spec_id: '<string>',
save: false,
name: '<string>',
description: '<string>',
set_as_default: false
})
};
fetch('https://api.ionworks.com/model_builders/{model_builder_id}/build', 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/{model_builder_id}/build",
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([
'cell_spec_id' => '<string>',
'save' => false,
'name' => '<string>',
'description' => '<string>',
'set_as_default' => false
]),
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/{model_builder_id}/build"
payload := strings.NewReader("{\n \"cell_spec_id\": \"<string>\",\n \"save\": false,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"set_as_default\": false\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/{model_builder_id}/build")
.header("Content-Type", "application/json")
.body("{\n \"cell_spec_id\": \"<string>\",\n \"save\": false,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"set_as_default\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/model_builders/{model_builder_id}/build")
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 \"cell_spec_id\": \"<string>\",\n \"save\": false,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"set_as_default\": false\n}"
response = http.request(request)
puts response.read_body{
"parameters": {},
"missing": [
"<string>"
],
"issues": [
{
"severity": "error",
"code": "missing",
"message": "<string>",
"parameter": "<string>",
"path": "<string>",
"element": "<string>"
}
],
"parameterized_model_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Model builders
Build a parameter set from a cell spec
Build the model’s parameters for a cell spec; with save, store them as a parameterized model.
Build a parameter set from a cell spec
curl --request POST \
--url https://api.ionworks.com/model_builders/{model_builder_id}/build \
--header 'Content-Type: application/json' \
--data '
{
"cell_spec_id": "<string>",
"save": false,
"name": "<string>",
"description": "<string>",
"set_as_default": false
}
'import requests
url = "https://api.ionworks.com/model_builders/{model_builder_id}/build"
payload = {
"cell_spec_id": "<string>",
"save": False,
"name": "<string>",
"description": "<string>",
"set_as_default": False
}
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({
cell_spec_id: '<string>',
save: false,
name: '<string>',
description: '<string>',
set_as_default: false
})
};
fetch('https://api.ionworks.com/model_builders/{model_builder_id}/build', 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/{model_builder_id}/build",
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([
'cell_spec_id' => '<string>',
'save' => false,
'name' => '<string>',
'description' => '<string>',
'set_as_default' => false
]),
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/{model_builder_id}/build"
payload := strings.NewReader("{\n \"cell_spec_id\": \"<string>\",\n \"save\": false,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"set_as_default\": false\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/{model_builder_id}/build")
.header("Content-Type", "application/json")
.body("{\n \"cell_spec_id\": \"<string>\",\n \"save\": false,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"set_as_default\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/model_builders/{model_builder_id}/build")
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 \"cell_spec_id\": \"<string>\",\n \"save\": false,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"set_as_default\": false\n}"
response = http.request(request)
puts response.read_body{
"parameters": {},
"missing": [
"<string>"
],
"issues": [
{
"severity": "error",
"code": "missing",
"message": "<string>",
"parameter": "<string>",
"path": "<string>",
"element": "<string>"
}
],
"parameterized_model_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Body
application/json
Body for building a parameter set from a cell spec.
Save the result as a parameterized model on the cell spec.
Name for the saved parameterized model. Required with save.
Make the saved model the cell spec's default parameterized model.
Response
Successful Response
A built parameter set, plus what (if anything) is still missing.
Parameter values, in the parameterized-model storage format.
Parameters the model needs that the builder did not produce.
Warnings from the readiness check.
Show child attributes
Show child attributes
The saved parameterized model, when save was set.
Was this page helpful?