list

HTTP Request

GET /api/v1/workflows/:workflowReference/notebooks

Path parameters

Parameter

workflowReference

A qualified reference to the workflow. See referencing resources for more information.

Query parameters

Parameter

maxResults

Default 100. Must be less than 1000.

pageToken

For paginating through results, provide the value returned from the previous table.list call

This endpoint extends the general API structure.

Authorization

Only datasets to which you have overview access will be returned. If a dataset's overview is not public, your access token must have one of the following scopes:

  • workflow.read

Learn more about authorization.

Request body

The request body must be empty.

Response body

Returns a JSON representation of an array of notebook resources.

{
    "kind": "notebookList",
    "nextPageToken": string,
    "results": [
        object(notebook.list)
    ]
}

Examples

# List the notebooks at https://redivis.com/workflows/x7kh-5pvd4mbf1
curl -H "Authorization: Bearer $REDIVIS_ACCESS_TOKEN" \
"https://redivis.com/api/v1/workflows/imathews.example_worfklow_climate_analysis:x7kh/notebooks"

Last updated

Was this helpful?