List batch schemas

GET

https://{tenant_name}.benchling.com/api/v2/batch-schemas

GET

/api/v2/batch-schemas

curl -G https://{tenant_name}.benchling.com/api/v2/batch-schemas \
     -H "Authorization: Bearer <token>" \
     --data-urlencode "modifiedAt=> 2022-03-01 AND < 2022-04-01"

{
  "batchSchemas": [
    {
      "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": "string",
      "prefix": "string",
      "registryId": "string",
      "entitySchemaId": "string",
      "modifiedAt": "2017-04-18T05:55:48.685345+00:00"
    }
  ],
  "nextToken": "string"
}

List batch schemas

Authentication

AuthorizationBearer

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

Query parameters

nextTokenstringOptional

pageSizeintegerOptional0-100Defaults to 50

modifiedAtstringOptional

Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

Response headers

Result-Countinteger

The total number of schemas that match the given query

x-rate-limit-limitinteger

The number of allowed requests in the current rate-limit period

x-rate-limit-remaininginteger

The number of calls remaining in the current rate-limit period

x-rate-limit-resetinteger

The number of seconds remaining in the current rate-limit period

Response

batchSchemaslist of objectsOptionalRead-only

nextTokenstringOptional

Errors

400

Bad Request Error