EdFi API Connection Test

#   _____           _              _____        __      
#  |  __ \         (_)            |_   _|      / _|     
#  | |__) |___  ___ _ _ __   ___    | |  _ __ | |_ ___  
#  |  _  // _ \/ __| | '_ \ / _ \   | | | '_ \|  _/ _ \ 
#  | | \ \  __/ (__| | |_) |  __/  _| |_| | | | || (_) |
#  |_|  \_\___|\___|_| .__/ \___| |_____|_| |_|_| \___/ 
#                    | |                                
#                    |_|

# Project Name - EDFI API CONNECTION TEST

# Recipe URL - https://app.lingk.io/a/10932/tf/18310

# Description - # This recipe reads data from a sample of EdFi API endpoints. 
                # Set up your EdFi connection in your environment before running. 
                # The Student API endpoint will be called when you run the recipe.

# Industry - Higher Ed
# Business Process - Graduate Reporting

# Systems - EdFi
# Connectors - EdFi
# Data Flows - Single Direction
# Connection Type - API

# Data Models
## Salesforce Models Used:
#1. Students

# Add Recipe notes / Change log information here!

#    _____                            _                 
#   / ____|                          | |                
#  | |     ___  _ __  _ __   ___  ___| |_ ___  _ __ ___ 
#  | |    / _ \| '_ \| '_ \ / _ \/ __| __/ _ \| '__/ __|
#  | |___| (_) | | | | | | |  __/ (__| || (_) | |  \__ \
#   \_____\___/|_| |_|_| |_|\___|\___|\__\___/|_|  |___/
#

# CONNECTORS specify what data will be pulled into the in-memory database during processing

connectors:

# Configure EdFi credentials in your Environment before running this recipe
  # EdFi Setup - https://help.lingk.io/en/articles/340-edfi-setup-guide

###### Start: Edfi Connectors #######

# Uncomment the following lines to have the pagination available through the request body
-
    name: edfiStudent
    type: edfiReader
    delayedRead: true
    properties:
      httpMethod: GET
      path: api/api/v2.0/2022/students
      version: v2.4.0
      # requestBody: {
      #     "paging": {
      #         "pageIndex": 1,
      #         "pageOffset": 100
      #     }
      #   }

###### End: Edfi Connectors #######

#    _____ _        _                            _       
#   / ____| |      | |                          | |      
#  | (___ | |_ __ _| |_ ___ _ __ ___   ___ _ __ | |_ ___ 
#   \___ \| __/ _` | __/ _ \ '_ ` _ \ / _ \ '_ \| __/ __|
#   ____) | || (_| | ||  __/ | | | | |  __/ | | | |_\__ \
#  |_____/ \__\__,_|\__\___|_| |_| |_|\___|_| |_|\__|___/

# STATEMENTS specify how the data should be processed while in memory

statements:

# Through the following statements, the connection can be tested printing the data retrieved from EdFi through API connection
  - statement: refresh edfiStudent
  - statement: printschema edfiStudent
  - statement: (data) => select * FROM edfiStudent
  - statement: print

# Add more statements to convert, join, aggregrate, transform, and integrate your data