.AssetsServiceApi

All URIs are relative to http://localhost

Method	HTTP request	Description
assetsServiceAssetIngestion	POST /api/v3/assets/ingestion	AssetIngestion - Asset Ingestion Api to ingest assets from different applications including asset extensibility assets.
assetsServiceAssetIngestionManualTrigger	POST /api/v3/assets/ingestion/trigger	AssetIngestionManualTrigger - Manual trigger for Scheduled Asset Ingestion of databases.
assetsServiceCancelCSVImport	DELETE /api/v3/assets/csv/cancel/{csv_id}	CancelCSVImport - Cancel the import of CSV and update the status in import log table
assetsServiceClonePolicy	POST /api/v3/assets/policies/{policy_id}/clone	ClonePolicy - Clone a policy.
assetsServiceCompareCSVToExistingAssets	GET /api/v3/assets/csv/compare/{csv_id}	CompareCSVToExistingAssets - Compare CSV with existing assets and return list of assets(existing/to be imported/both) on demand from csv.
assetsServiceCreateUpdatePolicy	POST /api/v3/assets/policies	CreateUpdatePolicy - Create/update new Policy.
assetsServiceDeleteFilterTemplateForAssets	DELETE /api/v3/assets/filters/template/{template_id}	DeleteFilterTemplateForAssets - Deleting a template using TemplateID in manage assets.
assetsServiceDeletePolicies	DELETE /api/v3/assets/policies	DeletePolicies - Delete Policy returns response code and message.
assetsServiceFetchAssetChangeLog	POST /api/v3/assets/logs	FetchAssetChangeLog - Fetch the logs for any actions performed on assets.
assetsServiceFetchAssetDashboard	GET /api/v3/assets/dashboard/{widget_type}	FetchAssetDashboard - Gets Filter Templates for Dshboard Widgets.
assetsServiceFetchAssetList	POST /api/v3/assets	FetchAssetList - Asset Fetch Api .
assetsServiceFetchAssetsForMergeSplit	GET /api/v3/assets/configuration	FetchAssetsForMergeSplit : Fetch assets for Merge and Split.
assetsServiceFindAssetName	GET /api/v3/assets/name	FindAssetName - Checks if the given Asset Name has already been assigned to an asset.
assetsServiceGetAssetOverview	GET /api/v3/assets/overview	GetAssetOverview - Get asset overview widgets data for a particular asset.
assetsServiceGetAssetTopology	POST /api/v3/assets/topology	GetAssetTopology- Get list of topology for a parent asset.
assetsServiceGetFilterTemplateForAssets	GET /api/v3/assets/filters/templates	GetFilterTemplateForAssets - Get list of filters query templates for manage assets.
assetsServiceGetFiltersForAssets	GET /api/v3/assets/filters	GetFiltersForAssets - Get a list of filters category and sub category with all data.
assetsServiceImportCSV	POST /api/v3/assets/csv/import/{csv_id}	ImportCSV - Start the async asset import from CSV by starting the db procedure and send notification at the end.
assetsServiceListPolicy	GET /api/v3/assets/policies	ListPolicy - List all policies.
assetsServiceListRule	GET /api/v3/assets/policies/{policy_id}/rules	ListRule - List all rules for a policy.
assetsServiceListTagDomains	GET /api/v3/assets/tags/categories	ListTagDomains - Get Tag categories by request parameters .
assetsServiceListTags	GET /api/v3/assets/tags	ListTags - Get Tags for Manage Tags listing screen .
assetsServiceMergeOrSplitAssets	POST /api/v3/assets/configuration	MergeOrSplitAssets - Merge or split the selected assets.
assetsServiceSaveAssignedTags	POST /api/v3/assets/tags/assign	SaveAssignedTags - Save Assigned Tags to TAG_DSDEF_MAP table.
assetsServiceSaveTagConceptData	POST /api/v3/assets/tags	SaveTagConceptData - creates a custom tag
assetsServiceSaveTagDomainData	POST /api/v3/assets/tags/categories	SaveTagDomainData - creates a custom category to be assigned to a tag
assetsServiceSaveUpdateFilterTemplateForAssets	POST /api/v3/assets/filters/templates	SaveUpdateFilterTemplateForAssets - Save/Update a filters query to use as template in manage assets along with reordering of template list.
assetsServiceSetBannerState	PUT /api/v3/assets/banner	SetBannerState - Set banner state for asset inventory page.
assetsServiceUpdateAssetName	PUT /api/v3/assets/name	UpdateAssetName - Udates the name of the asset as given by the user.
assetsServiceUpdatePolicy	PUT /api/v3/assets/policies	UpdatePolicy - Update existing Policy status.

assetsServiceAssetIngestion

Assetsv3AssetIngestionResponse assetsServiceAssetIngestion(assetsv3AssetIngestionRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceAssetIngestionRequest } from '';

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

const request: AssetsServiceApiAssetsServiceAssetIngestionRequest = {
  
  assetsv3AssetIngestionRequest: {
    accounts: [
      {
        accountType: "accountType_example",
        description: "description_example",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        name: "name_example",
        resolutionKey: "resolutionKey_example",
      },
    ],
    applications: [
      {
        appId: "appId_example",
        applicationDatabase: [
          {
            identifier: "identifier_example",
          },
        ],
        applicationEndpoint: [
          {
            identifier: "identifier_example",
          },
        ],
        applicationHost: [
          {
            identifier: "identifier_example",
          },
        ],
        applicationIp: [
          {
            identifier: "identifier_example",
          },
        ],
        applicationName: "applicationName_example",
        applicationStorage: [
          {
            identifier: "identifier_example",
          },
        ],
        applicationSubType: "applicationSubType_example",
        applicationSubscription: [
          {
            identifier: "identifier_example",
          },
        ],
        applicationType: "applicationType_example",
        category: "category_example",
        criticality: "LEVEL_UNKNOWN",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        lastUsed: new Date('1970-01-01T00:00:00.00Z'),
        owner: [
          "owner_example",
        ],
        parentApplication: "parentApplication_example",
        resolutionKey: "resolutionKey_example",
        riskLevel: "LEVEL_UNKNOWN",
        serviceType: "serviceType_example",
        version: "version_example",
      },
    ],
    databases: [
      {
        catalog: "catalog_example",
        criticality: "LEVEL_UNKNOWN",
        databaseHost: [
          {
            identifier: "identifier_example",
          },
        ],
        databaseIp: [
          {
            identifier: "identifier_example",
          },
        ],
        databaseName: "databaseName_example",
        databaseSubType: "databaseSubType_example",
        databaseSubscription: [
          {
            identifier: "identifier_example",
          },
        ],
        databaseType: "databaseType_example",
        description: "description_example",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        owner: [
          "owner_example",
        ],
        resolutionKey: "resolutionKey_example",
        riskLevel: "LEVEL_UNKNOWN",
        schemaName: "schemaName_example",
        serviceName: "serviceName_example",
      },
    ],
    deployments: [
      {
        city: "city_example",
        country: "country_example",
        criticality: "LEVEL_UNKNOWN",
        dataCenter: "dataCenter_example",
        deploymentAccount: [
          {
            identifier: "identifier_example",
          },
        ],
        deploymentId: "deploymentId_example",
        deploymentSubscription: [
          {
            identifier: "identifier_example",
          },
        ],
        dns: "dns_example",
        environment: "environment_example",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        name: "name_example",
        region: "region_example",
        resolutionKey: "resolutionKey_example",
        riskLevel: "LEVEL_UNKNOWN",
        service: "service_example",
        state: "state_example",
        type: "type_example",
      },
    ],
    endpoints: [
      {
        criticality: "LEVEL_UNKNOWN",
        endpointHost: [
          {
            identifier: "identifier_example",
          },
        ],
        endpointIp: [
          {
            identifier: "identifier_example",
          },
        ],
        endpointName: "endpointName_example",
        endpointSubType: "endpointSubType_example",
        endpointType: "endpointType_example",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        isAccessUrl: true,
        os: "os_example",
        owner: [
          "owner_example",
        ],
        resolutionKey: "resolutionKey_example",
        riskLevel: "LEVEL_UNKNOWN",
      },
    ],
    hosts: [
      {
        city: "city_example",
        country: "country_example",
        dataCenter: "dataCenter_example",
        description: "description_example",
        dns: "dns_example",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        hostIp: [
          {
            identifier: "identifier_example",
          },
        ],
        hostName: "hostName_example",
        hostPort: [
          {
            identifier: "identifier_example",
          },
        ],
        region: "region_example",
        resolutionKey: "resolutionKey_example",
        state: "state_example",
      },
    ],
    ips: [
      {
        city: "city_example",
        country: "country_example",
        dataCenter: "dataCenter_example",
        description: "description_example",
        dns: "dns_example",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        ipAddress: "ipAddress_example",
        ipPort: [
          {
            identifier: "identifier_example",
          },
        ],
        macAddress: "macAddress_example",
        region: "region_example",
        resolutionKey: "resolutionKey_example",
        state: "state_example",
        version: "version_example",
      },
    ],
    models: [
      {
        criticality: "LEVEL_UNKNOWN",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        hasTrainingData: true,
        lastTrained: new Date('1970-01-01T00:00:00.00Z'),
        modelApplication: [
          {
            identifier: "identifier_example",
          },
        ],
        modelDeployment: [
          {
            identifier: "identifier_example",
          },
        ],
        modelId: "modelId_example",
        modelName: "modelName_example",
        modelResources: [
          {
            identifier: "identifier_example",
          },
        ],
        modelSubType: "modelSubType_example",
        modelType: "modelType_example",
        publisher: "publisher_example",
        resolutionKey: "resolutionKey_example",
        riskLevel: "LEVEL_UNKNOWN",
        version: "version_example",
      },
    ],
    origin: "origin_example",
    ports: [
      {
        description: "description_example",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        portNumber: "portNumber_example",
        protocol: "protocol_example",
        protocolVersion: "protocolVersion_example",
        resolutionKey: "resolutionKey_example",
      },
    ],
    resources: [
      {
        creationDate: new Date('1970-01-01T00:00:00.00Z'),
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        location: "location_example",
        name: "name_example",
        resolutionKey: "resolutionKey_example",
        resourcesAccount: [
          {
            identifier: "identifier_example",
          },
        ],
        sensitivities: [
          {
            category: "category_example",
            count: 1,
            name: "name_example",
          },
        ],
        size: "size_example",
        type: "type_example",
      },
    ],
    storages: [
      {
        city: "city_example",
        country: "country_example",
        criticality: "LEVEL_UNKNOWN",
        dataCenter: "dataCenter_example",
        dns: "dns_example",
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        folderPath: "folderPath_example",
        owner: [
          "owner_example",
        ],
        region: "region_example",
        resolutionKey: "resolutionKey_example",
        riskLevel: "LEVEL_UNKNOWN",
        size: "size_example",
        state: "state_example",
        storageAccount: [
          {
            identifier: "identifier_example",
          },
        ],
        storageHost: [
          {
            identifier: "identifier_example",
          },
        ],
        storageId: "storageId_example",
        storageIp: [
          {
            identifier: "identifier_example",
          },
        ],
        storageName: "storageName_example",
        storageResources: [
          {
            identifier: "identifier_example",
          },
        ],
        storageSubType: "storageSubType_example",
        storageSubscription: [
          {
            identifier: "identifier_example",
          },
        ],
        storageType: "storageType_example",
      },
    ],
    subscriptions: [
      {
        duration: "duration_example",
        endTime: new Date('1970-01-01T00:00:00.00Z'),
        extendedProperties: [
          {
            dataType: "dataType_example",
            key: "key_example",
            value: "value_example",
          },
        ],
        name: "name_example",
        resolutionKey: "resolutionKey_example",
        startTime: new Date('1970-01-01T00:00:00.00Z'),
        subscriptionAccount: [
          {
            identifier: "identifier_example",
          },
        ],
        subscriptionId: "subscriptionId_example",
        type: "type_example",
      },
    ],
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3AssetIngestionRequest	Assetsv3AssetIngestionRequest

Return type

Assetsv3AssetIngestionResponse

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]

assetsServiceAssetIngestionManualTrigger

Assetsv3AssetIngestionResponse assetsServiceAssetIngestionManualTrigger(body)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceAssetIngestionManualTriggerRequest } from '';

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

const request: AssetsServiceApiAssetsServiceAssetIngestionManualTriggerRequest = {
  
  body: {},
};

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

Parameters

Name	Type	Description	Notes
body	any

Return type

Assetsv3AssetIngestionResponse

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]

assetsServiceCancelCSVImport

any assetsServiceCancelCSVImport()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceCancelCSVImportRequest } from '';

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

const request: AssetsServiceApiAssetsServiceCancelCSVImportRequest = {
    // unique id of the csv
  csvId: "csv_id_example",
};

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

Parameters

Name	Type	Description	Notes
csvId	[string]	unique id of the csv	defaults to undefined

Return type

any

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]

assetsServiceClonePolicy

any assetsServiceClonePolicy(assetsv3ClonePolicyRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceClonePolicyRequest } from '';

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

const request: AssetsServiceApiAssetsServiceClonePolicyRequest = {
    // Policy id that needs to be cloned.
  policyId: "policy_id_example",
  
  assetsv3ClonePolicyRequest: {
    policyId: "policyId_example",
    policyName: "policyName_example",
    rules: [
      {
        actions: [
          {
            destCategory: "destCategory_example",
            destType: "destType_example",
            destValue: "destValue_example",
          },
        ],
        isDelete: 1,
        parameters: [
          {
            assetAttribute: "assetAttribute_example",
            attributeEnum: "attributeEnum_example",
            condition: "condition_example",
            conditionCategory: "conditionCategory_example",
            conditionValue: "conditionValue_example",
          },
        ],
        policyId: "policyId_example",
        ruleId: "ruleId_example",
        ruleName: "ruleName_example",
        ruleType: "ACCESS",
      },
    ],
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3ClonePolicyRequest	Assetsv3ClonePolicyRequest
policyId	[string]	Policy id that needs to be cloned.	defaults to undefined

Return type

any

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]

assetsServiceCompareCSVToExistingAssets

Assetsv3CompareCSVResponse assetsServiceCompareCSVToExistingAssets()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceCompareCSVToExistingAssetsRequest } from '';

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

const request: AssetsServiceApiAssetsServiceCompareCSVToExistingAssetsRequest = {
    // unique id of the csv
  csvId: "csv_id_example",
    // which rows are required, existing or new or all. (optional)
  rowsRequired: "rows_required_example",
    // page number. (optional)
  pageNumber: 1,
    // page size. (optional)
  pageSize: 1,
    // Asset CSV template type.   - DATABASE: Template for database (optional)
  templateType: "DATABASE",
};

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

Parameters

Name	Type	Description	Notes
csvId	[string]	unique id of the csv	defaults to undefined
rowsRequired	[string]	which rows are required, existing or new or all.	(optional) defaults to undefined
pageNumber	[number]	page number.	(optional) defaults to undefined
pageSize	[number]	page size.	(optional) defaults to undefined
templateType	['DATABASE']Array<'DATABASE'>	Asset CSV template type. - DATABASE: Template for database	(optional) defaults to 'DATABASE'

Return type

Assetsv3CompareCSVResponse

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]

assetsServiceCreateUpdatePolicy

Assetsv3CreateUpdatePolicyResponse assetsServiceCreateUpdatePolicy(assetsv3CreateUpdatePolicyRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceCreateUpdatePolicyRequest } from '';

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

const request: AssetsServiceApiAssetsServiceCreateUpdatePolicyRequest = {
  
  assetsv3CreateUpdatePolicyRequest: {
    operation: 1,
    policy: {
      activationStatus: 1,
      deletedRuleIds: [
        "deletedRuleIds_example",
      ],
      installedFlag: true,
      installedTimestamp: "installedTimestamp_example",
      lastEditedTimestamp: "lastEditedTimestamp_example",
      policyId: "policyId_example",
      policyName: "policyName_example",
      policySequence: 1,
      rules: [
        {
          actions: [
            {
              destCategory: "destCategory_example",
              destType: "destType_example",
              destValue: "destValue_example",
            },
          ],
          isDelete: 1,
          parameters: [
            {
              assetAttribute: "assetAttribute_example",
              attributeEnum: "attributeEnum_example",
              condition: "condition_example",
              conditionCategory: "conditionCategory_example",
              conditionValue: "conditionValue_example",
            },
          ],
          policyId: "policyId_example",
          ruleId: "ruleId_example",
          ruleName: "ruleName_example",
          ruleType: "ACCESS",
        },
      ],
      updatedRuleIds: [
        "updatedRuleIds_example",
      ],
    },
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3CreateUpdatePolicyRequest	Assetsv3CreateUpdatePolicyRequest

Return type

Assetsv3CreateUpdatePolicyResponse

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]

assetsServiceDeleteFilterTemplateForAssets

any assetsServiceDeleteFilterTemplateForAssets()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceDeleteFilterTemplateForAssetsRequest } from '';

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

const request: AssetsServiceApiAssetsServiceDeleteFilterTemplateForAssetsRequest = {
    // template id to be deleted
  templateId: "template_id_example",
};

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

Parameters

Name	Type	Description	Notes
templateId	[string]	template id to be deleted	defaults to undefined

Return type

any

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]

assetsServiceDeletePolicies

any assetsServiceDeletePolicies()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceDeletePoliciesRequest } from '';

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

const request: AssetsServiceApiAssetsServiceDeletePoliciesRequest = {
    // Policy ids. (optional)
  policyIds: [
    "policy_ids_example",
  ],
};

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

Parameters

Name	Type	Description	Notes
policyIds	Array<string>	Policy ids.	(optional) defaults to undefined

Return type

any

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]

assetsServiceFetchAssetChangeLog

Assetsv3FetchAssetChangeLogResponse assetsServiceFetchAssetChangeLog(assetsv3FetchAssetChangeLogRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceFetchAssetChangeLogRequest } from '';

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

const request: AssetsServiceApiAssetsServiceFetchAssetChangeLogRequest = {
  
  assetsv3FetchAssetChangeLogRequest: {
    assetId: "assetId_example",
    filter: [
      {
        catagoryId: "catagoryId_example",
        dateRange: {
          end: "end_example",
          endNumber: 1,
          endUnit: "endUnit_example",
          error: "error_example",
          key: "key_example",
          start: "start_example",
          startNumber: 1,
          startUnit: "startUnit_example",
          type: "type_example",
        },
        selectedSubCatagoryList: [
          {
            selectedChildrenList: [
              {
                childId: "childId_example",
                childName: "childName_example",
              },
            ],
            subCatagoryId: "subCatagoryId_example",
            subCategoryValue: "subCategoryValue_example",
          },
        ],
        subCatagoryIds: [
          "subCatagoryIds_example",
        ],
        subCategoryValues: [
          "subCategoryValues_example",
        ],
        timelineValueSelected: "timelineValueSelected_example",
      },
    ],
    pageNumber: 1,
    pageSize: 1,
    searchKey: "searchKey_example",
    sort: "sort_example",
    sortBy: "sortBy_example",
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3FetchAssetChangeLogRequest	Assetsv3FetchAssetChangeLogRequest

Return type

Assetsv3FetchAssetChangeLogResponse

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]

assetsServiceFetchAssetDashboard

Assetsv3FetchAssetDashboardResponse assetsServiceFetchAssetDashboard()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceFetchAssetDashboardRequest } from '';

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

const request: AssetsServiceApiAssetsServiceFetchAssetDashboardRequest = {
    // ID of the Dashboard Widget
  widgetType: "widget_type_example",
    // start of date range for ui widget. (optional)
  dateRangeStart: "date_range.start_example",
    // end of date range for ui widget. (optional)
  dateRangeEnd: "date_range.end_example",
    // type of date range for ui widget. (optional)
  dateRangeType: "date_range.type_example",
    // key for ui widget. (optional)
  dateRangeKey: "date_range.key_example",
    // error for ui widget. (optional)
  dateRangeError: "date_range.error_example",
    // start_number for ui widget. (optional)
  dateRangeStartNumber: 1,
    // start of date range for ui widget. (optional)
  dateRangeStartUnit: "date_range.start_unit_example",
    // start of date range for ui widget. (optional)
  dateRangeEndNumber: 1,
    // start of date range for ui widget. (optional)
  dateRangeEndUnit: "date_range.end_unit_example",
    // Name of the timeline value selected from drop down. (optional)
  timelineValueSelected: "timeline_value_selected_example",
    // Tag ID. (optional)
  tagId: "tag_id_example",
};

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

Parameters

Name	Type	Description	Notes
widgetType	[string]	ID of the Dashboard Widget	defaults to undefined
dateRangeStart	[string]	start of date range for ui widget.	(optional) defaults to undefined
dateRangeEnd	[string]	end of date range for ui widget.	(optional) defaults to undefined
dateRangeType	[string]	type of date range for ui widget.	(optional) defaults to undefined
dateRangeKey	[string]	key for ui widget.	(optional) defaults to undefined
dateRangeError	[string]	error for ui widget.	(optional) defaults to undefined
dateRangeStartNumber	[number]	start_number for ui widget.	(optional) defaults to undefined
dateRangeStartUnit	[string]	start of date range for ui widget.	(optional) defaults to undefined
dateRangeEndNumber	[number]	start of date range for ui widget.	(optional) defaults to undefined
dateRangeEndUnit	[string]	start of date range for ui widget.	(optional) defaults to undefined
timelineValueSelected	[string]	Name of the timeline value selected from drop down.	(optional) defaults to undefined
tagId	[string]	Tag ID.	(optional) defaults to undefined

Return type

Assetsv3FetchAssetDashboardResponse

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]

assetsServiceFetchAssetList

Assetsv3FetchAssetListResponse assetsServiceFetchAssetList(assetsv3FetchAssetListRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceFetchAssetListRequest } from '';

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

const request: AssetsServiceApiAssetsServiceFetchAssetListRequest = {
  
  assetsv3FetchAssetListRequest: {
    columns: [
      "columns_example",
    ],
    filter: [
      {
        catagoryId: "catagoryId_example",
        dateRange: {
          end: "end_example",
          endNumber: 1,
          endUnit: "endUnit_example",
          error: "error_example",
          key: "key_example",
          start: "start_example",
          startNumber: 1,
          startUnit: "startUnit_example",
          type: "type_example",
        },
        selectedSubCatagoryList: [
          {
            selectedChildrenList: [
              {
                childId: "childId_example",
                childName: "childName_example",
              },
            ],
            subCatagoryId: "subCatagoryId_example",
            subCategoryValue: "subCategoryValue_example",
          },
        ],
        subCatagoryIds: [
          "subCatagoryIds_example",
        ],
        subCategoryValues: [
          "subCategoryValues_example",
        ],
        timelineValueSelected: "timelineValueSelected_example",
      },
    ],
    pageNumber: 1,
    pageSize: 1,
    parentId: "parentId_example",
    searchKey: "searchKey_example",
    sort: "sort_example",
    sortBy: "sortBy_example",
    viewType: "DB",
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3FetchAssetListRequest	Assetsv3FetchAssetListRequest

Return type

Assetsv3FetchAssetListResponse

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]

assetsServiceFetchAssetsForMergeSplit

Assetsv3FetchAssetsForMergeSplitResponse assetsServiceFetchAssetsForMergeSplit()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceFetchAssetsForMergeSplitRequest } from '';

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

const request: AssetsServiceApiAssetsServiceFetchAssetsForMergeSplitRequest = {
    // Asset grouper Id. (optional)
  assetId: "asset_id_example",
    // Page number. (optional)
  pageNumber: 1,
    // Page size. (optional)
  pageSize: 1,
    // Action : merge or split. (optional)
  action: "action_example",
    // Search from the list based on asset name, database name, ip or host. (optional)
  searchKey: "search_key_example",
};

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

Parameters

Name	Type	Description	Notes
assetId	[string]	Asset grouper Id.	(optional) defaults to undefined
pageNumber	[number]	Page number.	(optional) defaults to undefined
pageSize	[number]	Page size.	(optional) defaults to undefined
action	[string]	Action : merge or split.	(optional) defaults to undefined
searchKey	[string]	Search from the list based on asset name, database name, ip or host.	(optional) defaults to undefined

Return type

Assetsv3FetchAssetsForMergeSplitResponse

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]

assetsServiceFindAssetName

Assetsv3FindAssetNameResponse assetsServiceFindAssetName()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceFindAssetNameRequest } from '';

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

const request: AssetsServiceApiAssetsServiceFindAssetNameRequest = {
    // Name of asset. (optional)
  assetName: "asset_name_example",
};

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

Parameters

Name	Type	Description	Notes
assetName	[string]	Name of asset.	(optional) defaults to undefined

Return type

Assetsv3FindAssetNameResponse

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]

assetsServiceGetAssetOverview

Assetsv3AssetOverviewResponse assetsServiceGetAssetOverview()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceGetAssetOverviewRequest } from '';

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

const request: AssetsServiceApiAssetsServiceGetAssetOverviewRequest = {
    // Asset grouper Id. (optional)
  assetId: "asset_id_example",
    // Page number. (optional)
  pageNumber: 1,
    // Page size. (optional)
  size: 1,
    // Widget type.   - ALL: All Asset Overview Widgets.  - CLASSIFICATION: Classification Asset Overview Widgets.  - TAG: Tag Asset Overview Widgets.  - RESOURCE: Resource Asset Overview Widgets. (optional)
  widget: "ALL",
    // Asset IP. (optional)
  ip: "ip_example",
    // Asset Host. (optional)
  host: "host_example",
    // Database Name. (optional)
  database: "database_example",
    // asset entity type. (optional)
  assetEntityType: "asset_entity_type_example",
};

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

Parameters

Name	Type	Description	Notes
assetId	[string]	Asset grouper Id.	(optional) defaults to undefined
pageNumber	[number]	Page number.	(optional) defaults to undefined
size	[number]	Page size.	(optional) defaults to undefined
widget	[**'ALL'	'CLASSIFICATION'	'TAG'
ip	[string]	Asset IP.	(optional) defaults to undefined
host	[string]	Asset Host.	(optional) defaults to undefined
database	[string]	Database Name.	(optional) defaults to undefined
assetEntityType	[string]	asset entity type.	(optional) defaults to undefined

Return type

Assetsv3AssetOverviewResponse

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]

assetsServiceGetAssetTopology

Assetsv3GetAssetTopologyResponse assetsServiceGetAssetTopology(assetsv3GetAssetTopologyRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceGetAssetTopologyRequest } from '';

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

const request: AssetsServiceApiAssetsServiceGetAssetTopologyRequest = {
  
  assetsv3GetAssetTopologyRequest: {
    assetId: "assetId_example",
    type: "type_example",
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3GetAssetTopologyRequest	Assetsv3GetAssetTopologyRequest

Return type

Assetsv3GetAssetTopologyResponse

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]

assetsServiceGetFilterTemplateForAssets

Assetsv3GetFilterTemplateResponse assetsServiceGetFilterTemplateForAssets()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceGetFilterTemplateForAssetsRequest } from '';

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

const request: AssetsServiceApiAssetsServiceGetFilterTemplateForAssetsRequest = {
    // template id to be deleted. (optional)
  templateId: "template_id_example",
};

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

Parameters

Name	Type	Description	Notes
templateId	[string]	template id to be deleted.	(optional) defaults to undefined

Return type

Assetsv3GetFilterTemplateResponse

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]

assetsServiceGetFiltersForAssets

Assetsv3GetFiltersDataResponse assetsServiceGetFiltersForAssets()

Example

import { createConfiguration, AssetsServiceApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

Assetsv3GetFiltersDataResponse

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]

assetsServiceImportCSV

Assetsv3ImportCSVResponse assetsServiceImportCSV(assetsv3ImportCSVRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceImportCSVRequest } from '';

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

const request: AssetsServiceApiAssetsServiceImportCSVRequest = {
    // unique id of the csv
  csvId: "csv_id_example",
  
  assetsv3ImportCSVRequest: {
    csvId: "csvId_example",
    importAction: "importAction_example",
    templateType: "DATABASE",
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3ImportCSVRequest	Assetsv3ImportCSVRequest
csvId	[string]	unique id of the csv	defaults to undefined

Return type

Assetsv3ImportCSVResponse

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]

assetsServiceListPolicy

Assetsv3ListPolicyResponse assetsServiceListPolicy()

Example

import { createConfiguration, AssetsServiceApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

Assetsv3ListPolicyResponse

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]

assetsServiceListRule

Assetsv3ListRuleResponse assetsServiceListRule()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceListRuleRequest } from '';

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

const request: AssetsServiceApiAssetsServiceListRuleRequest = {
    // Policy ID
  policyId: "policy_id_example",
};

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

Parameters

Name	Type	Description	Notes
policyId	[string]	Policy ID	defaults to undefined

Return type

Assetsv3ListRuleResponse

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]

assetsServiceListTagDomains

Assetsv3ListTagDomainsResponse assetsServiceListTagDomains()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceListTagDomainsRequest } from '';

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

const request: AssetsServiceApiAssetsServiceListTagDomainsRequest = {
    // Optional: dom_grouper required if we want to fetch domains based on the group. (optional)
  domGrouper: "dom_grouper_example",
    // Optional: purpose required if we want to fetch domains based on the purpose. (optional)
  purpose: "purpose_example",
    // Optional: If we need Tag  based on the Domains. (optional)
  needTag: true,
};

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

Parameters

Name	Type	Description	Notes
domGrouper	[string]	Optional: dom_grouper required if we want to fetch domains based on the group.	(optional) defaults to undefined
purpose	[string]	Optional: purpose required if we want to fetch domains based on the purpose.	(optional) defaults to undefined
needTag	[boolean]	Optional: If we need Tag based on the Domains.	(optional) defaults to undefined

Return type

Assetsv3ListTagDomainsResponse

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]

assetsServiceListTags

Assetsv3ListTagsResponse assetsServiceListTags()

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceListTagsRequest } from '';

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

const request: AssetsServiceApiAssetsServiceListTagsRequest = {
    // asset id - Asset ID. (optional)
  assetId: [
    "asset_id_example",
  ],
};

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

Parameters

Name	Type	Description	Notes
assetId	Array<string>	asset id - Asset ID.	(optional) defaults to undefined

Return type

Assetsv3ListTagsResponse

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]

assetsServiceMergeOrSplitAssets

any assetsServiceMergeOrSplitAssets(assetsv3MergeOrSplitAssetsRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceMergeOrSplitAssetsRequest } from '';

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

const request: AssetsServiceApiAssetsServiceMergeOrSplitAssetsRequest = {
  
  assetsv3MergeOrSplitAssetsRequest: {
    action: "action_example",
    destinationAssets: [
      {
        assetId: "assetId_example",
        assetName: "assetName_example",
        dsdefKey: [
          "dsdefKey_example",
        ],
      },
    ],
    sourceAsset: {
      assetId: "assetId_example",
      assetName: "assetName_example",
      dsdefKey: [
        "dsdefKey_example",
      ],
    },
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3MergeOrSplitAssetsRequest	Assetsv3MergeOrSplitAssetsRequest

Return type

any

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]

assetsServiceSaveAssignedTags

any assetsServiceSaveAssignedTags(assetsv3SaveAssignedTagsRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceSaveAssignedTagsRequest } from '';

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

const request: AssetsServiceApiAssetsServiceSaveAssignedTagsRequest = {
  
  assetsv3SaveAssignedTagsRequest: {
    tagsAssigned: [
      {
        assetId: "assetId_example",
        tagId: [
          "tagId_example",
        ],
      },
    ],
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3SaveAssignedTagsRequest	Assetsv3SaveAssignedTagsRequest

Return type

any

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]

assetsServiceSaveTagConceptData

any assetsServiceSaveTagConceptData(assetsv3SaveTagConceptDataRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceSaveTagConceptDataRequest } from '';

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

const request: AssetsServiceApiAssetsServiceSaveTagConceptDataRequest = {
  
  assetsv3SaveTagConceptDataRequest: {
    tag: {
      creationTime: new Date('1970-01-01T00:00:00.00Z'),
      creationTimeUtc: new Date('1970-01-01T00:00:00.00Z'),
      description: "description_example",
      domainId: "domainId_example",
      id: "id_example",
      isDelete: true,
      name: "name_example",
      properties: "properties_example",
      source: "source_example",
      updatedTime: new Date('1970-01-01T00:00:00.00Z'),
      utcOffset: 1,
    },
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3SaveTagConceptDataRequest	Assetsv3SaveTagConceptDataRequest

Return type

any

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]

assetsServiceSaveTagDomainData

any assetsServiceSaveTagDomainData(assetsv3SaveTagDomainDataRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceSaveTagDomainDataRequest } from '';

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

const request: AssetsServiceApiAssetsServiceSaveTagDomainDataRequest = {
  
  assetsv3SaveTagDomainDataRequest: {
    category: {
      creationTime: new Date('1970-01-01T00:00:00.00Z'),
      creationTimeUtc: new Date('1970-01-01T00:00:00.00Z'),
      description: "description_example",
      grouper: "grouper_example",
      id: "id_example",
      isDelete: true,
      mappedEntityName: "mappedEntityName_example",
      name: "name_example",
      properties: "properties_example",
      purpose: "purpose_example",
      tags: [
        {
          creationTime: new Date('1970-01-01T00:00:00.00Z'),
          creationTimeUtc: new Date('1970-01-01T00:00:00.00Z'),
          description: "description_example",
          domainId: "domainId_example",
          id: "id_example",
          isDelete: true,
          name: "name_example",
          properties: "properties_example",
          source: "source_example",
          updatedTime: new Date('1970-01-01T00:00:00.00Z'),
          utcOffset: 1,
        },
      ],
      updatedTime: new Date('1970-01-01T00:00:00.00Z'),
      utcOffset: 1,
    },
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3SaveTagDomainDataRequest	Assetsv3SaveTagDomainDataRequest

Return type

any

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]

assetsServiceSaveUpdateFilterTemplateForAssets

Assetsv3SaveUpdateFilterTemplateResponse assetsServiceSaveUpdateFilterTemplateForAssets(assetsv3SaveUpdateFilterTemplateRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceSaveUpdateFilterTemplateForAssetsRequest } from '';

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

const request: AssetsServiceApiAssetsServiceSaveUpdateFilterTemplateForAssetsRequest = {
  
  assetsv3SaveUpdateFilterTemplateRequest: {
    isDefault: true,
    template: {
      colummnsList: [
        {
          _default: true,
          defaultOrder: 1,
          fixed: true,
          header: "header_example",
          id: "id_example",
          nlsKey: "nlsKey_example",
          select: true,
        },
      ],
      count: "count_example",
      createdBy: "createdBy_example",
      createdDate: "createdDate_example",
      dashboardTemplate: true,
      description: "description_example",
      id: "id_example",
      selectedFilters: [
        {
          catagoryId: "catagoryId_example",
          dateRange: {
            end: "end_example",
            endNumber: 1,
            endUnit: "endUnit_example",
            error: "error_example",
            key: "key_example",
            start: "start_example",
            startNumber: 1,
            startUnit: "startUnit_example",
            type: "type_example",
          },
          selectedSubCatagoryList: [
            {
              selectedChildrenList: [
                {
                  childId: "childId_example",
                  childName: "childName_example",
                },
              ],
              subCatagoryId: "subCatagoryId_example",
              subCategoryValue: "subCategoryValue_example",
            },
          ],
          subCatagoryIds: [
            "subCatagoryIds_example",
          ],
          subCategoryValues: [
            "subCategoryValues_example",
          ],
          timelineValueSelected: "timelineValueSelected_example",
        },
      ],
      templateId: "templateId_example",
      title: "title_example",
      updatedDate: "updatedDate_example",
    },
    templateIdsList: [
      "templateIdsList_example",
    ],
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3SaveUpdateFilterTemplateRequest	Assetsv3SaveUpdateFilterTemplateRequest

Return type

Assetsv3SaveUpdateFilterTemplateResponse

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]

assetsServiceSetBannerState

any assetsServiceSetBannerState(assetsv3SetBannerStateRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceSetBannerStateRequest } from '';

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

const request: AssetsServiceApiAssetsServiceSetBannerStateRequest = {
  
  assetsv3SetBannerStateRequest: {
    hideAssetsBanner: true,
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3SetBannerStateRequest	Assetsv3SetBannerStateRequest

Return type

any

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]

assetsServiceUpdateAssetName

any assetsServiceUpdateAssetName(assetsv3UpdateAssetNameRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceUpdateAssetNameRequest } from '';

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

const request: AssetsServiceApiAssetsServiceUpdateAssetNameRequest = {
  
  assetsv3UpdateAssetNameRequest: {
    grouperId: 1,
    updatedName: "updatedName_example",
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3UpdateAssetNameRequest	Assetsv3UpdateAssetNameRequest

Return type

any

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]

assetsServiceUpdatePolicy

any assetsServiceUpdatePolicy(assetsv3UpdatePolicyRequest)

Example

import { createConfiguration, AssetsServiceApi } from '';
import type { AssetsServiceApiAssetsServiceUpdatePolicyRequest } from '';

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

const request: AssetsServiceApiAssetsServiceUpdatePolicyRequest = {
  
  assetsv3UpdatePolicyRequest: {
    policyId: [
      "policyId_example",
    ],
    updateActivationStatus: true,
  },
};

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

Parameters

Name	Type	Description	Notes
assetsv3UpdatePolicyRequest	Assetsv3UpdatePolicyRequest

Return type

any

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]

FilesExpand file tree

AssetsServiceApi.md

Latest commit

History

AssetsServiceApi.md

File metadata and controls

.AssetsServiceApi

assetsServiceAssetIngestion

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceAssetIngestionManualTrigger

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceCancelCSVImport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceClonePolicy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceCompareCSVToExistingAssets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceCreateUpdatePolicy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceDeleteFilterTemplateForAssets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceDeletePolicies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceFetchAssetChangeLog

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceFetchAssetDashboard

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assetsServiceFetchAssetList

Example

Parameters