Jump to

• Request
• Response

Retrieve the notebook information for the notebook

get

/ohfapi/cg/v3.3/datastudio/notebook/clone

This endpoint fetches the notebook information for the notebook. It invokes the data studio applicationand fetches the notebook details, if the user has permission to the notebook.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• notebookName(optional): string
  Name of the notebook

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : MyNotebookInfo

Type: object

Model class for holding the Notebook information for the user. This will hold the owners copy (clone) notebook details

Show Source

• notebookId(optional): string
  The notebook id. This will the owners copy.
• notebookName(optional): string
  The notebook name. Example : patient-journey , patients-like-mine
• userName(optional): string
  The owner of the notebook.

{
    "type":"object",
    "properties":{
        "notebookId":{
            "type":"string",
            "description":"The notebook id. This will the owners copy."
        },
        "userName":{
            "type":"string",
            "description":"The owner of the notebook."
        },
        "notebookName":{
            "type":"string",
            "description":"The notebook name. Example : patient-journey , patients-like-mine"
        }
    },
    "description":"Model class for holding the Notebook information for the user. This will hold the owners copy (clone) notebook details"
}

400 Response

Invalid parameters supplied

Back to Top