Get a worksheet's review changes given a worksheet ID

Beta

GET

https://{tenant_name}.benchling.com/api/v2-beta/worksheets/:worksheet_id/review-changes

GET

/api/v2-beta/worksheets/:worksheet_id/review-changes

curl https://{tenant_name}.benchling.com/api/v2-beta/worksheets/worksheet_id/review-changes \
     -H "Authorization: Bearer <token>"

{
  "worksheet": {
    "apiURL": "https://benchling.com/api/v2/worksheets/wks_0ma1gawd/review-changes",
    "createdAt": "2024-01-15T09:30:00Z",
    "creator": {
      "handle": "string",
      "id": "string",
      "name": "string"
    },
    "folderId": "string",
    "id": "wks_0ma1gawd",
    "modifiedAt": "string",
    "name": "string",
    "reviewRecord": {
      "comment": "string",
      "reviewChanges": [
        {
          "action": "SEND_FOR_REVIEW",
          "comment": "string",
          "createdAt": "2024-01-15T09:30:00Z",
          "esigned": true,
          "id": "string",
          "reviewSnapshot": {
            "createdAt": "2024-01-15T09:30:00Z",
            "downloadURL": "string",
            "expiresAt": "2024-01-15T09:30:00Z",
            "size": 1,
            "status": "PENDING"
          }
        }
      ],
      "reviewProcesses": [
        {
          "completionStatus": "APPROVED",
          "id": "string",
          "name": "string",
          "stages": [
            {
              "actionLabel": "APPROVE",
              "id": "string",
              "name": "string",
              "reviewers": [
                {
                  "handle": "string",
                  "id": "string",
                  "name": "string",
                  "status": "BLOCKED"
                }
              ]
            }
          ],
          "type": "SELF_REVIEW"
        }
      ],
      "status": "ACCEPTED"
    },
    "webURL": "string"
  }
}

Get a worksheet's review changes given a worksheet ID

Authentication

AuthorizationBearer

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

Path parameters

worksheet_idstringRequired

ID of the worksheet

Query parameters

returningstringOptional

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, ’*’. For more information, click here.

Response

Returns a single worksheet's basic metadata along with its review changes, including any snapshot information if present.

worksheetobjectOptional

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

Errors

404

Not Found Error