Method
describeGraphForDashboard GET
Copy GET

Describes a python plot to a graph dashboard

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes graphReferenceId str Unique string identifier for the python function id for the graph
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result PythonPlotFunction
KEY TYPE Description
notebookId str Unique string identifier of the notebook used to spin up the notebook upon creation.
name str The name used to identify the algorithm. Only uppercase letters, numbers, and underscores are allowed.
createdAt str Date and time when the Python function was created, in ISO-8601 format.
functionVariableMappings dict The mappings for function parameters' names.
functionName str The name of the Python function to be used.
pythonFunctionId str Unique string identifier of the Python function.
functionType str The type of the Python function.
plotName str Name of the plot.
graphReferenceId str Reference ID of the dashboard to the plot.
codeSource CodeSource Info about the source code of the Python function.
KEY TYPE Description
sourceType str The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR
sourceCode str If the type of the source is TEXT, the raw text of the function
applicationConnectorId str The Application Connector to fetch the code from
applicationConnectorInfo str Args passed to the application connector to fetch the code
packageRequirements list The pip package dependencies required to run the code
status str The status of the code and validations
error str If the status is failed, an error message describing what went wrong
publishingMsg dict Warnings in the source code
moduleDependencies list The list of internal modules dependencies required to run the code

Exceptions:

TYPE WHEN
DataNotFoundError

graphReferenceId is not found.
Language:

© Copyright