Update ProcedureRunPlan | Benchling Documentation

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/procedure-run-plan/procedure_run_plan_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "conditionOrder": [
    {
      "conditionIds": [
        "prpc_Bm7nWsKt",
        "prpc_Zq2rPvJx"
      ],
      "templateMethodVersionId": "pcmdv_Hn5kRtYw"
    }
  ],
  "confirmationMethodByParamVersionId": [
    {
      "confirmationMethod": "TABLE",
      "paramVersionId": "schver_Rm4nTvWz"
    }
  ],
  "dataEntryMode": "INDIVIDUAL_CONDITION_REPLICATES",
  "description": "Updated dose-response plan",
  "workflowFlowchartConfigVersionId": "wffccv_Lk3mQpXn"
}'

{
  "__typename": "__typename",
  "confirmationMethodByParamVersionId": [
    {
      "__typename": "__typename",
      "confirmationMethod": "TABLE",
      "paramVersionId": "paramVersionId"
    }
  ],
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "dataEntryMode": "INDIVIDUAL_CONDITION_REPLICATES",
  "description": "description",
  "id": "id",
  "modifiedAt": "modifiedAt",
  "procedureFlowchartConfigVersion": {
    "__typename": "__typename",
    "id": "id"
  },
  "procedureRun": {
    "__typename": "__typename",
    "id": "id"
  },
  "procedureRunPlanConditions": "procedureRunPlanConditions",
  "study": {
    "__typename": "__typename",
    "id": "id"
  }
}

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

procedure_run_plan_idstringRequired

ID of the ProcedureRunPlan.

Request

This endpoint expects an object.

conditionOrderlist of objectsOptional

Reorder existing conditions per procedure method definition version (PMDV). For each PMDV included, all existing condition IDs for that PMDV in the plan must be present exactly once. The order of IDs in conditionIds determines the new display positions (0-indexed).

confirmationMethodByParamVersionIdlist of objectsOptional

Replace the confirmation method overrides for specific procedure parameters. Pass an empty array to clear all overrides. When workflowFlowchartConfigVersionId changes to a different version, omitting this field clears all existing overrides automatically, since parameter version IDs are specific to a procedure version and may be invalid for the new one.

dataEntryModeenumOptional

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

Allowed values:

descriptionstringOptional

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

workflowFlowchartConfigVersionIdstring or nullOptional

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

__typenamestringOptional

confirmationMethodByParamVersionIdlist of objectsOptional

createdAtstringOptional

creatorobjectOptional

dataEntryModeenumOptional

Allowed values:

descriptionstringOptional

idstringOptional

modifiedAtstringOptional

procedureFlowchartConfigVersionobject or nullOptional

procedureRunobject or nullOptional

procedureRunPlanConditionsstringOptionalformat: "uri"

studyobjectOptional

Errors

400

Procedure Run Plan Update Request Bad Request Error

403

Procedure Run Plan Update Request Forbidden Error

404

Procedure Run Plan Update Request Not Found Error

409

Procedure Run Plan Update Request Conflict Error

429

Procedure Run Plan Update Request Too Many Requests Error

500

Procedure Run Plan Update Request Internal Server Error