BEbenchling
Analysis

Get Analysis by ID

Get a single Analysis by ID.

get/api/v3/analysis/{analysis_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

analysis_idstring required

ID of the Analysis.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime
descriptionstring nullable
idstring
modifiedAtstring datetime
namestring
statusCode'AI_PROPOSED' | 'BLOCKED' | 'FAILED' | 'HALTED' | 'RUNNING' | 'SUCCEEDED' | 'SUCCEEDED_WITH_ERRORS' | 'WAITING'
stepsstring uri
webUrlstring

Changes

No recorded changes to this operation across all 1 revision of this API.