Get a Run schema by ID

GET

https://{tenant_name}.benchling.com/api/v2/assay-run-schemas/:schema_id

GET

/api/v2/assay-run-schemas/:schema_id

curl https://{tenant_name}.benchling.com/api/v2/assay-run-schemas/schema_id \
     -H "Authorization: Bearer <token>"

{
  "archiveRecord": {
    "reason": "Made in error"
  },
  "fieldDefinitions": [
    {
      "archiveRecord": {
        "reason": "Made in error"
      },
      "id": "tsf_HXUnClU9",
      "isMulti": true,
      "isRequired": true,
      "name": "Resistance Gene",
      "type": "dna_sequence_link"
    }
  ],
  "id": "string",
  "name": "string",
  "type": "assay_run",
  "organization": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "systemName": "string",
  "automationInputFileConfigs": [
    {
      "name": "string"
    }
  ],
  "automationOutputFileConfigs": [
    {
      "name": "string"
    }
  ],
  "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
  "derivedFrom": "string"
}

Get a Run schema by ID

Authentication

AuthorizationBearer

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

Path parameters

schema_idstringRequired

ID of schema to get

Response

archiveRecordobject or nullOptional

fieldDefinitionslist of objectsOptional

idstringOptional

namestringOptional

typeenumOptionalRead-only

Allowed values:

organizationobjectOptional

systemNamestringOptional

automationInputFileConfigslist of objectsOptional

automationOutputFileConfigslist of objectsOptional

modifiedAtdatetimeOptional

DateTime the Assay Run Schema was last modified

derivedFromstring or nullOptionalDeprecated

This feature is no longer supported.

Errors

400

Bad Request Error

404

Not Found Error