Skip to content

AnalysesDynamicExecutionApi.md

Latest commit

 

History

History
390 lines (230 loc) · 10.8 KB

AnalysesDynamicExecutionApi.md

File metadata and controls

390 lines (230 loc) · 10.8 KB

.AnalysesDynamicExecutionApi

All URIs are relative to https://api.reveng.ai

Method HTTP request Description
getDynamicExecutionStatus GET /v2/analyses/{analysis_id}/dynamic-execution/status Get the status of a dynamic execution task
getNetworkOverview GET /v2/analyses/{analysis_id}/dynamic-execution/network-overview Get the dynamic execution results for network overview
getProcessDump GET /v2/analyses/{analysis_id}/dynamic-execution/process-dumps/{dump_name} Get the dynamic execution results for a specific process dump
getProcessDumps GET /v2/analyses/{analysis_id}/dynamic-execution/process-dumps Get the dynamic execution results for process dumps
getProcessRegistry GET /v2/analyses/{analysis_id}/dynamic-execution/process-registry Get the dynamic execution results for process registry
getProcessTree GET /v2/analyses/{analysis_id}/dynamic-execution/process-tree Get the dynamic execution results for process tree
getTtps GET /v2/analyses/{analysis_id}/dynamic-execution/ttps Get the dynamic execution results for ttps

getDynamicExecutionStatus

BaseResponseDynamicExecutionStatus getDynamicExecutionStatus()

Example

import { createConfiguration, AnalysesDynamicExecutionApi } from '@revengai/sdk';
import type { AnalysesDynamicExecutionApiGetDynamicExecutionStatusRequest } from '@revengai/sdk';

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

const request: AnalysesDynamicExecutionApiGetDynamicExecutionStatusRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseDynamicExecutionStatus

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getNetworkOverview

BaseResponseNetworkOverviewResponse getNetworkOverview()

Example

import { createConfiguration, AnalysesDynamicExecutionApi } from '@revengai/sdk';
import type { AnalysesDynamicExecutionApiGetNetworkOverviewRequest } from '@revengai/sdk';

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

const request: AnalysesDynamicExecutionApiGetNetworkOverviewRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseNetworkOverviewResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getProcessDump

any getProcessDump()

Example

import { createConfiguration, AnalysesDynamicExecutionApi } from '@revengai/sdk';
import type { AnalysesDynamicExecutionApiGetProcessDumpRequest } from '@revengai/sdk';

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

const request: AnalysesDynamicExecutionApiGetProcessDumpRequest = {
  
  analysisId: 1,
  
  dumpName: "dump_name_example",
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined
dumpName [string] defaults to undefined

Return type

any

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getProcessDumps

BaseResponseProcessDumps getProcessDumps()

Example

import { createConfiguration, AnalysesDynamicExecutionApi } from '@revengai/sdk';
import type { AnalysesDynamicExecutionApiGetProcessDumpsRequest } from '@revengai/sdk';

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

const request: AnalysesDynamicExecutionApiGetProcessDumpsRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseProcessDumps

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getProcessRegistry

BaseResponseProcessRegistry getProcessRegistry()

Example

import { createConfiguration, AnalysesDynamicExecutionApi } from '@revengai/sdk';
import type { AnalysesDynamicExecutionApiGetProcessRegistryRequest } from '@revengai/sdk';

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

const request: AnalysesDynamicExecutionApiGetProcessRegistryRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseProcessRegistry

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getProcessTree

BaseResponseProcessTree getProcessTree()

Example

import { createConfiguration, AnalysesDynamicExecutionApi } from '@revengai/sdk';
import type { AnalysesDynamicExecutionApiGetProcessTreeRequest } from '@revengai/sdk';

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

const request: AnalysesDynamicExecutionApiGetProcessTreeRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseProcessTree

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getTtps

BaseResponseTTPS getTtps()

Example

import { createConfiguration, AnalysesDynamicExecutionApi } from '@revengai/sdk';
import type { AnalysesDynamicExecutionApiGetTtpsRequest } from '@revengai/sdk';

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

const request: AnalysesDynamicExecutionApiGetTtpsRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseTTPS

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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