Query Extension Input Configuration

Function

This API is used to query extension input configuration.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for . Constraints: N/A Value range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
[items]	No	Array of PluginPartQueryDTO objects	Definition: Request body for querying the extension input. Constraints: N/A Value range: N/A Default value: N/A

**Table 4** PluginPartQueryDTO
Parameter	Mandatory	Type	Description
plugin_name	Yes	String	Definition: Extension name. Constraints: N/A Value range: N/A Default value: N/A
display_name	Yes	String	Definition: Display name. Constraints: N/A Value range: N/A Default value: N/A
version	Yes	String	Definition: Version number. Constraints: N/A Value range: N/A Default value: N/A
plugin_attribution	Yes	String	Definition: Extension attribute. Constraints: N/A Value range: custom: custom extension. official: official extension. Default value: N/A
version_attribution	No	String	Definition: Version attribute. Constraints: N/A Value range: - draft: draft version. - formal: formal version. Default value: N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
[items]	Array of PluginPartQueryVOListAgentPluginInputVO objects	Parameter description: List of extension input configurations. Constraints: N/A.

**Table 6** PluginPartQueryVOListAgentPluginInputVO
Parameter	Type	Description
plugin_name	String	Definition: Extension name. Value range: 1 to 50 characters.
display_name	String	Definition: Displayed extension name. Value range: N/A
data	Array of data objects	Definition: Details of the extension input item. Value range: N/A

**Table 7** data
Parameter	Type	Description
unique_id	String	Definition: ID of the extension input item. Value range: N/A
name	String	Definition: Name of the extension input item. Value range: N/A
default_value	String	Definition: Default value of the extension input item. Value range: N/A
plugin_name	String	Definition: Extension name. Value range: N/A
version	String	Definition: Extension version. Value range: N/A
type	String	Definition: Type of the extension input item. Value range: N/A
workspace_id	String	Definition: Tenant ID, that is, domain ID of a user. Range: The value consists of 32 characters, including digits and letters.
validation	ExtensionValidation object	Definition: Validation information of the extension input item. Value range: N/A
layout_content	String	Definition: Style information of the extension input item. Value range: N/A
extend_prop	ExtensionExtendProp object	Definition: Extended information in extension input. Value range: N/A
front_data_prop	String	Definition: Data used for frontend rendering. Value range: N/A
label	String	Definition: Tag. Value range: N/A
description	String	Definition: Description. Value range: N/A
required	String	Definition: Mandatory or not. Value range: N/A

**Table 8** ExtensionValidation
Parameter	Type	Description
required_message	String	Definition: Message displayed when the extension input item is mandatory but is not set. Value range: N/A
regex	String	Definition: Regular expression used to verify the extension input value. Value range: N/A
regex_message	String	Definition: Message displayed when the value of an extension input item does not meet the regular expression requirement. Value range: N/A
max_length	Integer	Definition: Maximum length of an extension input value. Value range: N/A
min_length	Integer	Definition: Minimum length of an extension input value. Value range: N/A

**Table 9** ExtensionExtendProp
Parameter	Type	Description
api_options	String	Definition: API option. Value range: N/A
api_type	String	Definition: API type. Value range: N/A
show_placeholder	String	Definition: Placeholder. Value range: N/A
options	String	Definition: Option. Value range: N/A
disabled_conditions	String	Definition: Conditions for disabling an extension. Value range: N/A
visible_conditions	String	Definition: Visible condition. Value range: N/A

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

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
    }
  } ]
} ]