Query Plug-in Input Configuration

Updated on 2023-11-28 GMT+08:00

View PDF

Function

URI

POST /v1/{domain_id}/agent-plugin/plugin-input

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Tenant ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
[items]	No	Array of PluginPartQueryDTO objects	Query Request Body

**Table 4** PluginPartQueryDTO
Parameter	Mandatory	Type	Description
plugin_name	No	String	Plug-in name
display_name	No	String	Display Name
version	No	String	Version
plugin_attribution	No	String	Plug-in Attribute
version_attribution	No	String	Version Attribute

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
[items]	Array of PluginPartQueryVOListAgentPluginInputVO objects	OK

**Table 6** PluginPartQueryVOListAgentPluginInputVO
Parameter	Type	Description
plugin_name	String	Plug-in
display_name	String	Display Name
data	Array of data objects	Viewing execution results

**Table 7** data
Parameter	Type	Description
unique_id	String	Unique ID
name	String	Name
default_value	String	Default Value
plugin_name	String	Plug-in
version	String	Version
type	String	Type
workspace_id	String	Indicates the tenant ID.
validation	ExtensionValidation object	Verification
layout_content	String	Style Information

**Table 8** ExtensionValidation
Parameter	Type	Description
required_message	String	Message
regex	String	Regex
regex_message	String	Regular Message
max_length	Integer	Maximum length
min_length	Integer	Minimum Length

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Error Message
error_code	String	Error code.

Example Requests

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/plugin-input

[ {
  "plugin_name" : "official_shell_plugin",
  "display_name" : "Executing the Shell",
  "version" : "0.0.2",
  "plugin_attribution" : "official",
  "version_attribution" : "formal"
} ]

Example Responses

Status code: 200

[ {
  "plugin_name" : "official_shell_plugin",
  "display_name" : "Executing the Shell",
  "data" : [ {
    "unique_id" : "aac7e571b0d4462ba7962ce1735c4ec3",
    "name" : "OFFICIAL_SHELL_SCRIPT_INPUT",
    "default_value" : "",
    "plugin_name" : "official_shell_plugin",
    "version" : "0.0.2",
    "type" : "shell",
    "workspace_id" : "*",
    "layout_content" : null,
    "front_data_prop" : null,
    "label" : "Shell Commands",
    "description" : "The user enters the shell command here.",
    "required" : "true",
    "extend_prop" : {
      "api_options" : null,
      "api_type" : null,
      "options" : null,
      "disabled_conditions" : null,
      "visible_conditions" : null
    },
    "validation" : {
      "required_message" : null,
      "regex" : null,
      "regex_message" : null,
      "max_length" : null,
      "min_length" : null
    }
  } ]
} ]