Skip to content

Latest commit

 

History

History
307 lines (179 loc) · 9.62 KB

UniversalConnectorManagerApi.md

File metadata and controls

307 lines (179 loc) · 9.62 KB

.UniversalConnectorManagerApi

All URIs are relative to http://localhost

Method HTTP request Description
universalConnectorManagerGetCertificate GET /api/v3/certificates Summary: Get certificate Description: Get the certificate that allows secure communication between data sources and universal connections in GDSC.
universalConnectorManagerGetConnectors GET /api/v3/connectors Summary: Get connectors Description: Get all the connectors Universal Connector can support. Includes a list of event pipelines (input--filter pairs), along with the supported data source types and platforms.
universalConnectorManagerGetUCSetup GET /api/v3/universal_connections/configurations/{plugin_id} Gets information to setup the new Universal connection.
universalConnectorManagerListConnectionsSummary GET /api/v3/universal_connections Summary: List connections summary Description: List a summary of Universal Connector configured connections (AKA datasources).
universalConnectorManagerPluginsList GET /api/v3/plugins Summary: Plugins list Description: List of all universal connector plugins.
universalConnectorManagerUploadPlugin POST /api/v3/plugins Summary: Upload plugin Description: Upload a plugin-package for Universal Connector.

universalConnectorManagerGetCertificate

Universalconnectormanagerv3FileResponse universalConnectorManagerGetCertificate()

Example

import { createConfiguration, UniversalConnectorManagerApi } from '';

const configuration = createConfiguration();
const apiInstance = new UniversalConnectorManagerApi(configuration);

const request = {};

const data = await apiInstance.universalConnectorManagerGetCertificate(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

Universalconnectormanagerv3FileResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

universalConnectorManagerGetConnectors

Universalconnectormanagerv3GetConnectorsResponse universalConnectorManagerGetConnectors()

Example

import { createConfiguration, UniversalConnectorManagerApi } from '';

const configuration = createConfiguration();
const apiInstance = new UniversalConnectorManagerApi(configuration);

const request = {};

const data = await apiInstance.universalConnectorManagerGetConnectors(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

Universalconnectormanagerv3GetConnectorsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

universalConnectorManagerGetUCSetup

Universalconnectormanagerv3GetUCSetupResponse universalConnectorManagerGetUCSetup()

Example

import { createConfiguration, UniversalConnectorManagerApi } from '';
import type { UniversalConnectorManagerApiUniversalConnectorManagerGetUCSetupRequest } from '';

const configuration = createConfiguration();
const apiInstance = new UniversalConnectorManagerApi(configuration);

const request: UniversalConnectorManagerApiUniversalConnectorManagerGetUCSetupRequest = {
    // UC plugin id.
  pluginId: 1,
};

const data = await apiInstance.universalConnectorManagerGetUCSetup(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
pluginId [number] UC plugin id. defaults to undefined

Return type

Universalconnectormanagerv3GetUCSetupResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

universalConnectorManagerListConnectionsSummary

Universalconnectormanagerv3ListConnectionsResponse universalConnectorManagerListConnectionsSummary()

Example

import { createConfiguration, UniversalConnectorManagerApi } from '';

const configuration = createConfiguration();
const apiInstance = new UniversalConnectorManagerApi(configuration);

const request = {};

const data = await apiInstance.universalConnectorManagerListConnectionsSummary(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

Universalconnectormanagerv3ListConnectionsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

universalConnectorManagerPluginsList

Universalconnectormanagerv3PluginsListResponse universalConnectorManagerPluginsList()

Example

import { createConfiguration, UniversalConnectorManagerApi } from '';

const configuration = createConfiguration();
const apiInstance = new UniversalConnectorManagerApi(configuration);

const request = {};

const data = await apiInstance.universalConnectorManagerPluginsList(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

Universalconnectormanagerv3PluginsListResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

universalConnectorManagerUploadPlugin

RpcStatus universalConnectorManagerUploadPlugin(universalconnectormanagerv3UploadPluginRequest)

Example

import { createConfiguration, UniversalConnectorManagerApi } from '';
import type { UniversalConnectorManagerApiUniversalConnectorManagerUploadPluginRequest } from '';

const configuration = createConfiguration();
const apiInstance = new UniversalConnectorManagerApi(configuration);

const request: UniversalConnectorManagerApiUniversalConnectorManagerUploadPluginRequest = {
  
  universalconnectormanagerv3UploadPluginRequest: {
    pluginId: "pluginId_example",
  },
};

const data = await apiInstance.universalConnectorManagerUploadPlugin(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
universalconnectormanagerv3UploadPluginRequest Universalconnectormanagerv3UploadPluginRequest

Return type

RpcStatus

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]