Function getDataConnection

  • Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."

    Parameters

    • qID: string

      Connection ID

    • query: {
          byCredentialName?: boolean;
          credentialId?: string;
          extended?: boolean;
          noCache?: boolean;
          parseConnection?: boolean;
          spaceId?: string;
          type?: "connectionname";
      }

      an object with query parameters

      • OptionalbyCredentialName?: boolean

        If set to true, credentialId in the query will be interpreted as credential's name

      • OptionalcredentialId?: string

        Credential ID

      • Optionalextended?: boolean

        Returns extended list of properties (e.g. encrypted credential string) when set to true.

      • OptionalnoCache?: boolean

        datafiles connections will be returned from cache by default (if data-connections is configured to use cache), this query parameter is used disable this default behavior, e.g. return an update-to-date datafiles connection if the query is set to true

      • OptionalparseConnection?: boolean

        List of connection properties shall be returned when the query is set to true, default is false

      • OptionalspaceId?: string

        Filtering on connections by space ID

      • Optionaltype?: "connectionname"

        The connection ID in the path becomes a connection name when this query parameter is set.

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetDataConnectionHttpResponse>

    getDataConnection(
    "82ee7b44-0c4d-491b-bd38-82640c0430a5",
    {
    extended: false,
    type: "connectionname",
    credentialId: "22379dc5-076e-4fec-ae20-5529a8a57dc2",
    byCredentialName: false,
    spaceId: "611bcebaeec1203d88211ac4",
    noCache: false,
    parseConnection: true
    }
    )

    GetDataConnectionHttpError