Skip to content

Latest commit

 

History

History
103 lines (70 loc) · 2.07 KB

notebooks.md

File metadata and controls

103 lines (70 loc) · 2.07 KB

Notebooks

List All Notebooks

GET /notebooks.json

tw.notebooks.get({
	includeContent: true
})

List Notebooks on a Project

GET /projects/{project_id}/notebooks.json

tw.projects.getNotebooks(project_id, options)

List Notebooks in a specific category

GET /notebookCategories/{id}/notebooks.json

tw.notebookCategories.getNotebooks(category_id, options) 

Get a Single Notebook

GET /notebooks/{notebook_id}.json

tw.notebooks.get({}, notebook_id)

Create a Single Notebook

POST /projects/{project_id}/notebooks.json

tw.projects.createNotebook(project_id, {
	"notebook": {
		// --
	}
})

Update a Single Notebook

PUT /notebooks/{notebook_id}.json

tw.notebooks.update(notebook_id, {
	"notebook": {
		// --
	}
})

Lock a Single Notebook For Editing

PUT /notebooks/{id}/lock.json

tw.notebooks.lock(notebook_id)

Unlock a Single Notebook

PUT /notebooks/{id}/unlock.json

tw.notebooks.unlock(notebook_id)

Delete a Single Notebook

DELETE /notebooks/{id}.json

tw.notebooks.delete(notebook_id)

Copy a Notebook to another Project

PUT /notebooks/{notebook_id}/copy.json

tw.notebooks.copy(notebook_id, {
	// --
})

Move a Notebook to another Project

PUT /notebooks/{notebook_id}/move.json

tw.notebooks.move(notebook_id, {
	// --
})