Skip to main content

Gets connector by script name

GET 

/connectors/:scriptName

Fetches a connector that using its script name.

Request

Path Parameters

    scriptName stringrequired

    The scriptName value of the connector. Scriptname is the unique id generated at connector creation.

Query Parameters

    locale string

    Possible values: [de, no, fi, sv, ru, pt, ko, zh-TW, en, it, fr, zh-CN, hu, es, cs, ja, pl, da, nl]

    The locale to apply to the config. If no viable locale is given, it will default to "en"

Responses

A Connector Dto object

Schema

    name string

    The connector name

    type string

    The connector type

    className string

    The connector class name

    scriptName string

    The connector script name

    applicationXml string

    The connector application xml

    correlationConfigXml string

    The connector correlation config xml

    sourceConfigXml string

    The connector source config xml

    sourceConfig string

    The connector source config

    sourceConfigFrom string

    The connector source config origin

    s3Location string

    storage path key for this connector

    uploadedFiles string[]nullable

    The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation.

    fileUpload boolean

    true if the source is file upload

    directConnect boolean

    true if the source is a direct connect source

    translationProperties

    object

    A map containing translation attributes by loacale key

    property name* any

    A map containing translation attributes by loacale key

    connectorMetadata

    object

    A map containing metadata pertinent to the UI to be used

    property name* any

    A map containing metadata pertinent to the UI to be used

    status string

    Possible values: [DEPRECATED, DEVELOPMENT, DEMO, RELEASED]

    The connector status

Loading...