Skip to content

Latest commit

 

History

History
236 lines (161 loc) · 6.51 KB

SinkApi.md

File metadata and controls

236 lines (161 loc) · 6.51 KB

OmniCoreModelAndStateManagementApi.SinkApi

All URIs are relative to https://api.korewireless.com

Method HTTP request Description
createSink POST /omnicore/subscriptions/{subscriptionId}/sinks
deleteSink DELETE /omnicore/subscriptions/{subscriptionId}/sinks/{sinkId}
getSink GET /omnicore/subscriptions/{subscriptionId}/sinks/{sinkId}
getSinks GET /omnicore/subscriptions/{subscriptionId}/sinks Get All Sinks

createSink

Sink createSink(subscriptionId, opts)

Create a Sink

Example

import OmniCoreModelAndStateManagementApi from 'omni_core_model_and_state_management_api';
let defaultClient = OmniCoreModelAndStateManagementApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new OmniCoreModelAndStateManagementApi.SinkApi();
let subscriptionId = "subscriptionId_example"; // String | Subscription ID
let opts = {
  'sink': new OmniCoreModelAndStateManagementApi.Sink() // Sink | 
};
apiInstance.createSink(subscriptionId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
subscriptionId String Subscription ID
sink Sink [optional]

Return type

Sink

Authorization

apiKey, bearerAuth

HTTP request headers

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

deleteSink

Object deleteSink(subscriptionId, sinkId)

Delete a Sink

Example

import OmniCoreModelAndStateManagementApi from 'omni_core_model_and_state_management_api';
let defaultClient = OmniCoreModelAndStateManagementApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new OmniCoreModelAndStateManagementApi.SinkApi();
let subscriptionId = "subscriptionId_example"; // String | Subscription ID
let sinkId = "sinkId_example"; // String | Sink ID
apiInstance.deleteSink(subscriptionId, sinkId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
subscriptionId String Subscription ID
sinkId String Sink ID

Return type

Object

Authorization

apiKey, bearerAuth

HTTP request headers

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

getSink

Sink getSink(subscriptionId, sinkId)

Get A Sink

Example

import OmniCoreModelAndStateManagementApi from 'omni_core_model_and_state_management_api';
let defaultClient = OmniCoreModelAndStateManagementApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new OmniCoreModelAndStateManagementApi.SinkApi();
let subscriptionId = "subscriptionId_example"; // String | Subscription ID
let sinkId = "sinkId_example"; // String | Sink ID
apiInstance.getSink(subscriptionId, sinkId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
subscriptionId String Subscription ID
sinkId String Sink ID

Return type

Sink

Authorization

apiKey, bearerAuth

HTTP request headers

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

getSinks

ListSinks getSinks(subscriptionId)

Get All Sinks

Get Sinks

Example

import OmniCoreModelAndStateManagementApi from 'omni_core_model_and_state_management_api';
let defaultClient = OmniCoreModelAndStateManagementApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new OmniCoreModelAndStateManagementApi.SinkApi();
let subscriptionId = "subscriptionId_example"; // String | Subscription ID
apiInstance.getSinks(subscriptionId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
subscriptionId String Subscription ID

Return type

ListSinks

Authorization

apiKey, bearerAuth

HTTP request headers

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