Procedure Run Plan

Update ProcedureRunPlan

Update a run plan.

Constraints

  • Cannot update a plan that has been turned into a run. Once a plan has been turned into a run, it is immutable.
  • dataEntryMode set to ALL_CONDITION_REPLICATES_TOGETHER is rejected for assay development study plans.

Reordering conditions

Use conditionOrder to reorder existing conditions within a procedure method definition version (PMDV). Each entry specifies a templateMethodVersionId and an ordered list of conditionIds. The list must include every existing condition ID for that PMDV — no duplicates, no omissions, and no IDs from other PMDVs or plans.

patch/api/v3/procedure-run-plan/{procedure_run_plan_id}

Request

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

Path parameters

procedure_run_plan_idstring required

ID of the ProcedureRunPlan.

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).

descriptionstring

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

workflowFlowchartConfigVersionIdstring nullable

The ID of the workflow flowchart config version to switch to. Format: wffccv_XXXXXXXX. When changed and planning-time split-pool isn't enabled, the plan's whole condition set is rebuilt from scratch to keep uniform per-method coverage: every existing condition is deleted, and a fresh condition is created for each method of the new flowchart, one per prior canonical position (matching name, description, and replicate count). When planning-time split-pool is enabled, an existing condition whose method isn't a node of the new flowchart is instead reassociated with the new flowchart's method version for the same underlying method, if one exists, or deleted if no matching method exists. In both cases, planned parameter, material input, and equipment values, as well as planned unit operation links, are cleared, since they can't be preserved across the change. A single new condition is created for each new method node in the new flowchart.Set to null to clear the linked procedure flowchart version. When switching to a genuinely different procedure version (one with a different ID than the currently linked version), any existing confirmationMethodByParamVersionId overrides are automatically cleared unless confirmationMethodByParamVersionId is also provided in the same request.

Response

OK

__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.