BEbenchling
Procedure Run Plan Condition

Create ProcedureRunPlanCondition

Create a condition within a run plan.

Required fields

FieldDescription
nameDisplay name (must not be empty)
descriptionCondition description
procedureRunPlanIdParent run plan ID (prp_XXXXXXXX)
templateMethodVersionIdMethod definition version ID (pcmdv_XXXXXXXX) — must be a method in the run plan's flowchart
replicatesArray of replicates with consecutive replicateNumber values starting from 1
methodParametersPlanPre-filled parameter values, or null for defaults

Constraints

  • templateMethodVersionId must reference a method present in the parent run plan's flowchart version.
  • name must not be empty, and both name and description must not exceed 255 characters.
  • The total replicates across all conditions in a run plan cannot exceed 500. Each condition's replicateNumber values must be consecutive starting from 1.
  • Each template method in a run plan can contain at most 100 conditions.
  • Per-PMDV uniformity: All conditions for the same procedure method definition version (PMDV) within a plan must have the same count, names, descriptions, and replicate counts across all unit operations.
  • The condition's position (display order) is automatically assigned.
post/api/v3/procedure-run-plan-condition

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

descriptionstring required

Description of the condition. Must not exceed 255 characters.

namestring required

Display name of the condition. Must not be empty and must not exceed 255 characters.

procedureRunPlanIdstring required

The ID of the parent run plan. Format: prp_XXXXXXXX.

templateMethodVersionIdstring required

The ID of the procedure method definition version (PMDV) this condition belongs to. Format: pcmdv_XXXXXXXX. Must reference a method in the parent run plan's flowchart.

Response

Created

__typenamestring
createdAtstring datetime
descriptionstring

The user-defined description of the condition.

idstring
modifiedAtstring datetime
namestring

The user-defined name of the condition.

positioninteger

The display order of the condition within the run.

Changes

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