collect_all_results
Retrieve all paginated data from the cBioPortal API by specifying an endpoint, method, and optional parameters. Streamlines access to cancer genomics data for comprehensive analysis.
Instructions
Delegate to utils.pagination.collect_all_results with api_client.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
endpoint | Yes | ||
json_data | No | ||
limit | No | ||
max_pages | No | ||
method | No | GET | |
params | No |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"properties": {
"endpoint": {
"title": "Endpoint",
"type": "string"
},
"json_data": {
"default": null,
"title": "Json Data"
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Limit"
},
"max_pages": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Pages"
},
"method": {
"default": "GET",
"title": "Method",
"type": "string"
},
"params": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Params"
}
},
"required": [
"endpoint"
],
"type": "object"
}