Create cell specifications and instances from Uncountable recipes

Read the organization’s Uncountable project and create what is missing.

Callable with an API key (X-API-Key) as well as a session, so a scheduler can run it. Idempotent: specifications are matched by name within the project and instances by recipe id within their specification, and existing records are left unchanged. With dry_run it writes nothing and reports what it would create, with the field mapping. Answers 403 unless the organization’s nav_config.uncountableSync is enabled and names its projects.

Create cell specifications and instances from Uncountable recipes

cURL

curl --request POST \
  --url https://api.ionworks.com/integrations/uncountable/sync \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dry_run": false
}
'

200

{
  "uncountable_project_ids": [
    123
  ],
  "recipes_read": 123,
  "recipes_skipped": 123,
  "specs_created": 123,
  "specs_existing": 123,
  "instances_created": 123,
  "instances_existing": 123,
  "specs": [
    {
      "id": "<string>",
      "name": "<string>",
      "created": true,
      "instances_created": 123,
      "instances_existing": 123,
      "conflicts": {},
      "gaps": {},
      "design": {},
      "drift": {},
      "instances": [
        {
          "name": "<string>",
          "notes": "<string>",
          "exists": true,
          "measured_properties": {},
          "id": "<string>",
          "moved_from": "<string>"
        }
      ]
    }
  ],
  "refused": [
    "<string>"
  ],
  "recipes_refused": 0,
  "dry_run": false,
  "mapping": [
    {
      "source": "<string>",
      "target": "<string>",
      "input_ids": [
        123
      ],
      "note": ""
    }
  ],
  "unmapped_inputs": [
    {
      "input_id": 123,
      "name": "<string>",
      "recipes": 123
    }
  ]
}

Body

application/json

project_id · string<uuid> · required

Ionworks project the specifications and instances go into.

dry_run · boolean · default: false

Report what a sync would create and reuse, and how fields map, without writing anything.

Response

200

application/json

Successful Response

uncountable_project_ids · integer[] · required

Uncountable projects read.

recipes_read · integer · required

Distinct recipes across the Uncountable projects.

recipes_skipped · integer · required

Full-cell recipes skipped because they have no inputs yet.

specs_created · integer · required

New cell specifications.

specs_existing · integer · required

Cell specifications reused.

instances_created · integer · required

New cell instances.

instances_existing · integer · required

Cell instances left unchanged.

specs · UncountableSyncSpec · object[] · required

Per-spec breakdown.

Show child attributes

refused · string[]

Recipes and designs that could not be mapped without guessing (two slurries for one electrode, or no design capacity), and why. Nothing is created for them. One entry can stand for a whole design.

recipes_refused · integer · default: 0

Recipes behind the refusals, counting every recipe of a design.

dry_run · boolean · default: false

True when nothing was written: the counts are a preview.

mapping · UncountableMappingRow · object[]

How Uncountable fields land in Ionworks.

Show child attributes

unmapped_inputs · UncountableUnmappedInput · object[]

Inputs the full-cell recipes state that are not imported.

Show child attributes