Get Optimization With Job

Get an optimization and its linked job by optimization id or job_id.

Get Optimization With Job

cURL

curl --request GET \
  --url https://api.ionworks.com/optimize/{id}

200

{
  "optimization": {
    "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>"
  },
  "job": {
    "job_id": "<string>",
    "job_type": "dummy",
    "status": "pending",
    "priority": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "organization_id": "<string>",
    "is_terminal": true,
    "is_failed": true,
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "compute_time": 123,
    "error": "<string>",
    "error_code": "EXECUTION_TIMEOUT",
    "result": {},
    "callback_url": "<string>",
    "parent_job_id": "<string>",
    "project_id": "<string>",
    "access_level": "organization",
    "params_path": "<string>",
    "metadata_path": "<string>"
  }
}

Path Parameters

id · string · required

Response

200

application/json

Successful Response

Single optimization and its linked job (for get-one responses).

optimization · Optimization · object · required

Pydantic model for the optimizations table.

Show child attributes

job · JobResponse · object · required

Schema for job information response

Show child attributes