GetNotebookAndSubmitTask
Submits a task to schedule and run a Notebook file.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Path |
string |
Yes |
The path of the Notebook file. |
/Workspace/code/default/test.ipynb |
| Params |
string |
Yes |
The input parameters for the Notebook file. Pass the parameters in a dictionary format. |
{'dt': '2022-10-14'} |
| SessionId |
string |
Yes |
The session ID. |
8vkixxxxx*** |
| Retry |
integer |
No |
The number of retries if scheduling fails. |
true |
| WorkspaceId |
string |
No |
The workspace ID. |
8630242382**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| RequestId |
string |
The request ID. |
67E910F2-4B62-5B0C-ACA3-7547695C**** |
| Success |
boolean |
Indicates whether the request succedded. Valid values:
|
true |
| ErrMsg |
string |
The returned message. |
Request Invalid |
| TaskId |
string |
The ID of the scheduled task. |
IcICC2nbMpYp9KygS43n010100 |
| SessionId |
string |
The session ID. |
5zrs5szpiezlb9m3qxi6zp32h |
| Code |
string |
The status code. |
Success |
| HttpStatusCode |
integer |
HTTP status code. |
200 |
Examples
Success response
JSON format
{
"RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
"Success": true,
"ErrMsg": "Request Invalid",
"TaskId": "IcICC2nbMpYp9KygS43n010100",
"SessionId": "5zrs5szpiezlb9m3qxi6zp32h",
"Code": "Success",
"HttpStatusCode": 200
}Error codes
See for a complete list.
Release notes
See Release Notes for a complete list.