BEbenchling
Procedure Run Plan

Create ProcedureRunPlan

Create a draft recipe or assay run plan (procedure run plan) within a study.

Required fields

FieldDescription
descriptionHuman-readable description of the plan
studyIdID of the parent study (stdy_XXXXXXXX). Use GET /benchling/study/items to list studies.

Optional fields

FieldDefaultDescription
dataEntryModeINDIVIDUAL_CONDITION_REPLICATESControls worksheet creation upon promotion
workflowFlowchartConfigVersionIdnullOptional ID of the workflow flowchart config version (wffccv_XXXXXXXX) defining the procedure structure
confirmationMethodByParamVersionIdConfirmation method overrides per parameter (omit or pass [] for no overrides)

Notes

  • The creator is automatically set to the authenticated user.
  • description must not exceed 255 characters.
  • The study must be of a type that supports run plans (e.g., recipe or assay run studies). Assay development studies reject ALL_CONDITION_REPLICATES_TOGETHER mode.
  • After creating the plan, add conditions using the Create ProcedureRunPlanCondition endpoint.
  • When the plan is ready, promote it to an active run using the Promote endpoint.
post/api/v3/procedure-run-plan

Request

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

Headers

EARLY-ACCESSstring

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

Request body

dataEntryMode'INDIVIDUAL_CONDITION_REPLICATES' | 'ALL_CONDITION_REPLICATES_TOGETHER'

Controls how data entry worksheets are created upon promotion. INDIVIDUAL_CONDITION_REPLICATES creates one worksheet per condition-replicate. ALL_CONDITION_REPLICATES_TOGETHER creates a single shared worksheet (not supported for assay run plans). Defaults to INDIVIDUAL_CONDITION_REPLICATES if omitted.

descriptionstring required

A human-readable description of the run plan. Must not exceed 255 characters.

studyIdstring required

The ID of the study this run plan belongs to. Format: stdy_XXXXXXXX.

workflowFlowchartConfigVersionIdstring nullable

The ID of the workflow flowchart config version that defines the procedure template for this run plan. Format: wffccv_XXXXXXXX. Omit or set to null to create a run plan with no linked procedure.

Response

Created

__typenamestring
createdAtstring datetime
dataEntryMode'INDIVIDUAL_CONDITION_REPLICATES' | 'ALL_CONDITION_REPLICATES_TOGETHER'
descriptionstring
idstring
modifiedAtstring datetime
procedureRunPlanConditionsstring uri

Changes

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