Create Template From Optimization

curl --request POST \
  --url https://api.ionworks.com/optimization_templates/from-optimization \
  --header 'Content-Type: application/json' \
  --data '
{
  "optimization_id": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'

{
  "name": "<string>",
  "id": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "initial_form_data": {},
  "project_id": "<string>",
  "access_level": "project"
}

Create Template From Optimization

Create a project optimization template from an existing optimization.

Copies the optimization’s saved config into the new template’s initial_form_data (both follow the same schema), so the client no longer re-maps the config through the optimization form to save a template.

Parameters

body : FromOptimizationRequest The source optimization id plus the new template’s name/description.

Returns

OptimizationTemplate The created project-level template.

Raises

NotFoundError If the optimization does not exist. BadRequestError If the name is blank or the optimization has no valid saved configuration to turn into a template. ConflictError If a template with the same name already exists in the project.

Create Template From Optimization

curl --request POST \
  --url https://api.ionworks.com/optimization_templates/from-optimization \
  --header 'Content-Type: application/json' \
  --data '
{
  "optimization_id": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'

{
  "name": "<string>",
  "id": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "initial_form_data": {},
  "project_id": "<string>",
  "access_level": "project"
}

Body

application/json

Request body for creating a template from an existing optimization.

optimization_id

string

required

name

string

required

description

string | null

Response

Successful Response

Model representing an optimization template as returned by the API.

name

string

required

The name of the optimization template.

string

required

The unique identifier for the template.

organization_id

string

required

The ID of the organization this template belongs to.

created_at

string<date-time>

required

Timestamp of when the template was created.

updated_at

string<date-time>

required

Timestamp of when the template was last updated.

description

string | null

An optional description for the template.

initial_form_data

Initial Form Data · object

Initial form data values.

project_id

string | null

The ID of the owner project (None for system templates).

access_level

string

default:project

Template scope: 'system' for built-in, 'project' for user-created.

⌘I