IOionworks
Uncountable

Create cell specifications and instances from Uncountable recipes

Changed on

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.

post/integrations/uncountable/sync

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/integrations/uncountable/sync
  • Auth
    none declared

Request body

project_idstring uuid required

Ionworks project the specifications and instances go into.

dry_runboolean

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

acceptobject

Existing specifications and instances whose Uncountable changes to write: id -> the fingerprint a dry run showed for them. A record whose changes no longer match it is not written but reported as stale, so only the values someone reviewed are ever written.

Response

Successful Response

uncountable_project_idsinteger[] required

Uncountable projects read.

recipes_readinteger required

Distinct recipes across the Uncountable projects.

recipes_skippedinteger required

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

refusedstring[]

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_refusedinteger

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

specs_createdinteger required

New cell specifications.

specs_existinginteger required

Cell specifications reused.

instances_createdinteger required

New cell instances.

instances_existinginteger required

Cell instances already there.

specs_changedinteger

Existing specs Uncountable now states differently.

instances_changedinteger

Existing instances Uncountable now states differently.

specs_updatedinteger

Changed specs written.

instances_updatedinteger

Changed instances written.

changes_staleinteger

Accepted specs and instances not written because Uncountable or Ionworks changed them since the preview. Preview again to review them.

changes_failedinteger

Accepted specs and instances that could not be written; specs[].failures says why.

dry_runboolean

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

Changes

  • c1374d49d42dRevision changes
    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property //// to the response with the status

  • af9fdad1dc5bRevision changes
    • info

      endpoint added