Create ProcedureRunPlanCondition

Beta

POST

https://{tenant_name}.benchling.com/api/v3/procedure-run-plan-condition

POST

/api/v3/procedure-run-plan-condition

curl -X POST https://{tenant_name}.benchling.com/api/v3/procedure-run-plan-condition \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "description": "10mg/kg treatment group",
  "methodParametersPlan": {
    "dataParameterValues": [
      {
        "parameterId": "schver_Rm4nTvWz",
        "value": {
          "value": {
            "floatValue": 10,
            "type": "ft_float",
            "value": "10.0"
          }
        }
      }
    ],
    "equipmentValues": [
      {
        "equipmentId": "equipmentId",
        "value": {
          "key": "value"
        }
      }
    ],
    "materialInputValues": [
      {
        "materialInputId": "materialInputId",
        "value": {
          "key": "value"
        }
      }
    ]
  },
  "name": "Low Dose",
  "procedureRunPlanId": "prp_Xk9mLpQr",
  "replicates": [
    {
      "replicateNumber": 1
    },
    {
      "replicateNumber": 2
    },
    {
      "replicateNumber": 3
    }
  ],
  "templateMethodVersionId": "pcmdv_Hn5kRtYw"
}'

{
  "__typename": "__typename",
  "createdAt": "createdAt",
  "description": "description",
  "id": "id",
  "methodParametersPlan": {
    "__typename": "__typename",
    "dataParameterValues": [
      {}
    ],
    "equipmentValues": [
      {}
    ],
    "materialInputValues": [
      {}
    ]
  },
  "modifiedAt": "modifiedAt",
  "name": "name",
  "position": 1,
  "procedureRunPlan": {
    "__typename": "__typename",
    "id": "id"
  },
  "replicates": [
    {
      "__typename": "__typename",
      "replicateNumber": 1,
      "sourcePmeiIds": [
        "sourcePmeiIds"
      ]
    }
  ],
  "templateMethodVersion": {
    "__typename": "__typename",
    "id": "id"
  }
}

Create a condition within a run plan.

Required fields

Field	Description
`name`	Display name (must not be empty)
`description`	Condition description
`procedureRunPlanId`	Parent run plan ID (`prp_XXXXXXXX`)
`templateMethodVersionId`	Method definition version ID (`pcmdv_XXXXXXXX`) — must be a method in the run plan’s flowchart
`replicates`	Array of replicates with consecutive `replicateNumber` values starting from 1
`methodParametersPlan`	Pre-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.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

descriptionstringRequired

Description of the condition. Must not exceed 255 characters.

methodParametersPlanobject or nullRequired

Pre-filled parameter values for this condition’s unit operation. Pass null to use default values from the procedure template upon run creation.

namestringRequired

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

procedureRunPlanIdstringRequired

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

replicateslist of objectsRequired

The replicates for this condition. The plan’s total number of replicates must not exceed 500, and replicateNumber values must be consecutive starting from 1.

templateMethodVersionIdstringRequired

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

__typenamestringOptional

createdAtstringOptional

descriptionstringOptional

The user-defined description of the condition.

idstringOptional

methodParametersPlanobject or nullOptional

Method plan containing parameter values for this condition's unit operation. If this value is null upon promotion to a procedure run, default values from the procedure will be used.

modifiedAtstringOptional

namestringOptional

The user-defined name of the condition.

positionintegerOptional

The display order of the condition within the run.

procedureRunPlanobjectOptional

The ProcedureRunPlan that this condition is a part of.

replicateslist of objectsOptional

Replicate information for this condition.

templateMethodVersionobjectOptional

The procedure method definition version (PMDV) this condition belongs to.

Errors

400

Procedure Run Plan Condition Create Request Bad Request Error

403

Procedure Run Plan Condition Create Request Forbidden Error

404

Procedure Run Plan Condition Create Request Not Found Error

409

Procedure Run Plan Condition Create Request Conflict Error

429

Procedure Run Plan Condition Create Request Too Many Requests Error

500

Procedure Run Plan Condition Create Request Internal Server Error