GET/projects/api/v3/notebooks/{notebookId}/compare.json

Compare 2 notebook versions

Gets the contents diff between the contents of 2 notebook versions

Path Params

Name
notebookId
Type
integer
required
Description

Query Params

Name
include
Type
array[string]
Description
include
Format
Comma separated values
Allowed values
- users
Name
fields[users]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects

Responses

Code
200
Type
object
Schema
Description
200 OK
VersionResponse contains information about a specifc notebook version
Code
400
Type
object
Schema
Description
400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
Code
404
Description
404 Not Found No Data

Examples

200 OK

VersionResponse

{
  "included": {
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAddProjects": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isPlaceholderResource": true,
        "isServiceAccount": true,
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "userCost": 0,
        "userRate": 0,
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    }
  },
  "version": {
    "contentHTML": "string",
    "contents": "string",
    "createdAt": "string",
    "createdBy": 0,
    "createdByUserID": 0,
    "dateCreated": "string",
    "dateUpdated": "string",
    "notebook": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "notebookId": 0,
    "updatedAt": "string",
    "versionId": 0,
    "versionNumber": 0
  }
}

Download Swagger