Querying the Basic Extension Details

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

plugin_name

Yes

String

Definition:

Extension name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

version

Yes

String

Definition:

Extension version.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

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

type

String

Definition:

Extension type.

Value range:

N/A

name

String

Definition:

Extension name.

Value range:

N/A

friendly_name

String

Definition:

Displayed extension name.

Value range:

N/A

category

String

Definition:

Service type.

Value range:

N/A

description

String

Definition:

Extension description.

Value range:

N/A

version

String

Definition:

Extension version.

Value range:

N/A

version_description

String

Definition:

Extension version description.

Value range:

N/A

inputs

Array of inputs objects

Definition:

Input information.

Value range:

N/A

data_source_bindings

Array of data_source_bindings objects

Definition:

Data source information.

Value range:

N/A

outputs

Array of outputs objects

Definition:

Output information.

Value range:

N/A

execution

execution object

Definition:

Extension type.

Value range:

N/A

name

String

Definition:

Name.

Value range:

N/A

type

String

Definition:

Type.

Value range:

N/A

label

String

Definition:

Label.

Value range:

N/A

description

String

Definition:

Description.

Value range:

N/A

default_value

String

Definition:

Default value.

Value range:

N/A

required

Boolean

Definition:

Mandatory or not.

Value range:

• true: mandatory.

• false: optional.

extend_prop

ExtensionExtendProp object

Definition:

Extended attributes.

Value range:

N/A

validation

ExtensionValidation object

Definition:

Verification details.

Value range:

N/A

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

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

target

String

Definition:

Destination address.

Value range:

N/A

endpointId

String

Definition:

Endpoint ID.

Value range:

N/A

data_source_name

String

Definition:

Name of the bound data source.

Value range:

N/A

name

String

Definition:

Name.

Value range:

N/A

type

String

Definition:

Type.

Value range:

N/A

description

String

Definition:

Description.

Value range:

N/A

prop

Map<String,String>

Definition:

Extended information.

Value range:

N/A

target

String

Definition:

Location of the executable file.

Value range:

N/A.

type

String

Definition:

Extension type.

Value range:

N/A

sha256

String

Definition:

SHA-256.

Value range:

N/A

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found