Commands

Functions for constructing any arbitrary CyREST API or Commands API method via standard GET, PUT, POST and DELETE protocols. These functions handle marshalling and unmarshalling of urls, parameters and returns so that higher-level functions can work with Python-friendly arguments and returns.

  1. CyREST API functions

  2. Commands API functions

  3. Internal functions

CyREST API

cyrest_delete([operation, parameters, …])

Construct a query, make DELETE call and process the result.

cyrest_get([operation, parameters, …])

Construct a query, make GET call and process the result.

cyrest_post([operation, parameters, body, …])

Construct a query and body, make POST call and process the result.

cyrest_put([operation, parameters, body, …])

Construct a query and body, make PUT call and process the result.

Cytoscape Commands API

commands_get(cmd_string[, base_url])

Commands GET.

commands_help([cmd_string, base_url])

Commands Help.

commands_post(cmd[, base_url])

Commands POST.

commands_run(cmd_string[, base_url])

Run a Command.

Cytoscape Commands

command_echo([variable_name, base_url])

Command Echo.

command_open_dialog([base_url])

Command Open Dialog.

command_pause([message, base_url])

Command Pause.

command_quit([base_url])

Command Quit.

command_run_file(file[, args, base_url])

Command Run File.

command_sleep([duration, base_url])

Command Sleep.

Swagger API-level Documentation

commands_api([base_url])

Open Swagger docs for CyREST Commands API.

cyrest_api([base_url])

Open Swagger docs for CyREST API.