RequestCreate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/benchling/main/json-schema/benchling-request-create-schema.json",
  "title": "RequestCreate",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/benchling-legacy-requests-api-openapi.yml#/components/schemas/RequestCreate",
  "additionalProperties": false,
  "allOf": [
    {
      "$ref": "#/$defs/RequestWriteBase"
    },
    {
      "properties": {
        "schemaId": {
          "description": "ID of the Legacy Request's schema.",
          "type": "string",
          "writeOnly": true
        }
      },
      "required": [
        "schemaId",
        "fields",
        "samples",
        "sampleGroups",
        "projectId"
      ]
    }
  ],
  "$defs": {
    "Field": {
      "properties": {
        "displayValue": {
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "isMulti": {
          "readOnly": true,
          "type": "boolean"
        },
        "textValue": {
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/FieldType"
            }
          ],
          "readOnly": true
        },
        "value": {
          "description": "For single link fields, use the id of the item you want to link (eg. \"seq_jdf8BV24\").\nFor multi-link fields, use an array of ids of the items you want to link (eg. [\"seq_jdf8BV24\"])\n",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "boolean"
            },
            {
              "type": "number"
            },
            {
              "type": "object"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    },
    "FieldType": {
      "enum": [
        "dna_sequence_link",
        "aa_sequence_link",
        "custom_entity_link",
        "entity_link",
        "mixture_link",
        "molecule_link",
        "dropdown",
        "part_link",
        "translation_link",
        "aa_part_link",
        "base_molecule_link",
        "blob_link",
        "text",
        "long_text",
        "batch_link",
        "storage_link",
        "entry_link",
        "assay_request_link",
        "assay_result_link",
        "assay_run_link",
        "boolean",
        "float",
        "integer",
        "datetime",
        "date",
        "json"
      ],
      "type": "string"
    },
    "Fields": {
      "additionalProperties": {
        "$ref": "#/$defs/Field"
      },
      "type": "object"
    },
    "RequestBase": {
      "description": "A Legacy Request is an ask to perform a service, e.g. produce a sample or perform assays on a sample. Requests are usually placed to another team or individual who specializes in performing the service.",
      "type": "object"
    },
    "RequestSampleGroupCreate": {
      "properties": {
        "samples": {
          "$ref": "#/$defs/RequestSampleGroupSamples"
        }
      },
      "required": [
        "samples"
      ],
      "type": "object"
    },
    "RequestSampleGroupSamples": {
      "additionalProperties": {
        "oneOf": [
          {
            "$ref": "#/$defs/RequestSampleWithEntity"
          },
          {
            "$ref": "#/$defs/RequestSampleWithBatch"
          }
        ]
      },
      "description": "The key for each (Legacy) RequestSample should match one of the samplesSchema[n].name property in the request schema json.\n",
      "type": "object"
    },
    "RequestSampleWithBatch": {
      "properties": {
        "batchId": {
          "type": "string"
        },
        "containerId": {
          "type": "string"
        }
      },
      "required": [
        "batchId"
      ],
      "type": "object"
    },
    "RequestSampleWithEntity": {
      "properties": {
        "containerId": {
          "type": "string"
        },
        "entityId": {
          "type": "string"
        }
      },
      "required": [
        "entityId"
      ],
      "type": "object"
    },
    "RequestWriteBase": {
      "allOf": [
        {
          "$ref": "#/$defs/RequestBase"
        },
        {
          "properties": {
            "assignees": {
              "description": "Array of assignees",
              "items": {
                "oneOf": [
                  {
                    "$ref": "#/$defs/RequestWriteUserAssignee"
                  },
                  {
                    "$ref": "#/$defs/RequestWriteTeamAssignee"
                  }
                ]
              },
              "type": "array",
              "writeOnly": true
            },
            "fields": {
              "allOf": [
                {
                  "$ref": "#/$defs/Fields"
                }
              ],
              "description": "The Legacy Request's fields"
            },
            "projectId": {
              "description": "The ID of the project to which the Legacy Request belongs.",
              "type": "string"
            },
            "requestorId": {
              "description": "ID of the user making the Legacy Request. If unspecified, the requestor is the request creator.\n",
              "type": [
                "string",
                "null"
              ],
              "writeOnly": true
            },
            "sampleGroups": {
              "items": {
                "$ref": "#/$defs/RequestSampleGroupCreate"
              },
              "type": "array"
            },
            "scheduledOn": {
              "description": "Date the Legacy Request is scheduled to be executed on, in YYYY-MM-DD format.",
              "format": "date",
              "type": "string",
              "writeOnly": true
            }
          }
        }
      ]
    },
    "RequestWriteTeamAssignee": {
      "properties": {
        "teamId": {
          "type": "string"
        }
      },
      "required": [
        "teamId"
      ],
      "type": "object"
    },
    "RequestWriteUserAssignee": {
      "properties": {
        "userId": {
          "type": "string"
        }
      },
      "required": [
        "userId"
      ],
      "type": "object"
    }
  }
}