본문으로 건너뛰기

ConnectorBuiltinTemplateResponse

Built-in connector template metadata exposed for connector creation UI.

is_builtinIs Builtin (boolean)
기본값: true
nameName (string)필수
description object
하나 이상(anyOf)
string
driver object

Bindable native driver id for a managed connector; send as ConnectorCreate.driver.

하나 이상(anyOf)
string
options object
property name*any
creation_options object[]

Creation-only option contract for managed connectors. Item defaults are persisted values; examples are non-value UI hints.

  • Array [
  • keyKey (string)필수
    kindKind (string)

    Possible values: [text, number, boolean, credential, headers, select]

    기본값: text
    requiredRequired (boolean)
    기본값: false
    label object
    하나 이상(anyOf)
    string

    Possible values: <= 200 characters

    help object
    하나 이상(anyOf)
    string

    Possible values: <= 1000 characters

    example object
    하나 이상(anyOf)
    string

    Possible values: <= 1000 characters

    default object
    하나 이상(anyOf)
    string
    choices object
    하나 이상(anyOf)
  • Array [
  • valueValue (string)필수

    Possible values: non-empty and <= 200 characters

    label object
    하나 이상(anyOf)
    string

    Possible values: <= 200 characters

  • ]
  • visible_if object
    하나 이상(anyOf)
    object
    min object
    하나 이상(anyOf)
    integer
    max object
    하나 이상(anyOf)
    integer
  • ]
  • packagesstring[]

    Packages already included in the immutable platform image

    metadata object
    하나 이상(anyOf)
    object
    options_spec object

    Driver-declared OPTIONS_SPEC, derived on read. Lets the creation UI render declared fields before a connector exists to read them from. Null for a driver without a declaration.

    하나 이상(anyOf)
  • Array [
  • keyKey (string)필수
    kindKind (string)

    Possible values: [text, number, boolean, credential, headers, select]

    기본값: text
    requiredRequired (boolean)
    기본값: false
    label object
    하나 이상(anyOf)
    string

    Possible values: <= 200 characters

    help object
    하나 이상(anyOf)
    string

    Possible values: <= 1000 characters

    example object
    하나 이상(anyOf)
    string

    Possible values: <= 1000 characters

    default object
    하나 이상(anyOf)
    string
    choices object
    하나 이상(anyOf)
  • Array [
  • valueValue (string)필수

    Possible values: non-empty and <= 200 characters

    label object
    하나 이상(anyOf)
    string

    Possible values: <= 200 characters

  • ]
  • visible_if object
    하나 이상(anyOf)
    object
    min object
    하나 이상(anyOf)
    integer
    max object
    하나 이상(anyOf)
    integer
  • ]
  • ConnectorBuiltinTemplateResponse
    {
    "is_builtin": true,
    "name": "string",
    "description": "string",
    "driver": "string",
    "options": {},
    "creation_options": [
    {
    "key": "string",
    "kind": "text",
    "required": false,
    "label": "string",
    "help": "string",
    "example": "string",
    "default": "string",
    "choices": [
    {
    "value": "string",
    "label": "string"
    }
    ],
    "visible_if": {},
    "min": 0,
    "max": 0
    }
    ],
    "packages": [
    "string"
    ],
    "metadata": {},
    "options_spec": [
    {
    "key": "string",
    "kind": "text",
    "required": false,
    "label": "string",
    "help": "string",
    "example": "string",
    "default": "string",
    "choices": [
    {
    "value": "string",
    "label": "string"
    }
    ],
    "visible_if": {},
    "min": 0,
    "max": 0
    }
    ]
    }