PATCH/projects/api/v3/notebooks/{notebookId}.json

Edits a notebook

Edits the fields of an existing notebook.

Path Params

  • Name
    notebookId
    Type
    integer
    required
    Description

Query Params

  • Name
    getEmoji
    Type
    boolean
    Description

    parse emojis to unicode

    Default
    true
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • projects
    • tags
    • users
    • notebookCategories
    • companies
    • teams
  • 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
  • Name
    fields[teams]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • teamLogo
    • teamLogoIcon
    • teamLogoColor
  • Name
    fields[tags]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • color
    • count
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[notebooks]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • description
    • contents
    • type
    • isPrivate
    • locked
    • lockdownId
    • secureContent
    • projectId
    • createdByUserID
    • updatedByUserID
    • deletedByUserID
    • dateUpdated
    • dateCreated
    • dateDeleted
    • deleted
    • categoryId
    • notebookVersionID
    • notebookVersionCreatedDateTime
    • notebookVersionUpdatedDateTime
    • latestVersionNo
    • commentsCount
    • readCommentsCount
    • contentHTML
    • privacy
    • commentFollowers
    • changeFollowers
    • projectNotifyCommentIncludeCreator
    • tagIds
  • Name
    fields[notebookCategories]
    Type
    array[string]
    Description
    Format
    Comma separated values
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage

Body Params

Request contains information of a notebook to be created or updated.

    • Name
      notebook
      Type
      object
      Description
      Notebook contains all the information returned from a notebook.

    Responses

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

    Examples

    200 OK

    Response
    {  "included": {    "companies": {      "additionalProp": {        "accounts": 0,        "addressOne": "string",        "addressTwo": "string",        "budgetDistribution": [          {            "color": "string",            "companyId": 0,            "count": 0,            "from": 0,            "to": 0          }        ],        "canSeePrivate": true,        "cid": "string",
    Download Swagger