Skip to content

EcosystemServiceApi.md

Latest commit

 

History

History
350 lines (211 loc) · 11.9 KB

EcosystemServiceApi.md

File metadata and controls

350 lines (211 loc) · 11.9 KB

EcosystemServiceApi

All URIs are relative to **

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

Summary: Create dataset Description: Save a definition in the database.

Example

 ecosystemServiceCreateDataset

Parameters

Name Type Description Notes
ecosystemv3CreateDatasetRequest Ecosystemv3CreateDatasetRequest

Return type

Ecosystemv3CreateDatasetResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

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

ecosystemServiceDataInsert

Summary: Data insert Description: Process Data received from webhook API and insert.

Example

 ecosystemServiceDataInsert dataset_name=value

Parameters

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

Return type

Ecosystemv3DataInsertResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

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

ecosystemServiceDeleteDatasets

Summary: Delete datasets Description: Delete an array of datasets.

Example

 ecosystemServiceDeleteDatasets  Specify as:  dataset_names=value1 dataset_names=value2 dataset_names=...

Parameters

Name Type Description Notes
datasetNames array[string] Name of the dataset, required field. [optional] [default to null]

Return type

Ecosystemv3DeleteDatasetsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

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

ecosystemServiceGetDatasetData

Summary: Get dataset data Description: Return data report for a given dataset.

Example

 ecosystemServiceGetDatasetData dataset_name=value  offset=value  limit=value  return_header=value  field=value  value=value  sort_field=value  sort_order=value

Parameters

Name Type Description Notes
datasetName string Name of the dataset. [default to null]
offset integer The amount to offset the rows by for pagination. [optional] [default to null]
limit integer The max amount of rows to return for pagination. [optional] [default to null]
returnHeader boolean If needs to return header information. It is for pagination. The first page needs header, the rest doesn't need. [optional] [default to null]
field string Search field. [optional] [default to null]
value string Search value. [optional] [default to null]
sortField string Field to sort. [optional] [default to null]
sortOrder string Sort order. [optional] [default to NONE]

Return type

Ecosystemv3GetDatasetDataResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

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

ecosystemServiceGetDatasetDetail

Summary: Get dataset detail Description: Return detail on a dataset definition.

Example

 ecosystemServiceGetDatasetDetail dataset_name=value

Parameters

Name Type Description Notes
datasetName string Name of the dataset. [default to null]

Return type

Ecosystemv3GetDatasetDetailResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

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

ecosystemServiceGetDatasets

Summary: Get datasets Description: Return dataset list that matches the specified filter.

Example

 ecosystemServiceGetDatasets  filter.start_time=value  filter.end_time=value  Specify as:  filter.dataset_names=value1 filter.dataset_names=value2 filter.dataset_names=...  offset=value  limit=value  include_filter_counts=value

Parameters

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

Return type

Ecosystemv3GetDatasetsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

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

ecosystemServiceGetPurgableRows

Summary: Get purgable rows Description: Check the number of rows that can be purged.

Example

 ecosystemServiceGetPurgableRows

Parameters

Name Type Description Notes
ecosystemv3GetPurgableRowsRequest Ecosystemv3GetPurgableRowsRequest

Return type

Ecosystemv3GetPurgableRowsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

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

ecosystemServicePurgeData

Summary: Purge data Description: Purge data.

Example

 ecosystemServicePurgeData  Specify as:  dataset_names=value1 dataset_names=value2 dataset_names=...

Parameters

Name Type Description Notes
datasetNames array[string] Name of the datasets, required field. [optional] [default to null]

Return type

Ecosystemv3PurgeDataResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

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

ecosystemServiceTestIntegration

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

Example

 ecosystemServiceTestIntegration

Parameters

Name Type Description Notes
ecosystemv3TestIntegrationRequest Ecosystemv3TestIntegrationRequest

Return type

Ecosystemv3TestIntegrationResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

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