Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The schedule api helps to run the processor group in Nifi at a scheduled time. The schedule time can be updated by changing the cron expression for scheduled_at property in the request body. The processor group processes the csv file at a scheduled time and ingests the data into the database.

V4-Data Emission API

This API are used for data migration. It will help to migrate the data in cQube 4.0 version.

Step 1: Open the specified request and add the details.

API Endpoint: <domain_name>/ingestion/v4-data-emission

HTTP Method: GET

Step 2: Click on the send button for the request and if the request is successful the user should see a response message. The files will be uploaded to the input folder created in the respective cloud storage.

National Programs API

This API accepts the event data in the zip file format and adds it to the emission folder in the respective cloud storage.

Step 1: Open the specified request and add the details.

API Endpoint: <domain_name>/ingestion/national_programs

HTTP Method: POST

Step 2: Build the request body with reference to YAML file. The request body for the above api is attached in Link for yaml: https://github.com/Sunbird-cQube/spec-ms/blob/dev/spec.yaml . Provide the valid input details for the Parameters shown below.

Step 3: Click on the send button for the request and if the request is successful the user should see a response message. The files will be uploaded to the emission folder created in the respective cloud storage.

The zip file will be extracted and will be read by the adaptors and then moved into the input folders.