Skip to content
On-premise users: click in-app to access the full platform documentation for your version of DataRobot.
DataRobot API resources > API reference documentation > DataRobot REST API > Developer tools > Notebooks

Notebooks

This page outlines the operations, endpoints, parameters, and example requests and responses for the Notebooks.

GET /api/v2/notebooks/sharedRoles/

Get a lists of users who have access to each notebook and their roles on each respective notebook.

Code samples

curl -X GET https://app.datarobot.com/api/v2/notebooks/sharedRoles/?notebookIds=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
notebookIds query array[string] true Comma separated notebook IDs to get info of.

Example responses

200 Response

{
  "data": [
    {
      "notebookId": "string",
      "roles": [
        {
          "id": "string",
          "name": "string",
          "role": "ADMIN",
          "shareRecipientType": "user"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Access control list for each notebook keyed by notebook ID. NotebooksSharedRolesListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/notebooks/{notebookId}/sharedRoles/

Get a list of users and their roles who have access to this notebook.

Code samples

curl -X GET https://app.datarobot.com/api/v2/notebooks/{notebookId}/sharedRoles/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over.
limit query integer false The number of records to return.
notebookId path string true The ID of the notebook.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Access control list for a notebook. SharingListV2Response

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

AccessControlV2

{
  "id": "string",
  "name": "string",
  "role": "ADMIN",
  "shareRecipientType": "user"
}

Properties

Name Type Required Restrictions Description
id string true The identifier of the recipient.
name string true The name of the recipient.
role string true The role of the recipient on this entity.
shareRecipientType string true The type of the recipient.

Enumerated Values

Property Value
role [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER]
shareRecipientType [user, group, organization]

MultipleNotebooksSharedRole

{
  "notebookId": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ]
}

Properties

Name Type Required Restrictions Description
notebookId string true The ID of the notebook.
roles [NotebookSharedRole] true Individual roles data for the notebook.

NotebookSharedRole

{
  "id": "string",
  "name": "string",
  "role": "ADMIN",
  "shareRecipientType": "user"
}

Properties

Name Type Required Restrictions Description
id string true The identifier of the recipient.
name string true The name of the recipient.
role string true The role of the recipient on this entity.
shareRecipientType string true The recipient type.

Enumerated Values

Property Value
role [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER]
shareRecipientType user

NotebooksSharedRolesListResponse

{
  "data": [
    {
      "notebookId": "string",
      "roles": [
        {
          "id": "string",
          "name": "string",
          "role": "ADMIN",
          "shareRecipientType": "user"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
data [MultipleNotebooksSharedRole] true maxItems: 100
 Roles data for multiple notebooks.

SharingListV2Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "ADMIN",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true The number of items returned.
data [AccessControlV2] true maxItems: 1000
 The access control list.
next string,null true URL pointing to the next page.
previous string,null true URL pointing to the previous page.
totalCount integer true Total number of items matching the condition.