Back to TeamworkEdits a notebook
Edits the fields of an existing notebook.
Input
type: object
properties:
parameters:
type: object
properties:
notebookId:
type: integer
getEmoji:
type: boolean
default: 'true'
description: parse emojis to unicode
include:
type: array
items:
enum:
- projects
- tags
- users
- notebookCategories
- companies
- teams
type: string
description: include
fields[users]:
type: array
items:
enum:
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
type: string
fields[teams]:
type: array
items:
enum:
- id
- name
- teamLogo
- teamLogoIcon
- teamLogoColor
type: string
fields[tags]:
type: array
items:
enum:
- id
- name
- color
- count
type: string
fields[projects]:
type: array
items:
enum:
- id
- name
type: string
fields[notebooks]:
type: array
items:
enum:
- 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
type: string
fields[notebookCategories]:
type: array
items:
type: string
fields[companies]:
type: array
items:
enum:
- id
- name
- logoUploadedToServer
- logoImage
type: string
required:
- notebookId
title: Parameters
data:
type: object
title: Data
properties:
notebook:
type: object
title: Notebook
properties:
categoryId:
type: integer
contents:
type: string
description:
type: string
isFullWidth:
type: boolean
isPrivate:
type: boolean
locked:
type: boolean
name:
type: string
newVersion:
type: boolean
notify:
type: object
title: Notify
properties:
ids:
type: object
title: UserGroups
properties:
companyIds:
type: object
title: NullableInt64Slice
properties:
'Null':
type: boolean
Set:
type: boolean
Value:
type: array
items:
type: integer
teamIds:
type: object
title: NullableInt64Slice
properties:
'Null':
type: boolean
Set:
type: boolean
Value:
type: array
items:
type: integer
userIds:
type: object
title: NullableInt64Slice
properties:
'Null':
type: boolean
Set:
type: boolean
Value:
type: array
items:
type: integer
type:
type: object
title: NotifyType
properties:
'Null':
type: boolean
Set:
type: boolean
Value:
type: string
notifyCurrentUser:
type: boolean
privacy:
type: object
title: UserGroups
properties:
companyIds:
type: object
title: NullableInt64Slice
properties:
'Null':
type: boolean
Set:
type: boolean
Value:
type: array
items:
type: integer
teamIds:
type: object
title: NullableInt64Slice
properties:
'Null':
type: boolean
Set:
type: boolean
Value:
type: array
items:
type: integer
userIds:
type: object
title: NullableInt64Slice
properties:
'Null':
type: boolean
Set:
type: boolean
Value:
type: array
items:
type: integer
secureContent:
type: boolean
sendDiff:
type: boolean
tagIds:
type: array
items:
type: integer
type:
type: string
Output
type: object
title: Response
properties:
included:
type: object
properties:
companies:
type: object
notebookCategories:
type: object
projects:
type: object
tags:
type: object
teams:
type: object
users:
type: object
notebook:
type: object
title: Notebook
properties:
category:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
categoryId:
type: integer
changeFollowers:
type: object
title: UserGroupsDeprecated
properties:
companies:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
companyIds:
type: array
items:
type: integer
teamIds:
type: array
items:
type: integer
teams:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
userIds:
type: array
items:
type: integer
users:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
commentFollowers:
type: object
title: UserGroupsDeprecated
properties:
companies:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
companyIds:
type: array
items:
type: integer
teamIds:
type: array
items:
type: integer
teams:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
userIds:
type: array
items:
type: integer
users:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
commentsCount:
type: integer
contentHTML:
type: string
contents:
description: can be optionally hidden on lists
type: string
createdAt:
type: string
createdBy:
type: integer
createdByUserID:
type: integer
dateCreated:
type: string
dateDeleted:
type: string
dateUpdated:
type: string
deleted:
type: boolean
deletedAt:
type: string
deletedBy:
type: integer
deletedByUserID:
type: integer
description:
type: string
id:
type: integer
isFullWidth:
type: boolean
isPrivate:
type: boolean
latestVersionNo:
type: integer
lockdown:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
lockdownId:
type: integer
locked:
type: boolean
lockedAt:
type: string
lockedBy:
type: integer
name:
type: string
notebookVersion:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
notebookVersionCreatedDateTime:
type: string
notebookVersionID:
type: integer
notebookVersionUpdatedDateTime:
type: string
privacy:
type: object
title: UserGroupsDeprecated
properties:
companies:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
companyIds:
type: array
items:
type: integer
teamIds:
type: array
items:
type: integer
teams:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
userIds:
type: array
items:
type: integer
users:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
project:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
projectId:
type: integer
readCommentsCount:
type: integer
secureContent:
type: boolean
tagIds:
type: array
items:
type: integer
tags:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
type:
type: string
updatedAt:
type: string
updatedBy:
type: integer
updatedByUserID:
type: integer
userFollowingChanges:
type: boolean
userFollowingComments:
type: boolean
versionCount:
type: integer