Get ProcedureRunPlan by ID

Beta

GET

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

GET

/api/v3/procedure-run-plan/:procedure_run_plan_id

curl https://{tenant_name}.benchling.com/api/v3/procedure-run-plan/procedure_run_plan_id \
     -H "Authorization: Bearer <token>"

{
  "__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"
  }
}

Get a single ProcedureRunPlan by ID.

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.

Query parameters

returningstringOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstringOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

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 Get Request Bad Request Error

403

Procedure Run Plan Get Request Forbidden Error

404

Procedure Run Plan Get Request Not Found Error

429

Procedure Run Plan Get Request Too Many Requests Error

500

Procedure Run Plan Get Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors