Benchling · Schema

WorksheetReviewChanges

Contents include basic worksheet metadata along with its review changes, including any snapshot information if present.

Life SciencesBiotechR&DMolecular BiologyLaboratory Information ManagementElectronic Lab NotebookAssay ManagementInventory ManagementSequence ManagementExperiment WorkflowsRESTWebhooks

Properties

Name	Type	Description
apiURL	string	The canonical url of the Worksheet in the API.
createdAt	string	DateTime the worksheet was created at
creator	object	UserSummary Resource of the user who created the worksheet
folderId	string	ID of the folder that contains the worksheet
id	string	ID of the worksheet
modifiedAt	string	DateTime the worksheet was last modified
name	string	Title of the worksheet
reviewRecord	object	Review record if set
webURL	string	URL of the worksheet

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/WorksheetReviewChanges.json",
  "title": "WorksheetReviewChanges",
  "description": "Contents include basic worksheet metadata along with its review changes, including any snapshot information if present.\n",
  "properties": {
    "apiURL": {
      "description": "The canonical url of the Worksheet in the API.",
      "example": "https://benchling.com/api/v2-beta/worksheets/wks_0ma1gawd/review-changes",
      "format": "uri",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "createdAt": {
      "description": "DateTime the worksheet was created at",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "creator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserSummary"
        }
      ],
      "description": "UserSummary Resource of the user who created the worksheet",
      "readOnly": true
    },
    "folderId": {
      "description": "ID of the folder that contains the worksheet",
      "type": "string"
    },
    "id": {
      "description": "ID of the worksheet",
      "example": "wks_0ma1gawd",
      "type": "string"
    },
    "modifiedAt": {
      "description": "DateTime the worksheet was last modified",
      "type": "string"
    },
    "name": {
      "description": "Title of the worksheet",
      "type": "string"
    },
    "reviewRecord": {
      "description": "Review record if set",
      "nullable": true,
      "properties": {
        "comment": {
          "description": "Reviewer's Comments",
          "type": "string"
        },
        "reviewChanges": {
          "description": "A list of the Review Changes that have been made to this worksheet",
          "items": {
            "$ref": "#/components/schemas/ReviewChange"
          },
          "type": "array"
        },
        "status": {
          "description": "Review Status of the worksheet",
          "enum": [
            "ACCEPTED",
            "NEEDS_REVIEW",
            "REJECTED",
            "RETRACTED",
            "ACCEPTANCE_SNAPSHOT_IN_PROGRESS",
            "REVIEW_SNAPSHOT_IN_PROGRESS",
            "IN_PROGRESS",
            "ACTION_REQUIRED"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "webURL": {
      "description": "URL of the worksheet",
      "type": "string"
    }
  },
  "type": "object"
}