docs/notebook.md in losant_rest-1.16.5 vs docs/notebook.md in losant_rest-1.16.6
- old
+ new
@@ -4,20 +4,63 @@
Notebook resource, including the expected
parameters and the potential responses.
##### Contents
+* [Cancel Execution](#cancel-execution)
* [Delete](#delete)
* [Execute](#execute)
* [Get](#get)
* [Logs](#logs)
* [Patch](#patch)
* [Request Input Data Export](#request-input-data-export)
* [Upload](#upload)
<br/>
+## Cancel Execution
+
+Marks a specific notebook execution for cancellation
+
+```ruby
+result = client.notebook.cancel_execution(
+ applicationId: my_application_id,
+ notebookId: my_notebook_id,
+ executionId: my_execution_id)
+
+puts result
+```
+
+#### 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, notebook.*, or notebook.execute.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
+| notebookId | string | Y | ID associated with the notebook | | 575ed78e7ae143cd83dc4aab |
+| executionId | undefined | Y | The ID of the execution to cancel | | 632e18632f59592e773a4153 |
+| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If the execution was successfully marked for cancellation |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if execution was not found |
+
+<br/>
+
## Delete
Deletes a notebook
```ruby
@@ -251,10 +294,10 @@
#### Successful Responses
| Code | Type | Description |
| ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If export request was accepted and successfully queued |
+| 200 | [Success With Job ID](_schemas.md#success-with-job-id) | If export request was accepted and successfully queued |
#### Error Responses
| Code | Type | Description |
| ---- | ---- | ----------- |