Report
Warning
The functions are not fully tested yet. Use with caution. Please report any issues to the GitHub repository.
report_create
report_create(workspace_id: str, display_name: str, report_path: str, description: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response
Create a report.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
workspace_id
|
str
|
The id of the workspace to create the report in. |
required |
display_name
|
str
|
The display name of the report. |
required |
report_path
|
str
|
The path to the report to load content from. |
required |
description
|
str | None
|
The description of the report. |
None
|
await_lro
|
bool | None
|
Whether to await the long running operation. |
None
|
timeout
|
int
|
Timeout for the long running operation (seconds). Defaults to 5 minutes. |
60 * 5
|
preview
|
bool
|
Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True. |
True
|
Returns:
| Type | Description |
|---|---|
Response
|
The response from the request. |
report_get
report_get(workspace_id: str, report_id: str, preview: bool = True) -> requests.Response
Get a report.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
workspace_id
|
str
|
The id of the workspace to get the report from. |
required |
report_id
|
str
|
The id of the report to get. |
required |
preview
|
bool
|
Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True. |
True
|
Returns:
| Type | Description |
|---|---|
Response
|
The response from the request. |
report_list
report_list(workspace_id: str, continuation_token: str = None, preview: bool = True) -> requests.Response
List reports for a workspace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
workspace_id
|
str
|
The id of the workspace to list reports for. |
required |
continuation_token
|
str | None
|
A token for retrieving the next page of results. |
None
|
preview
|
bool
|
Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True. |
True
|
Returns:
| Type | Description |
|---|---|
Response
|
The response from the request. |
report_update
report_update(workspace_id: str, report_id: str, display_name: str = None, description: str = None, preview: bool = True) -> requests.Response
Update a report.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
workspace_id
|
str
|
The id of the workspace to update. |
required |
report_id
|
str
|
The id of the report to update. |
required |
display_name
|
str | None
|
The display name of the report. |
None
|
description
|
str | None
|
The description of the report. |
None
|
preview
|
bool
|
Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True. |
True
|
Returns:
| Type | Description |
|---|---|
Response
|
The response from the request. |
report_delete
report_delete(workspace_id: str, report_id: str, preview: bool = True) -> requests.Response
Delete a report.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
workspace_id
|
str
|
The id of the workspace to delete. |
required |
report_id
|
str
|
The id of the report to delete. |
required |
preview
|
bool
|
Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True. |
True
|
Returns:
| Type | Description |
|---|---|
Response
|
The response from the request. |
report_get_definition
report_get_definition(workspace_id: str, report_id: str, format: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response
Get the definition of a report.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
workspace_id
|
str
|
The id of the workspace to get the report definition from. |
required |
report_id
|
str
|
The id of the report to get the definition from. |
required |
format
|
str | None
|
The format of the report definition. Supported format is "ipynb". |
None
|
await_lro
|
bool | None
|
Whether to await the long running operation. |
None
|
timeout
|
int
|
Timeout for the long running operation (seconds). Defaults to 5 minutes. |
60 * 5
|
preview
|
bool
|
Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True. |
True
|
Returns:
| Type | Description |
|---|---|
Response
|
The response from the request. |
report_update_definition
report_update_definition(workspace_id: str, report_id: str, report_path: str, update_metadata: bool = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response
Update the definition of a report.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
workspace_id
|
str
|
The id of the workspace to update. |
required |
report_id
|
str
|
The id of the report to update. |
required |
report_path
|
str
|
The path to the report to load content from. |
required |
update_metadata
|
bool | None
|
When set to true, the item's metadata is updated using the metadata in the .platform file. |
None
|
await_lro
|
bool | None
|
Whether to await the long running operation. |
None
|
timeout
|
int
|
Timeout for the long running operation (seconds). Defaults to 5 minutes. |
60 * 5
|
preview
|
bool
|
Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True. |
True
|
Returns:
| Type | Description |
|---|---|
Response
|
The response from the request. |