result

The result returned by this service is an ordered list of objects that denote an action with action attribute along and result stored under data attribute.

The list allows for multiple actions to be returned.

For details on the format of values in data field, click the Example link next to each action below.

[ 
   {
      "action": "addNetworks|updateNetwork|addTables|updateTables|updateLayouts|updateSelection|openURL",
      "data" : <response data for action>
   }
]

action

Must correspond to entry in cyWebActions list and denotes what to perform. Information about these actions and examples can be found here:

• addNetworks: Add the given networks to the current workspace. Example

• updateNetwork: Update the current network in the workspace. Example

• addTables: TO BE ADDED IN FUTURE Add new tables to the workspace. Example

• updateTables: Update existing tables in the workspace. Example

• updateLayouts: Update the layouts of the current network in the workspace. Example

• updateSelection: Update the current network selection states of nodes and edges. Example

• openURL: Open URL in a new tab in the browser Example

data

The data to return with each action.

• addNetworks and updateNetwork: Is a list of CX2 networks or a single CX2 network respectively

• updateTables and addTables: Is a JSON of this format:

  todo

• updateLayouts:

• updateSelection:

• openURL:

See action section above for examples