Get ProcedureParameterVersion by ID

Beta

GET

https://{tenant_name}.benchling.com/api/v3/procedure-parameter-version/:procedure_parameter_version_id

GET

/api/v3/procedure-parameter-version/:procedure_parameter_version_id

curl https://{tenant_name}.benchling.com/api/v3/procedure-parameter-version/procedure_parameter_version_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "allowedEquipmentModels": {
    "key": "value"
  },
  "amountDataType": {
    "__typename": "__typename",
    "dropdown": {
      "__typename": "__typename",
      "id": "id"
    },
    "schema": {
      "__typename": "__typename",
      "id": "id"
    },
    "type": "type",
    "unit": {
      "__typename": "__typename",
      "id": "id"
    }
  },
  "confirmationMethod": "TABLE",
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "dataType": {
    "__typename": "__typename",
    "dropdown": {
      "__typename": "__typename",
      "id": "id"
    },
    "schema": {
      "__typename": "__typename",
      "id": "id"
    },
    "type": "type",
    "unit": {
      "__typename": "__typename",
      "id": "id"
    }
  },
  "description": "description",
  "id": "id",
  "maximum": {
    "key": "value"
  },
  "minimum": {
    "key": "value"
  },
  "name": "name",
  "procedureParameter": {
    "__typename": "__typename",
    "id": "id"
  }
}

Get a single ProcedureParameterVersion by ID.

Authentication

AuthorizationBearer

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

Path parameters

procedure_parameter_version_idstringRequired

ID of the ProcedureParameterVersion.

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

allowedEquipmentModelsmap from strings to any or nullOptional

amountDataTypeobject or nullOptional

Specifies the value type configuration for a procedure parameter. Used within ProcedureParameterVersion to define what kind of data a parameter accepts. The type field indicates the field type (such as text, decimal, entity link, or dropdown). For numeric types, unit optionally references a Unit for measurement context. For entity link types, schema optionally constrains values to entities of a specific EntitySchema. Also used as amountDataType on material input parameter versions to define how amounts are specified.

confirmationMethodenumOptional

Allowed values:

createdAtstringOptional

creatorobjectOptional

dataTypeobjectOptional

descriptionstringOptional

idstringOptional

maximummap from strings to any or nullOptional

minimummap from strings to any or nullOptional

namestringOptional

procedureParameterobjectOptional

Errors

400

Procedure Parameter Version Get Request Bad Request Error

403

Procedure Parameter Version Get Request Forbidden Error

404

Procedure Parameter Version Get Request Not Found Error

429

Procedure Parameter Version Get Request Too Many Requests Error

500

Procedure Parameter Version Get Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors