Jump to

• Request
• Response

Retrieve the cloned notebook data for the notebook template name

get

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

This endpoint fetches the cloned notebook name corresponding to the user for the notebook template.It there is not yet a copy (clone) of the notebook for the user, then this API will internallly invoke the data studio api to create a clone of the notebook for the user and get the name of the cloned notebook. If thereis one already present for the user, it returns the one.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• notebookName(optional): array
  Collection Format: multi

  The list of notebook names

  • [0]: string

  {
      "name":"notebookName",
      "in":"query",
      "description":"The list of notebook names",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object MyNotebookInfo
  Model class for holding the Notebook information for the user. This will hold the owners copy (clone) notebook details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MyNotebookInfo"
    }
}

Nested 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