.EcosystemServiceApi

All URIs are relative to http://localhost

Method	HTTP request	Description
ecosystemServiceCreateDataset	POST /api/v3/integrations/datasets	Summary: Create dataset Description: Save a definition in the database.
ecosystemServiceDataInsert	POST /api/v3/integrations/datasets/{dataset_name}	Summary: Data insert Description: Process Data received from webhook API and insert.
ecosystemServiceDeleteDatasets	DELETE /api/v3/integrations/datasets	Summary: Delete datasets Description: Delete an array of datasets.
ecosystemServiceGetDatasetData	GET /api/v3/integrations/datasets/{dataset_name}/data	Summary: Get dataset data Description: Return data report for a given dataset.
ecosystemServiceGetDatasetDetail	GET /api/v3/integrations/datasets/{dataset_name}/details	Summary: Get dataset detail Description: Return detail on a dataset definition.
ecosystemServiceGetDatasets	GET /api/v3/integrations/datasets	Summary: Get datasets Description: Return dataset list that matches the specified filter.
ecosystemServiceGetPurgableRows	POST /api/v3/integrations/purge	Summary: Get purgable rows Description: Check the number of rows that can be purged.
ecosystemServicePurgeData	DELETE /api/v3/integrations/datasets/data	Summary: Purge data Description: Purge data.
ecosystemServiceTestIntegration	POST /api/v3/integrations/setup/test	Summary: Test integration Description: Test the integration connection with the arguments passed in the TestIntegrationRequest. When possible a test message is sent to the integration to ensure it is functional. Currently this API only supports API_IMPORT type integrations

ecosystemServiceCreateDataset

Ecosystemv3CreateDatasetResponse ecosystemServiceCreateDataset(ecosystemv3CreateDatasetRequest)

Example

import { createConfiguration, EcosystemServiceApi } from '';
import type { EcosystemServiceApiEcosystemServiceCreateDatasetRequest } from '';

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

const request: EcosystemServiceApiEcosystemServiceCreateDatasetRequest = {
  
  ecosystemv3CreateDatasetRequest: {
    detail: {
      columns: [
        {
          allowNull: true,
          columnId: 1,
          columnName: "columnName_example",
          columnSize: "columnSize_example",
          columnType: "UNDEFINED_DATA_TYPE",
          unique: true,
        },
      ],
      dataCount: 1,
      datasetName: "datasetName_example",
      description: "description_example",
      editable: true,
    },
    isNew: true,
  },
};

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

Parameters

Name	Type	Description	Notes
ecosystemv3CreateDatasetRequest	Ecosystemv3CreateDatasetRequest

Return type

Ecosystemv3CreateDatasetResponse

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]

ecosystemServiceDataInsert

Ecosystemv3DataInsertResponse ecosystemServiceDataInsert(ecosystemv3DataInsertRequest)

Example

import { createConfiguration, EcosystemServiceApi } from '';
import type { EcosystemServiceApiEcosystemServiceDataInsertRequest } from '';

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

const request: EcosystemServiceApiEcosystemServiceDataInsertRequest = {
    // Data set target name.
  datasetName: "dataset_name_example",
  
  ecosystemv3DataInsertRequest: {
    datasetName: "datasetName_example",
    entries: [
      {
        entry: {
          "key": "key_example",
        },
      },
    ],
  },
};

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

Parameters

Name	Type	Description	Notes
ecosystemv3DataInsertRequest	Ecosystemv3DataInsertRequest
datasetName	[string]	Data set target name.	defaults to undefined

Return type

Ecosystemv3DataInsertResponse

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]

ecosystemServiceDeleteDatasets

Ecosystemv3DeleteDatasetsResponse ecosystemServiceDeleteDatasets()

Example

import { createConfiguration, EcosystemServiceApi } from '';
import type { EcosystemServiceApiEcosystemServiceDeleteDatasetsRequest } from '';

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

const request: EcosystemServiceApiEcosystemServiceDeleteDatasetsRequest = {
    // Name of the dataset, required field. (optional)
  datasetNames: [
    "dataset_names_example",
  ],
};

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

Parameters

Name	Type	Description	Notes
datasetNames	Array<string>	Name of the dataset, required field.	(optional) defaults to undefined

Return type

Ecosystemv3DeleteDatasetsResponse

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]

ecosystemServiceGetDatasetData

Ecosystemv3GetDatasetDataResponse ecosystemServiceGetDatasetData()

Example

import { createConfiguration, EcosystemServiceApi } from '';
import type { EcosystemServiceApiEcosystemServiceGetDatasetDataRequest } from '';

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

const request: EcosystemServiceApiEcosystemServiceGetDatasetDataRequest = {
    // Name of the dataset.
  datasetName: "dataset_name_example",
    // The amount to offset the rows by for pagination. (optional)
  offset: 1,
    // The max amount of rows to return for pagination. (optional)
  limit: 1,
    // If needs to return header information. It is for pagination. The first page needs header, the rest doesn\'t need. (optional)
  returnHeader: true,
    // Search field. (optional)
  field: "field_example",
    // Search value. (optional)
  value: "value_example",
    // Field to sort. (optional)
  sortField: "sort_field_example",
    // Sort order. (optional)
  sortOrder: "NONE",
};

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

Parameters

Name	Type	Description	Notes
datasetName	[string]	Name of the dataset.	defaults to undefined
offset	[number]	The amount to offset the rows by for pagination.	(optional) defaults to undefined
limit	[number]	The max amount of rows to return for pagination.	(optional) defaults to undefined
returnHeader	[boolean]	If needs to return header information. It is for pagination. The first page needs header, the rest doesn't need.	(optional) defaults to undefined
field	[string]	Search field.	(optional) defaults to undefined
value	[string]	Search value.	(optional) defaults to undefined
sortField	[string]	Field to sort.	(optional) defaults to undefined
sortOrder	[**'NONE'	'ASC'	'DESC']Array<'NONE' \| 'ASC' \| 'DESC'>**

Return type

Ecosystemv3GetDatasetDataResponse

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]

ecosystemServiceGetDatasetDetail

Ecosystemv3GetDatasetDetailResponse ecosystemServiceGetDatasetDetail()

Example

import { createConfiguration, EcosystemServiceApi } from '';
import type { EcosystemServiceApiEcosystemServiceGetDatasetDetailRequest } from '';

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

const request: EcosystemServiceApiEcosystemServiceGetDatasetDetailRequest = {
    // Name of the dataset.
  datasetName: "dataset_name_example",
};

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

Parameters

Name	Type	Description	Notes
datasetName	[string]	Name of the dataset.	defaults to undefined

Return type

Ecosystemv3GetDatasetDetailResponse

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]

ecosystemServiceGetDatasets

Ecosystemv3GetDatasetsResponse ecosystemServiceGetDatasets()

Example

import { createConfiguration, EcosystemServiceApi } from '';
import type { EcosystemServiceApiEcosystemServiceGetDatasetsRequest } from '';

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

const request: EcosystemServiceApiEcosystemServiceGetDatasetsRequest = {
    // Return datasets created at this time or later (>=). (optional)
  filterStartTime: new Date('1970-01-01T00:00:00.00Z'),
    // Return datasets created before this time (<). (optional)
  filterEndTime: new Date('1970-01-01T00:00:00.00Z'),
    // The state filter groups commonly paired states. Only returns records that include the specified names. (optional)
  filterDatasetNames: [
    "filter.dataset_names_example",
  ],
    // The amount to offset the rows by for pagination. (optional)
  offset: 1,
    // The max amount of rows to return for pagination. (optional)
  limit: 1,
    // Computing the filter counts is relatively expensive, only compute when needed. (optional)
  includeFilterCounts: true,
};

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

Parameters

Name	Type	Description	Notes
filterStartTime	[Date]	Return datasets created at this time or later (>=).	(optional) defaults to undefined
filterEndTime	[Date]	Return datasets created before this time (<).	(optional) defaults to undefined
filterDatasetNames	Array<string>	The state filter groups commonly paired states. Only returns records that include the specified names.	(optional) defaults to undefined
offset	[number]	The amount to offset the rows by for pagination.	(optional) defaults to undefined
limit	[number]	The max amount of rows to return for pagination.	(optional) defaults to undefined
includeFilterCounts	[boolean]	Computing the filter counts is relatively expensive, only compute when needed.	(optional) defaults to undefined

Return type

Ecosystemv3GetDatasetsResponse

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]

ecosystemServiceGetPurgableRows

Ecosystemv3GetPurgableRowsResponse ecosystemServiceGetPurgableRows(ecosystemv3GetPurgableRowsRequest)

Example

import { createConfiguration, EcosystemServiceApi } from '';
import type { EcosystemServiceApiEcosystemServiceGetPurgableRowsRequest } from '';

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

const request: EcosystemServiceApiEcosystemServiceGetPurgableRowsRequest = {
  
  ecosystemv3GetPurgableRowsRequest: {
    hotRetentionPeriod: "hotRetentionPeriod_example",
    hotRetentionPeriodUnit: "hotRetentionPeriodUnit_example",
  },
};

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

Parameters

Name	Type	Description	Notes
ecosystemv3GetPurgableRowsRequest	Ecosystemv3GetPurgableRowsRequest

Return type

Ecosystemv3GetPurgableRowsResponse

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]

ecosystemServicePurgeData

Ecosystemv3PurgeDataResponse ecosystemServicePurgeData()

Example

import { createConfiguration, EcosystemServiceApi } from '';
import type { EcosystemServiceApiEcosystemServicePurgeDataRequest } from '';

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

const request: EcosystemServiceApiEcosystemServicePurgeDataRequest = {
    // Name of the datasets, required field. (optional)
  datasetNames: [
    "dataset_names_example",
  ],
};

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

Parameters

Name	Type	Description	Notes
datasetNames	Array<string>	Name of the datasets, required field.	(optional) defaults to undefined

Return type

Ecosystemv3PurgeDataResponse

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]

ecosystemServiceTestIntegration

Ecosystemv3TestIntegrationResponse ecosystemServiceTestIntegration(ecosystemv3TestIntegrationRequest)

Example

import { createConfiguration, EcosystemServiceApi } from '';
import type { EcosystemServiceApiEcosystemServiceTestIntegrationRequest } from '';

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

const request: EcosystemServiceApiEcosystemServiceTestIntegrationRequest = {
  
  ecosystemv3TestIntegrationRequest: {
    integrationType: "integrationType_example",
    options: {
      "key": "key_example",
    },
  },
};

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

Parameters

Name	Type	Description	Notes
ecosystemv3TestIntegrationRequest	Ecosystemv3TestIntegrationRequest

Return type

Ecosystemv3TestIntegrationResponse

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

EcosystemServiceApi.md

Latest commit

History

EcosystemServiceApi.md

File metadata and controls

.EcosystemServiceApi

ecosystemServiceCreateDataset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ecosystemServiceDataInsert

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ecosystemServiceDeleteDatasets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ecosystemServiceGetDatasetData

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ecosystemServiceGetDatasetDetail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ecosystemServiceGetDatasets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ecosystemServiceGetPurgableRows

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ecosystemServicePurgeData

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ecosystemServiceTestIntegration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details