Service Metadata - cytoscape/cytoscape-web GitHub Wiki

Service Metadata has this structure and is returned by GET endpoint of Get Meta Data endpoint

   {
     "serviceInputDefinition": Object (SelectionMethod),
     "cyWebActions": [string],
     "cyWebMenuItem": Object (RootMenu),
     "name": string,
     "description": string,
     "showDescriptionInDialog": boolean,
     "author": string,
     "citation": string,
     "version": string,
     "parameters": [
       Object (Parameter)
     ]
   }

Fields:

  • serviceInputDefinition: Defines the input of the service-based app. This attribute describes how to assemble the data attribute in the request body when creating a task on the backend service.

  • cyWebActions: (Optional) The ordered list of actions that the caller should perform with the returned data. Actions can be following values: addNetworks|updateNetwork|addTables|updateTables|updateLayouts|updateSelection|openURL This is optional since the result is bundled with one or more actions, but this may be used in the future to filter apps by operations they provide.

  • cyWebMenuItem: An object that specifies how to create the menu item for this service.

  • name: Name of service-based app

  • description: Short description of service-based app

  • showDescriptionInDialog: If true, show description in dialog displayed to user when invoking service-based App otherwise do not

  • author: Author(s) of service-based app

  • citation: Citation or reference for service-based app

  • version: Version of service-based app

  • parameters: List of Parameter objects that caller can use to display service-based app specific UI to collect user input