Create ProcedureRunPlan

Beta

POST

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

POST

/api/v3/procedure-run-plan

curl -X POST https://{tenant_name}.benchling.com/api/v3/procedure-run-plan \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "description": "Dose-response run plan",
  "studyId": "stdy_9CYiCggY",
  "confirmationMethodByParamVersionId": [
    {
      "confirmationMethod": "TABLE",
      "paramVersionId": "schver_Rm4nTvWz"
    }
  ],
  "dataEntryMode": "INDIVIDUAL_CONDITION_REPLICATES",
  "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"
  }
}

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

Required fields

Field	Description
`description`	Human-readable description of the plan
`studyId`	ID of the parent study (`stdy_XXXXXXXX`). Use `GET /benchling/study/items` to list studies.

Optional fields

Field	Default	Description
`dataEntryMode`	`INDIVIDUAL_CONDITION_REPLICATES`	Controls worksheet creation upon promotion
`workflowFlowchartConfigVersionId`	`null`	Optional ID of the workflow flowchart config version (`wffccv_XXXXXXXX`) defining the procedure structure
`confirmationMethodByParamVersionId`	Confirmation 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.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

descriptionstringRequired

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

studyIdstringRequired

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

confirmationMethodByParamVersionIdlist of objectsOptional

Override the default confirmation method for specific procedure parameters. Each entry maps a parameter version ID to a confirmation method (TABLE or PLATE_MAP). Omit or pass an empty array to use the default confirmation methods.

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). Defaults to INDIVIDUAL_CONDITION_REPLICATES if omitted.

Allowed values:

workflowFlowchartConfigVersionIdstring or nullOptional

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

__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 Create Request Bad Request Error

403

Procedure Run Plan Create Request Forbidden Error

404

Procedure Run Plan Create Request Not Found Error

409

Procedure Run Plan Create Request Conflict Error

429

Procedure Run Plan Create Request Too Many Requests Error

500

Procedure Run Plan Create Request Internal Server Error