API Data Provider - Online Help

Notebooks

Returns the list of notebooks in your organization.

Columns

Name Type ReadOnly References Description
NotebookId [KEY] String True

Notebook ID

NoteBookType String False

Type of the Notebook resource.

NotebookName String False

Notebook name

Status String True

Notebook status

The allowed values are published, unpublished.

CreatedAt Datetime True

Creation timestamp (ISO 8601)

ModifiedAt Datetime True

Modification timestamp (ISO 8601)

Author String True

Author user object with name, handle, email

Cells String False

List of cells to display in the notebook.

Metadata String True

Metadata associated with the notebook.

Time String False

Notebook global timeframe.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
AuthorHandle String

Return notebooks created by the given author_handle.

ExcludeAuthorHandle String

Return notebooks not created by the given author_handle.

IncludeCells Boolean

Value of false excludes the cells and global time for each notebook.

IsTemplate Boolean

True value returns only template notebooks. Default is false (returns only non-template notebooks).

FilterQuery String

Return only notebooks with query string in notebook name or author handle.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0