Docs Home
/
Zoo Developer Tools
/
API
/
Orgs
/
Fetch the metadata and converted output for a single dataset conversion.

Fetch the metadata and converted output for a single dataset conversion

Parameters

Name

Type

Req.

Returns

  • 200 OK

    successful operation

    Name

    Type

    Req.

    body

    object
    optional
    Object Properties
    • completed_at

      string / ISO-8601
      optional
    • created_at

      string / ISO-8601
      optional
    • dataset_id

      string / UUID
      optional
    • file_etag

      string
      optional
    • file_path

      string
      optional
    • file_size

      integer
      optional
    • id

      string / UUID
      optional
    • importer_version

      string
      optional
    • metadata

      optional
    • original_snapshot_images

      array
      optional
      Array of
    • output

      string
      optional
    • phase

      string
      optional
      Possible values
      • queued:  Phase index `0`: waiting for a worker to begin processing this conversion.
      • zoo_generated_original_metadata:  Phase index `1`: generating original file metadata.
      • snapshot_original:  Phase index `2`: creating a snapshot of the original source model.
      • user_provided_metadata:  Phase index `3`: discovering optional user-provided metadata files (`.json`, `.yaml`, `.yml`, `.toml`, `.txt`) stored next to the source CAD file.
      • convert_raw_kcl:  Phase index `4`: converting the source model into raw KCL.
      • zoo_generated_raw_kcl_metadata:  Phase index `5`: generating raw KCL metadata.
      • snapshot_raw_kcl:  Phase index `6`: creating a snapshot of the raw KCL result.
      • salon:  Phase index `7`: running the salon/refactor step that produces polished KCL.
      • zoo_generated_salon_kcl_metadata:  Phase index `8`: generating salon KCL metadata.
      • snapshot_salon_kcl:  Phase index `9`: creating a snapshot of the salon/refactored KCL.
      • completed:  Phase index `10`: conversion finished successfully.
    • raw_kcl_output

      string
      optional
    • raw_kcl_snapshot_images

      array
      optional
      Array of
    • salon_kcl_output

      string
      optional
    • salon_kcl_snapshot_images

      array
      optional
      Array of
    • started_at

      string / ISO-8601
      optional
    • status

      string
      optional
      Possible values
      • queued:  Pending conversion.
      • canceled:  The file will not be converted.
      • in_progress:  The file is currently being converted. If `started_at` passes a certain threshold, we assume it got dropped and will retry.
      • success:  Conversion finished with the result available at `output_path`.
      • error_user:  Conversion failed due to user providing a broken file, such as it being empty.
      • error_unsupported:  Conversion failed because we didn't know how to handle the file. The conversion should be retried with a new converter version.
      • error_internal:  Conversion failed with some other unrecoverable error. The conversion should be retried with a new converter version.
    • status_message

      string
      optional
    • updated_at

      string / ISO-8601
      optional
get
/org/datasets/{id}/conversions/{conversion_id}
200 OK
Response