Knolar Documentation

# CPH Developers Ingestion API

In case you want to use any API of this type. You must first check if you are correctly subscribed. This API allows user to introduce new data into different ingests through a REST API

# POST ​/ingests​/{ingest}​/data

This API allow developers to ingest data via HTTP calls. The ingest where the data must be ingested is set on the ingest path parameter while the data to be ingested will be the request body. Data validation will be performed through the data pipeline but not in the API call, so if the ingest exists and is active, the API will always return a 200 OK code. You can use the utilities provided at the CPH portal to check data ingestion errors.

# Request Example:

POST /ingest/ingesta-rt-vizz/data

{
    "D": "2020-09-15T11:11:11.111Z",
    "T": "01PHD.OSL101.PV",
    "V": 1234
}

# Parameters

  • Ingest: This field is required and its must be String. In this field you must put the alias of the ingest in which you want to apply the API.
  • EmptyObjectModel: This field is required. In it you must add in JSON format the data that you want to ingest in the ingestion indicated in the previous parameter with the alias. For this you must take into account the name of the variables and their format. In addition, you can add more than one row of data in the same query.

# Responses

  • 200: Means that the page has loaded correctly.
  • 400: Incorrect request or request
  • 403: Access to the page or resource you were trying to view is absolutely prohibited.
  • 404: The resource is not available on the server
  • 423: The resource you are accessing is blocked

← CPH Developers Consuption API →