Skip to main content
Update Optimization
curl --request PATCH \
  --url https://api.ionworks.com/optimize/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "job_id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "user_id": "<string>",
  "cell_spec_id": "<string>",
  "parameterized_model_id": "<string>",
  "optimization_template_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_email": "<string>",
  "organization_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
id
string
required

Body

application/json

Request body for updating an optimization's name and/or description.

​
name
string | null
Minimum string length: 1
​
description
string | null

Response

Successful Response

Pydantic model for the optimizations table.

​
id
string
required
​
job_id
string
required
​
project_id
string
required
​
name
string | null
​
description
string | null
​
user_id
string | null
​
cell_spec_id
string | null
​
parameterized_model_id
string | null
​
optimization_template_id
string | null
​
created_at
string<date-time> | null
​
created_by_email
string | null
​
organization_id
string | null

Organization this optimization belongs to.