Querying Basic Plug-in Details
Function
Querying Basic Plug-in Details
URI
GET /v3/{domain_id}/extension/detail
Parameter | Mandatory | Type | Description |
|---|---|---|---|
domain_id | Yes | String | Indicates the tenant ID. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
plugin_name | No | String | Plug-in name |
version | No | String | Version |
Request 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). |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
type | String | Type |
name | String | Name |
friendly_name | String | Display Name |
category | String | Service Type |
description | String | Description |
version | String | Version |
version_description | String | Change History |
inputs | Array of inputs objects | Entering information |
outputs | Array of outputs objects | Output |
execution | execution object | Execution Information |
Parameter | Type | Description |
|---|---|---|
name | String | Name |
type | String | Type |
label | String | Label |
description | String | Description |
default_value | String | Default Value |
required | Boolean | This parameter is mandatory. |
extend_prop | ExtensionExtendProp object | Extended Attributes |
validation | ExtensionValidation object | Verification |
Parameter | Type | Description |
|---|---|---|
api_options | String | API Options |
api_type | String | API Type |
options | String | Parameter |
disabled_conditions | String | Disabling Condition |
visible_conditions | String | Visible Condition |
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 |
Parameter | Type | Description |
|---|---|---|
target | String | Entry for creating a table |
type | String | Type |
sha256 | String | sha256 |
Status code: 400
Parameter | Type | Description |
|---|---|---|
error_msg | String | Error Message |
error_code | String | Error code. |
Example Requests
GET https://{endpoint}/v3/ce8df55870164338a72d7e828a966a2a/extension/detail?plugin_name=basic-CTS&version=2.3.5 Example Responses
Status code: 200
OK
{
"type" : "Task",
"name" : "basic-CTS",
"category" : "Test",
"description" : "",
"version" : "2.3.5",
"inputs" : [ {
"name" : "SHELL_PLUGIN",
"type" : "input",
"label" : "Single-line Text Box",
"description" : "Sample String",
"required" : true,
"validation" : {
"required_message" : null,
"regex" : null,
"regex_message" : null,
"max_length" : null,
"min_length" : null
},
"default_value" : "",
"extend_prop" : {
"api_options" : null,
"api_type" : null,
"options" : null,
"disabled_conditions" : null,
"visible_conditions" : null
}
} ],
"outputs" : [ {
"name" : "problem",
"type" : "output",
"description" : "Number of recorded problems"
} ],
"execution" : {
"type" : "scripts/test.sh",
"target" : "Shell",
"sha256" : "4fa52dab3fb72847e4da5f00295a96fce8892f301d384efe9b776aa1731ba8f0"
},
"friendly_name" : "Basic plug-in - CTS2",
"version_description" : "Running Shell Commands"
} Status Codes
Status Code | Description |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
