BEbenchling
App Session

Get AppSession by ID

Get a single AppSession by ID.

get/api/v3/app-session/{app_session_id}

Request

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

Path parameters

app_session_idstring required

ID of the AppSession.

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
createdAtstring datetime
idstring
modifiedAtstring datetime
namestring
status'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'COMPLETED_WITH_WARNINGS' | 'TIMEOUT'

The current lifecycle status of this session, derived from the most recent version.

timeoutSecondsinteger

Maximum duration in seconds before the session times out automatically. Once the session's age exceeds this value and the session has not been finalized, its status becomes TIMEOUT.

Changes

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