Skip to content

Latest commit

 

History

History
114 lines (85 loc) · 3.75 KB

notebooks.md

File metadata and controls

114 lines (85 loc) · 3.75 KB

Notebooks Actions

Details on the various actions that can be performed on the Notebooks resource, including the expected parameters and the potential responses.

Contents

Get

Returns the notebooks for an application

var params = {
  applicationId: myApplicationId
};

// with callbacks
client.notebooks.get(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.notebooks.get(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. 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.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated, lastExecutionRequested name name
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name name
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*notebook
losantdomain string N Domain scope of request (rarely needed) example.com

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

var params = {
  applicationId: myApplicationId,
  notebook: myNotebook
};

// with callbacks
client.notebooks.post(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.notebooks.post(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, notebooks.*, or notebooks.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
notebook Notebook Post Y New notebook information Notebook Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

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