Notebooks Actions

https://api.app.wnology.io/applications/APPLICATION_ID/notebooks

Below are the various requests that can be performed against the Notebooks resource, as well as the expected parameters and the potential responses.

Get

Returns the notebooks for an application

Method And Url

GET https://api.app.wnology.io/applications/APPLICATION_ID/notebooks

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebooks.*, or notebooks.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated, lastExecutionRequested	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*notebook

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/applications/APPLICATION_ID/notebooks

Successful Responses

Code	Type	Description
200	Notebooks	Collection of notebooks

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Post

Create a new notebook for an application

Method And Url

POST https://api.app.wnology.io/applications/APPLICATION_ID/notebooks

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, notebooks.*, or notebooks.post.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Notebook Post schema. For example, the following would be a valid body for this request:

{
  "name": "Example Notebook"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"Example Notebook"}' \
    https://api.app.wnology.io/applications/APPLICATION_ID/notebooks

Successful Responses

Code	Type	Description
201	Notebook	Successfully created notebook

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

Notebook

Schema for a single Notebook

Notebook Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 13 keys
▶
id:{} 2 keys
▶
notebookId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
jupyterFileName:{} 3 keys
▶
jupyterFileUrl:{} 1 key
▶
imageVersion:{} 2 keys
▶
inputs:{} 2 keys
▶
outputs:{} 2 keys
▶
stats:{} 3 keys

Notebook Example

▶
(root){} 11 keys
id:"5c782b8d4f3a8e51c1db42e4"
notebookId:"5c782b8d4f3a8e51c1db42e4"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"Example Notebook"
jupyterFileName:"myNotebook.ipynb"
jupyterFileUrl:"https:/storage.example.com/myNotebook.ipynb"
▶
inputs:[] 5 items
▶
outputs:[] 9 items
▶
stats:{} 3 keys

Notebook Post

Schema for the body of an Notebook creation request

Notebook Post Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
imageVersion:{} 2 keys
▶
inputs:{} 2 keys
▶
outputs:{} 2 keys
additionalProperties:false
▶
required:[] 1 item

Notebook Post Example

▶
(root){} 1 key
name:"Example Notebook"

Notebooks

Schema for a collection of Notebooks

Notebooks Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
applicationId:{} 2 keys

Notebooks Example

▶
(root){} 8 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"name"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"