Server Queries

Queries are used to obtain information about a project. This includes project details, settings and status, project tree, and actor properties and status. Queries must be in JSON format. The general query template is as follows (<> is optional and/or query specific):

{ "What": "QUERY"<, specific command arguments><, "Password": "password"> }

The following commands are supported:

  • ACTOR_INFO

    Produces specific actor info, including name, type and run status. The request must contain the uid entry.

    { "What": "ACTOR_INFO", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95" }

  • ACTOR_INTERNAL_VARIABLES

    Obtains currently registered internal variables for a certain (integration) actor. The request must contain the uid entry. The args entry is optional and can contain an optional include_reference_values entry. If include_reference_values is set to true (default), the response will contain the according reference value.

    { "What": "ACTOR_INTERNAL_VARIABLES", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "args": { "include_reference_values": true } }

  • ACTOR_PROPERTIES

    Produces actor properties for a certain actor. The request must contain the uid entry.

    { "What": "ACTOR_PROPERTIES", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95" }

  • ACTOR_REGISTERED_INPUT_SLOTS

    Obtains currently registered input slots for a certain (integration) actor. The request must contain the uid entry. The args entry is optional and can contain an optional include_reference_values entry. If include_reference_values is set to true (default), the response will contain the according reference value.

    { "What": "ACTOR_REGISTERED_INPUT_SLOTS", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "args": { "include_reference_values": true } }

  • ACTOR_REGISTERED_OUTPUT_SLOTS

    Obtains currently registered output slots for a certain (integration) actor. The request must contain the uid entry. The args entry is optional and can contain an optional include_reference_values entry. If include_reference_values is set to true (default), the response will contain the according reference value.

    { "What": "ACTOR_REGISTERED_OUTPUT_SLOTS", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "args": { "include_reference_values": true } }

  • ACTOR_REGISTERED_PARAMETERS

    Obtains currently registered parameters for a certain (integration) actor. The request must contain the uid entry. The args entry is optional and can contain an optional include_reference_values entry. If include_reference_values is set to true (default), the response will contain the according reference value.

    { "What": "ACTOR_REGISTERED_PARAMETERS", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "args": { "include_reference_values": true } }

  • ACTOR_REGISTERED_RESPONSES

    Obtains currently registered responses for a certain (integration) actor. The request must contain the uid entry. The args entry is optional and can contain an optional include_reference_values entry. If include_reference_values is set to true (default), the response will contain the according reference value.

    { "What": "ACTOR_REGISTERED_RESPONSES", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "args": { "include_reference_values": true } }

  • ACTOR_STATES

    Produces available actor states for a certain actor. No status info is included, only the IDs of the available states. These can be used in conjunction with ACTOR_STATUS_INFO to obtain actor status info for a specific state ID. The request must contain the uid entry.

    { "What": "ACTOR_STATES", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95" }

  • ACTOR_STATUS_INFO

    Produces specific actor status info for a certain state. The request must contain the uid and hid entries.

    { "What": "ACTOR_STATUS_INFO", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "hid": "0.1" }

  • ACTOR_SUPPORTS

    Produces actor supported features for a certain actor. The request must contain the uid and args entries, containing the feature name feature.

    { "What": "ACTOR_SUPPORTS", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "args": { "feature": "CAN_FINALIZE" } }

  • AVAILABLE_INPUT_LOCATIONS

    Obtains available input locations for a certain (integration) actor, if supported by the actor. The request must contain the uid entry.

    { "What": "AVAILABLE_INPUT_LOCATIONS", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95" }

  • AVAILABLE_NODES

    Obtains all available workflow component node types, including plugin-based nodes.

    { "What": "AVAILABLE_NODES" }

  • AVAILABLE_OUTPUT_LOCATIONS

    Obtains available output locations for a certain (integration) actor, if supported by the actor. The request must contain the uid entry.

    { "What": "AVAILABLE_OUTPUT_LOCATIONS", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95" }

  • BASIC_PROJECT_INFO

    Produces basic project info, like name, location, global settings and status.

    { "What": "BASIC_PROJECT_INFO" }

  • DOE_SIZE

    Produces the DOE size based on the given sampling type and number of levels for a specific actor. The request must contain the uid entry.

    { "What": "DOE_SIZE", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "args": { "num_discrete_levels": 2, "sampling_type": "fullfactorial" } }

  • FULL_PROJECT_STATUS_INFO

    Produces full project status info, including all systems and actors.

    { "What": "FULL_PROJECT_STATUS_INFO" }

  • FULL_PROJECT_TREE

    Produces full project tree, including all system and actor names and IDs. No status info is included.

    { "What": "FULL_PROJECT_TREE" }

  • FULL_PROJECT_TREE_WITH_PROPERTIES

    Produces full project tree, including all system and actor names, IDs and properties. No status info is included.

    { "What": "FULL_PROJECT_TREE_WITH_PROPERTIES" }

  • GET_CRITERIA

    Gets information about all existing criterion from the system. The request must consist of actor_uid.

    {"What": "GET_CRITERIA", "uid": "8d6a661e-a8d3-4177-b69b-e0d7c87f8e28"}

  • GET_CRITERION

    Gets existing criterion from the system. The request must consist of actor_uid as well as the args entry, containing the argument name of the criterion.

    {"What": "GET_CRITERION", "uid": "8d6a661e-a8d3-4177-b69b-e0d7c87f8e28", "args": {"name": "obj2"}}

  • HPC_LICENSING_FORWARDED_ENVIRONMENT

    Produces HPC licensing forwarded environment for certain actor. The request must contain the uid entry.

    { "What": "HPC_LICENSING_FORWARDED_ENVIRONMENT ", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95" }

  • INPUT_SLOT_VALUE

    Produces actor input slot value for a certain actor. The request must contain the uid, hid, and slot_name entries.

    { "What": "INPUT_SLOT_VALUE", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "hid": "0.1", "slot_name": "IDesign" }

  • OUTPUT_SLOT_VALUE

    Produces actor output slot value for a certain actor. The request must contain the uid, hid, and slot_name entries.

    { "What": "OUTPUT_SLOT_VALUE", "uid": "5cdfb20b-bef6-4412-9985-89f5ded5ee95", "hid": "0.1", "slot_name": "ODesign" }

  • PROJECT_TREE_SYSTEMS

    Produces full project tree, including systems only. No status info is included.

    { "What": "PROJECT_TREE_SYSTEMS" }

  • PROJECT_TREE_SYSTEMS_WITH_PROPERTIES

    Produces full project tree, including systems only and related properties. No status info is included.

    { "What": "PROJECT_TREE_SYSTEMS_WITH_PROPERTIES" }

  • SERVER_INFO

    Produces comprehensive information about the application (version), the server configuration (host_name, host_domain, server_address, server_port, server_protocol) and the open projects (location, name, states).

    { "What": "SERVER_INFO" }

  • SERVER_IS_ALIVE

    Produces a success message if the server is accessible.

    { "What": "SERVER_IS_ALIVE" }

  • SYSTEMS_STATUS_INFO

    Produces full project status info, including systems only.

    { "What": "SYSTEMS_STATUS_INFO" }