Skip to content

Latest commit

 

History

History
220 lines (131 loc) · 6.25 KB

QSDataManagerApi.md

File metadata and controls

220 lines (131 loc) · 6.25 KB

.QSDataManagerApi

All URIs are relative to http://localhost

Method HTTP request Description
qSDataManagerGetMasterData GET /api/v3/datamanager/master-data Summary: master data for all entities Description: Retrieves All Dimension and Fact tables data.
qSDataManagerGetPluginData GET /api/v3/datamanager/plugin Summary: Plugins Details Description: Retrieves All plugins information.
qSDataManagerRegisterScan POST /api/v3/datamanager/scan Summary: Insert ScanDetails Description: Register new data into scan dimension table.
qSDataManagerRetrieveScan GET /api/v3/datamanager/scan/{scan_id}/data Summary: Fetch ScanDetails Description: Fetch details from scan dimension table.

qSDataManagerGetMasterData

Qspmdatamanagerv3MasterDataResponse qSDataManagerGetMasterData()

Example

import { createConfiguration, QSDataManagerApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

Qspmdatamanagerv3MasterDataResponse

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]

qSDataManagerGetPluginData

Qspmdatamanagerv3PluginDataResponse qSDataManagerGetPluginData()

Example

import { createConfiguration, QSDataManagerApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

Qspmdatamanagerv3PluginDataResponse

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]

qSDataManagerRegisterScan

Qspmdatamanagerv3ScanResponse qSDataManagerRegisterScan(qspmdatamanagerv3ScanRequest)

Example

import { createConfiguration, QSDataManagerApi } from '';
import type { QSDataManagerApiQSDataManagerRegisterScanRequest } from '';

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

const request: QSDataManagerApiQSDataManagerRegisterScanRequest = {
  
  qspmdatamanagerv3ScanRequest: {
    pluginId: "pluginId_example",
    scanCbomId: "scanCbomId_example",
    scanDataTs: new Date('1970-01-01T00:00:00.00Z'),
    scanDataUpdateTs: new Date('1970-01-01T00:00:00.00Z'),
    scanDesc: "scanDesc_example",
    scanId: "scanId_example",
    scanStatus: "scanStatus_example",
    userEmail: "userEmail_example",
  },
};

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

Parameters

Name Type Description Notes
qspmdatamanagerv3ScanRequest Qspmdatamanagerv3ScanRequest

Return type

Qspmdatamanagerv3ScanResponse

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]

qSDataManagerRetrieveScan

Qspmdatamanagerv3ScanResponse qSDataManagerRetrieveScan()

Example

import { createConfiguration, QSDataManagerApi } from '';
import type { QSDataManagerApiQSDataManagerRetrieveScanRequest } from '';

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

const request: QSDataManagerApiQSDataManagerRetrieveScanRequest = {
  
  scanId: "scan_id_example",
};

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

Parameters

Name Type Description Notes
scanId [string] defaults to undefined

Return type

Qspmdatamanagerv3ScanResponse

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]