Skip to content

Repository files navigation

edgraph-platform-client

All Api- v1.0

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v1.0
  • Package version: 0.0.52
  • Generator version: 7.23.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/EdGraph-OSS/python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/EdGraph-OSS/python-sdk.git)

Then import the package:

import edgraph_platform_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import edgraph_platform_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import edgraph_platform_client
from edgraph_platform_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dev.edgraph.com/tenant
# See configuration.py for a list of all supported configuration parameters.
configuration = edgraph_platform_client.Configuration(
    host = "https://api.dev.edgraph.com/tenant"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
async with edgraph_platform_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = edgraph_platform_client.APIClientsApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    identity_api_api_client_v1_create_api_client_request = edgraph_platform_client.IdentityApiApiClientV1CreateApiClientRequest() # IdentityApiApiClientV1CreateApiClientRequest |  (optional)

    try:
        # Creates a new OpenId API Client
        api_response = await api_instance.create_tenant_api_client_async(tenant_id, identity_api_api_client_v1_create_api_client_request=identity_api_api_client_v1_create_api_client_request)
        print("The response of APIClientsApi->create_tenant_api_client_async:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIClientsApi->create_tenant_api_client_async: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.dev.edgraph.com/tenant

Class Method HTTP request Description
APIClientsApi create_tenant_api_client_async POST /tenants/{tenantId}/apiclients Creates a new OpenId API Client
APIClientsApi delete_tenant_api_client_async DELETE /tenants/{tenantId}/apiclients/{clientId} Deletes an OpenId API Client
APIClientsApi get_all_tenant_api_clients_async GET /tenants/{tenantId}/apiclients Retrieves a list of OpenId API Clients associated to this tenant
APIClientsApi get_tenant_api_client_by_id_async GET /tenants/{tenantId}/apiclients/{clientId} Retrieves an OpenId API Client
APIClientsApi regenerate_tenant_api_client_secret_async PUT /tenants/{tenantId}/apiclients/{clientId}/regeneratesecret Regenerates an OpenId API Client's secret
APIClientsApi update_tenant_api_client_async PUT /tenants/{tenantId}/apiclients/{clientId} Updates an OpenId API Client
AnalyticsConnectorsApi create_connector POST /tenants/{tenantId}/analytics/connectors Creates a new connector
AnalyticsConnectorsApi delete_connector DELETE /tenants/{tenantId}/analytics/connectors/{connectorId} Deletes a connector by Id
AnalyticsConnectorsApi get_adls_gen2_connector_by_id GET /tenants/{tenantId}/analytics/connectors/{connectorId} Retrieves a connector profile by Id
AnalyticsConnectorsApi get_paginated_connectors GET /tenants/{tenantId}/analytics/connectors Retrieves paginated connectors
AnalyticsConnectorsApi update_connector PUT /tenants/{tenantId}/analytics/connectors/{connectorId} Updates a connector by Id
AnalyticsUserAuthorizationsApi get_paginated_user_authorizations GET /tenants/{tenantId}/analytics/userauthorizations Retrieves paginated user authorizations
AnalyticsUserAuthorizationsApi soft_delete_user_authorization DELETE /tenants/{tenantId}/analytics/userauthorizations/{userAuthorizationId} Soft Deletes a user authorization by Id
AnalyticsDataLakeApi get_paginated_lakehouse_records GET /tenants/{tenantId}/analytics/datalake/query Retrieves gold-tier data from the lakehouse
ApplicationsApi get_tenant_application_profile_by_id_async GET /tenants/{tenantId}/applications/{applicationId} Retrieves an application
ApplicationsApi get_tenant_applications_async GET /tenants/{tenantId}/applications Retrieves a list of applications associated to this tenant
ApplicationsSettingsApi get_client_settings_async GET /tenants/{tenantId}/clients/{clientId}/settings Retrieves a list of a Tenant's ClientSettings.
ApplicationsSettingsApi get_client_settings_types_async GET /tenants/{tenantId}/clients/{clientId}/settingstypes Retrieves a list of ClientSettingsTypes.
ApplicationsSettingsApi set_client_settings_async POST /tenants/{tenantId}/clients/{clientId}/settings Creates/updates a Tenant's ClientSettings.
ApplicationsTilesApi get_tenant_application_tiles_async GET /tenants/{tenantId}/applicationtiles Retrieves a list of applications licensed to the user that is currently logged in the context of this tenant
CacheApi refresh_user_profile_cache POST /me/cache/refresh Refreshes the user's profile cache.
CapacitiesApi assign_my_group_to_capacity POST /tenants/{tenantId}/analytics/capacities Assigns the specified group to the specified capacity.
CapacitiesApi get_all_analytics_power_bi_capacities GET /tenants/{tenantId}/analytics/capacities Retrieves a list of capacities in Power Bi that the user has access to.
CapacitiesApi resume_capacity_async POST /tenants/{tenantId}/analytics/capacities/resume Resumes currently suspended capacity
CapacitiesApi suspend_capacity_async POST /tenants/{tenantId}/analytics/capacities/suspend Suspends currently active capacity
CategoriesApi add_category_data_steward POST /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/categories/{categoryId}/stewards Adds a Data Steward to a Category.
CategoriesApi add_category_data_steward_bulk POST /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/categories/stewards Adds a Data Steward to Categories.
CategoriesApi certify_category POST /tenants/{tenantId}/statereporting/categories/{categoryId}/certify Certifies a Category.
CategoriesApi get_data_users_bulk GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/categories/datausers Get all Data Users
CategoriesApi get_state_reporting_categories GET /tenants/{tenantId}/statereporting/categories Retrieves a list of Categories.
CategoriesApi remove_category_data_owner DELETE /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/categories/{categoryId}/owner Removes the Data Owner of a Category.
CategoriesApi remove_category_data_steward DELETE /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/categories/{categoryId}/stewards/{email} Removes a Data Steward from a Category.
CategoriesApi request_category_certification_reminder POST /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/categories/{categoryId}/certificationreminder Requests a Certification Reminder to be sent.
CategoriesApi set_category_data_owner POST /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/categories/{categoryId}/owner Sets the Data Owner of a Category.
CategoriesApi set_category_data_owner_bulk POST /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/categories/owner Sets the Data Owner of Categories.
CategoriesApi upload_state_reporting_category POST /tenants/{tenantId}/statereporting/categories/upload Upload a Category via a JSON file.
CategoriesApi upload_state_reporting_periods_from_category_json POST /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/upload Upload a Category via a JSON file.
ChangeLogsApi get_all_changes_async GET /tenants/{tenantId}/changes
ClientsSecretsApi add_client_secret POST /tenants/{tenantId}/oneroster/instances/{instanceId}/clients/{clientId}/secrets Creates a new secret for an OpenId client
ClientsSecretsApi regenerate_one_roster_api_client_secret_async PUT /tenants/{tenantId}/oneroster/instances/{instanceId}/clients/{clientId}/regeneratesecret Regenerate Client Secret
CollectionsApi create_collection POST /tenants/{tenantId}/validations/collections Creates a Collection.
CollectionsApi create_container POST /tenants/{tenantId}/validations/collections/{collectionId}/containers Creates a Container.
CollectionsApi delete_collection DELETE /tenants/{tenantId}/validations/collections/{collectionId} Deletes a Collection.
CollectionsApi delete_container DELETE /tenants/{tenantId}/validations/collections/{collectionId}/containers/{containerId} Deletes a Container.
CollectionsApi get_collection_by_id GET /tenants/{tenantId}/validations/collections/{collectionId} Retrieves a Collection by ID.
CollectionsApi get_collection_json GET /tenants/{tenantId}/validations/collections/{collectionId}/export Retrieves the JSON representation of a Collection. Useful for exporting into other systems.
CollectionsApi get_collections GET /tenants/{tenantId}/validations/collections Retrieves a list of Collections.
CollectionsApi get_collections_tree GET /tenants/{tenantId}/validations/categories/tree Retrieves a list of Collections.
CollectionsApi get_container_by_id GET /tenants/{tenantId}/validations/collections/{collectionId}/containers/{containerId} Retrieves a Container by ID.
CollectionsApi get_containers GET /tenants/{tenantId}/validations/collections/{collectionId}/containers Retrieves a list of Containers.
CollectionsApi update_collection PUT /tenants/{tenantId}/validations/collections/{collectionId} Updates a Collection.
CollectionsApi update_container PUT /tenants/{tenantId}/validations/collections/{collectionId}/containers/{containerId} Updates a Container.
CollectionsApi upload_collection_json POST /tenants/{tenantId}/validations/collections/import Uploads a Collection JSON. Useful for importing from another system.
ConfigurationsApi create_analytics_configuration_async POST /tenants/{tenantId}/analytics/configurations Creates a new configuration.
ConfigurationsApi delete_analytics_configuration_async DELETE /tenants/{tenantId}/analytics/configurations/{configurationId} Deletes a configuration.
ConfigurationsApi get_all_analytics_configurations_async GET /tenants/{tenantId}/analytics/configurations Retrieves all configurations.
ConfigurationsApi get_analytics_configuration_by_id_async GET /tenants/{tenantId}/analytics/configurations/{configurationId} Retrieves a configuration by ID.
ConfigurationsApi get_analytics_configuration_by_tenant_id_async GET /tenants/{tenantId}/analytics/configurations/default Retrieves current default configuration.
ConfigurationsApi has_valid_analytics_configuration_async GET /tenants/{tenantId}/analytics/configurations/default/valid Verifies if current default configuration has required values for correct functionality.
ConfigurationsApi update_analytics_configuration_async PUT /tenants/{tenantId}/analytics/configurations/{configurationId} Updates a configuration.
ConfigurationsApi validate_aad_token_async POST /tenants/{tenantId}/analytics/configurations/azure/testconnection Verifies if AAD token generation is possible with user provided values.
ConnectionsApi connection_tested_response POST /tenants/{tenantId}/datasync/connections/testconnection Tests availability of provided connection metadata.
ConnectionsApi create_ed_fi_connection POST /tenants/{tenantId}/edfiadmin/connections Creates a new Ed-Fi Connection.
ConnectionsApi create_tenant_data_sync_connection POST /tenants/{tenantId}/datasync/connections Creates a new DataSync connection
ConnectionsApi delete_ed_fi_connection DELETE /tenants/{tenantId}/edfiadmin/connections/{connectionId} Deletes an Ed-Fi Connection.
ConnectionsApi delete_tenant_data_sync_connection DELETE /tenants/{tenantId}/datasync/connections/{connectionId} Delete a DataSync connection matching the primary key
ConnectionsApi get_all_tenant_data_sync_connections GET /tenants/{tenantId}/datasync/connections Retrieves a list of DataSync Connections
ConnectionsApi get_connection_by_id GET /tenants/{tenantId}/oneroster/connections/{connectionId} Retrieves the profile of a Connection.
ConnectionsApi get_ed_fi_connection_by_id GET /tenants/{tenantId}/edfiadmin/connections/{connectionId} Retrieves an Ed-Fi Connection by ID.
ConnectionsApi get_ed_fi_connections_async GET /tenants/{tenantId}/edfiadmin/connections Retrieves a list of Ed-Fi Connections.
ConnectionsApi get_ed_fi_ods_backup_codes_descriptors_async GET /tenants/{tenantId}/edfiadmin/connections/odsbackupcodes Retrieves a list of Ed-Fi ODS backup codes.
ConnectionsApi get_paged_connections GET /tenants/{tenantId}/oneroster/connections Retrieves a list of Connections.
ConnectionsApi get_tenant_data_sync_connection_profile_by_id GET /tenants/{tenantId}/datasync/connections/{connectionId} Retrieves a specific DataSync connection using its primary key
ConnectionsApi test_connection_details_async POST /tenants/{tenantId}/oneroster/connections/test Tests the connection by sending the connection details in the request payload
ConnectionsApi test_connection_details_by_id_async POST /tenants/{tenantId}/oneroster/connections/{connectionId}/test Tests the connection by obtaining the details by ID
ConnectionsApi update_ed_fi_connection PUT /tenants/{tenantId}/edfiadmin/connections/{connectionId} Updates an Ed-Fi Connection.
ConnectionsApi update_tenant_data_sync_connection PUT /tenants/{tenantId}/datasync/connections/{connectionId} Updates a DataSync connection matching the primary key
ConnectionsByTypeDEPRECATEDApi create_or_update_state_reporting_connection_by_type_v1 PUT /tenants/{tenantId}/statereporting/connectionsByType/{connectionType} Creates or Update a Connection by ConnectionType.
ConnectionsByTypeDEPRECATEDApi delete_state_reporting_by_type_connection_v1 DELETE /tenants/{tenantId}/statereporting/connectionsByType/{connectionType} Deletes a Connection by Type
ConnectionsByTypeDEPRECATEDApi get_state_reporting_connection_by_type_v1 GET /tenants/{tenantId}/statereporting/connectionsByType/{connectionType} Retrieves a Connection by Type.
ConnectionsDEPRECATEDApi create_state_reporting_connection_v1 POST /tenants/{tenantId}/statereporting/connections Creates a new Connection.
ConnectionsDEPRECATEDApi delete_state_reporting_connection_v1 DELETE /tenants/{tenantId}/statereporting/connections/{connectionId} Deletes a Connection.
ConnectionsDEPRECATEDApi find_state_reporting_connections_v1 GET /tenants/{tenantId}/statereporting/connections Retrieves a list of Connections.
ConnectionsDEPRECATEDApi get_state_reporting_connection_v1 GET /tenants/{tenantId}/statereporting/connections/{connectionId} Retrieves a Connection by ID.
ConnectionsDEPRECATEDApi test_state_reporting_connection_by_id_v1 POST /tenants/{tenantId}/statereporting/connections/{connectionId}/testconnection Tests a Connection by ID.
ConnectionsDEPRECATEDApi test_state_reporting_connection_by_type_v1 POST /tenants/{tenantId}/statereporting/connections/testconnection Tests a Connection by Type.
ConnectionsDEPRECATEDApi update_state_reporting_connection_v1 PUT /tenants/{tenantId}/statereporting/connections/{connectionId} Updates a Connection.
ConnectionsEdFiApi get_tenant_data_sync_connection_ed_fi_districts GET /tenants/{tenantId}/datasync/connections/{connectionId}/edfi/districts Retrieves a list of districts from an Ed-Fi API using the DataSync connection metadata
ConnectionsEdFiApi get_tenant_data_sync_connection_ed_fi_education_organization_id_descriptors GET /tenants/{tenantId}/datasync/connections/{connectionId}/edfi/educationorganizationidentificationsystemdescriptors Retrieves a list of education organization identification system descriptors from an Ed-Fi API using the DataSync connection metadata
ConnectionsEdFiApi get_tenant_data_sync_connection_ed_fi_school_years GET /tenants/{tenantId}/datasync/connections/{connectionId}/edfi/schoolyears Retrieves a list of school years from an Ed-Fi API using the DataSync connection metadata
ConnectionsEdFiApi get_tenant_data_sync_connection_ed_fi_staff_id_descriptors GET /tenants/{tenantId}/datasync/connections/{connectionId}/edfi/staffidentificationsystemdescriptors Retrieves a list of staff identification system descriptors from an Ed-Fi API using the DataSync connection metadata
ConnectionsEdFiApi get_tenant_data_sync_connection_ed_fi_student_id_descriptors GET /tenants/{tenantId}/datasync/connections/{connectionId}/edfi/studentidentificationsystemdescriptors Retrieves a list of student identification system descriptors from an Ed-Fi API using the DataSync connection metadata
ConnectionsEdFiApi get_tenant_data_sync_connection_ed_fi_term_descriptors GET /tenants/{tenantId}/datasync/connections/{connectionId}/edfi/termdescriptors Retrieves a list of term descriptors from an Ed-Fi API using the DataSync connection metadata
DomainsApi create_tenant_domain_async POST /tenants/{tenantId}/domains Creates a new domain
DomainsApi delete_tenant_domain_async DELETE /tenants/{tenantId}/domains/{domainName} Deletes a user
DomainsApi get_all_tenant_domains_async GET /tenants/{tenantId}/domains Retrieves a list of domains associated to this tenant
DomainsApi get_tenant_domain_profile_by_name_async GET /tenants/{tenantId}/domains/{domainName} Retrieves a domain
DomainsApi update_tenant_domain_async PUT /tenants/{tenantId}/domains/{domainName} Updates a domain
DomainsApi verify_tenant_domain_async PUT /tenants/{tenantId}/domains/{domainName}/verify Verify a tenant's domain
EdFiInstancesApi get_all_ed_fi_admin_connections_from_analytics_async GET /tenants/{tenantId}/analytics/edfiadmin/connections Retrieves a list of EdFi Admin connections
EdFiInstancesApi get_all_ed_fi_admin_instances_from_analytics_async GET /tenants/{tenantId}/analytics/edfiadmin/instances Retrieves a list of EdFi Admin instances
EdFiInstancesApi get_ed_fi_admin_instance_by_id_from_analytics_async GET /tenants/{tenantId}/analytics/edfiadmin/instances/{instanceId} Retrieves an Ed-Fi Admin instance by ID.
EdFiSyncApi create_ed_fi_sync POST /tenants/{tenantId}/jobs/edfisync Creates an Ed-Fi Sync Job for a given tenant
EdFiSyncApi execute_ed_fi_sync_job PUT /tenants/{tenantId}/jobs/edfisync/execute Executes an Ed-Fi Sync Job
EdFiSyncApi get_ed_fi_sync_data GET /tenants/{tenantId}/jobs/edfisync Retrieves Ed-Fi Sync Connection Data for a given tenant
EdFiSyncApi update_ed_fi_sync PUT /tenants/{tenantId}/jobs/edfisync Updates an Ed-Fi Sync for a given tenant
EnvironmentsApi create_environment POST /tenants/{tenantId}/validations/environments Creates an Environment.
EnvironmentsApi create_state_reporting_environment POST /tenants/{tenantId}/statereporting/environments Creates a new Environment.
EnvironmentsApi delete_environment DELETE /tenants/{tenantId}/validations/environments/{environmentId} Deletes an Environment.
EnvironmentsApi delete_state_reporting_environment DELETE /tenants/{tenantId}/statereporting/environments/{environmentId} Deletes an Environment.
EnvironmentsApi get_environment_by_id GET /tenants/{tenantId}/validations/environments/{environmentId} Retrieves an Environment by ID.
EnvironmentsApi get_environments GET /tenants/{tenantId}/validations/environments Retrieves a list of Environments.
EnvironmentsApi get_state_reporting_environment GET /tenants/{tenantId}/statereporting/environments/{environmentId} Retrieves an Environment by ID.
EnvironmentsApi search_state_reporting_environments GET /tenants/{tenantId}/statereporting/environments Retrieves a list of Environments.
EnvironmentsApi test_environment_connection POST /tenants/{tenantId}/validations/environments/testconnection Tests if the provided connection string can establish a valid connection.
EnvironmentsApi update_environment PUT /tenants/{tenantId}/validations/environments/{environmentId} Updates an Environment.
EnvironmentsApi update_state_reporting_environment PUT /tenants/{tenantId}/statereporting/environments/{environmentId} Updates an Environment.
EnvironmentsConnectionsApi create_state_reporting_connection POST /tenants/{tenantId}/statereporting/environments/{environmentId}/connections Creates a new Connection.
EnvironmentsConnectionsApi delete_state_reporting_connection DELETE /tenants/{tenantId}/statereporting/environments/{environmentId}/connections/{connectionId} Deletes a Connection.
EnvironmentsConnectionsApi find_state_reporting_connections GET /tenants/{tenantId}/statereporting/environments/{environmentId}/connections Retrieves a list of Connections.
EnvironmentsConnectionsApi get_state_reporting_connection GET /tenants/{tenantId}/statereporting/environments/{environmentId}/connections/{connectionId} Retrieves a Connection by ID.
EnvironmentsConnectionsApi test_state_reporting_connection_by_id POST /tenants/{tenantId}/statereporting/environments/{environmentId}/connections/{connectionId}/testconnection Tests a Connection by ID.
EnvironmentsConnectionsApi test_state_reporting_connection_by_type POST /tenants/{tenantId}/statereporting/environments/{environmentId}/connections/testconnection Tests a Connection by Type.
EnvironmentsConnectionsApi update_state_reporting_connection PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/connections/{connectionId} Updates a Connection.
EnvironmentsConnectionsByTypeApi create_or_update_state_reporting_connection_by_type PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/connectionsByType/{connectionType} Creates or Update a Connection by ConnectionType.
EnvironmentsConnectionsByTypeApi delete_state_reporting_by_type_connection DELETE /tenants/{tenantId}/statereporting/environments/{environmentId}/connectionsByType/{connectionType} Deletes a Connection by Type
EnvironmentsConnectionsByTypeApi get_state_reporting_connection_by_type GET /tenants/{tenantId}/statereporting/environments/{environmentId}/connectionsByType/{connectionType} Retrieves a Connection by Type.
EnvironmentsReportingPeriodsApi cancel_state_reporting_period_run DELETE /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/run Cancel the Validation Run of a Reporting Period.
EnvironmentsReportingPeriodsApi close_state_reporting_period PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/close Closes a Reporting Period.
EnvironmentsReportingPeriodsApi create_state_reporting_period POST /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods Creates a new Reporting Period.
EnvironmentsReportingPeriodsApi delete_state_reporting_period DELETE /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId} Deletes a Reporting Period.
EnvironmentsReportingPeriodsApi get_state_reporting_period GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId} Retrieves a Reporting Period by ID.
EnvironmentsReportingPeriodsApi get_state_reporting_period_certification_status GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/certificationstatus Retrieves the Certification Status of Reporting Period.
EnvironmentsReportingPeriodsApi get_state_reporting_period_validation_summary GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/validationsummary Retrieves the Validation Summary of Reporting Period.
EnvironmentsReportingPeriodsApi get_state_reporting_period_validation_summary_by_category GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/validationsummary/categories/{categoryId} Retrieves the Validation Summary of Reporting Period by Category.
EnvironmentsReportingPeriodsApi post_state_reporting_period POST /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/post Posts a Reporting Period.
EnvironmentsReportingPeriodsApi run_state_reporting_period POST /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/run Run a Reporting Period.
EnvironmentsReportingPeriodsApi search_state_reporting_periods GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods Retrieves a list of Reporting Periods.
EnvironmentsReportingPeriodsApi set_state_reporting_period_current_step PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/steps/current Sets the current step of a Reporting Period.
EnvironmentsReportingPeriodsApi set_state_reporting_period_step_status PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/steps/{stepNumber} Sets the status of a Reporting Period step.
EnvironmentsReportingPeriodsApi toggle_state_reporting_period_selected PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/toggle Toggles the Selected state of a Reporting Period.
EnvironmentsReportingPeriodsApi update_state_reporting_period PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId} Updates a Reporting Period.
EnvironmentsReportingPeriodsApi update_state_reporting_period_bulk PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods Updates Reporting Periods in bulk.
EnvironmentsReportingPeriodsCategoriesApi search_state_reporting_period_categories GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/categories Retrieves the Categories of a Reporting Period.
EnvironmentsReportingPeriodsCategoriesApi search_state_reporting_period_sub_categories GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/categories/{categoryId}/subcategories Retrieves the Sub-Categories of a Reporting Period.
EnvironmentsReportingPeriodsRulesRecordsApi delete_state_reporting_period_rules DELETE /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/rules Deletes the Rules of a Reporting Period.
EnvironmentsReportingPeriodsRulesRecordsApi search_state_reporting_period_records GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/records Retrieves the Invalid Records of all the Rules within a Reporting Period.
EnvironmentsReportingPeriodsRulesRecordsApi search_state_reporting_period_rule_records GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/rules/{ruleId}/records Retrieves the Invalid Records of a Rule.
EnvironmentsReportingPeriodsRulesRecordsApi set_state_reporting_period_rule_record_post_flag PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/rules/{ruleId}/records/{recordId}/excludefrompost Toggles the "ExcludeFromPost" flag of a Rule's Invalid Record.
EnvironmentsReportingPeriodsRulesRecordsApi set_state_reporting_period_rule_record_post_flag_bulk PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/rules/{ruleId}/records/excludefrompost Toggles the "ExcludeFromPost" flag of a Rule's Invalid Records in bulk.
EnvironmentsReportingPeriodsSubmissionsApi add_reporting_period_submission_metrics_bulk_v2 POST /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/metrics/bulk Adds Metrics to a Submission in bulk.
EnvironmentsReportingPeriodsSubmissionsApi add_reporting_period_submission_metrics_v2 POST /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/metrics Adds Metrics to a Submission.
EnvironmentsReportingPeriodsSubmissionsApi cancel_reporting_period_submission_v2 DELETE /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/cancel Cancels a Submission.
EnvironmentsReportingPeriodsSubmissionsApi get_reporting_period_submission_latest_v2 GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/submissions/latest Retrieves the latest Submission of a Reporting Period.
EnvironmentsReportingPeriodsSubmissionsApi get_reporting_period_submission_logs_v2 GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/logs Retrieves a list of Submission Logs of a Reporting Period.
EnvironmentsReportingPeriodsSubmissionsApi get_reporting_period_submission_metrics_v2 GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/metrics Retrieves the Metrics of a Submission.
EnvironmentsReportingPeriodsSubmissionsApi get_reporting_period_submission_v2 GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/submissions/{submissionId} Retrieves the Submission of a Reporting Period.
EnvironmentsReportingPeriodsSubmissionsApi get_state_reporting_period_submissions_v2 GET /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/submissions Retrieves a list of Submissions of a Reporting Period.
EnvironmentsReportingPeriodsSubmissionsApi set_reporting_period_submission_status_v2 PUT /tenants/{tenantId}/statereporting/environments/{environmentId}/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/status Sets the Status of a Submission.
EvaluationSettingsApi get_evaluation_setting GET /tenants/{tenantId}/evaluations/configuration Gets the Evaluation Settings for a given tenant
EvaluationSettingsApi set_evaluation_setting_application_setting POST /tenants/{tenantId}/evaluations/configuration/application Sets the Application Settings of an Evaluation for a given Tenant
EvaluationSettingsApi set_evaluation_setting_user_setting POST /tenants/{tenantId}/evaluations/configuration/users Sets the User Settings of an Evaluation for a given Tenant
EvaluationsApi create_evaluation POST /tenants/{tenantId}/evaluations Creates a new Evaluation for a given tenant
EvaluationsApi delete_evaluation DELETE /tenants/{tenantId}/evaluations/{evaluationId} Deletes an Evaluation for a given tenant
EvaluationsApi get_evaluation GET /tenants/{tenantId}/evaluations/{evaluationId} Get an Evaluation for a given tenant
EvaluationsApi get_evaluation_count GET /tenants/{tenantId}/evaluations/count
EvaluationsApi search_evaluation_appraisers GET /tenants/{tenantId}/evaluations/appraisers Searches the Appraisers associated with an Evaluation for a given Tenant.
EvaluationsApi search_evaluation_campuses GET /tenants/{tenantId}/evaluations/campuses Searches the Campuses associated with an Evaluation for a given Tenant.
EvaluationsApi search_evaluation_forms GET /tenants/{tenantId}/evaluations/forms Searches the Forms associated with an Evaluation for a given Tenant.
EvaluationsApi search_evaluation_staff GET /tenants/{tenantId}/evaluations/staff Searches the Staff associated with an Evaluation for a given Tenant.
EvaluationsApi search_evaluations GET /tenants/{tenantId}/evaluations Searches the Evaluations for a given tenant
EvaluationsApi update_evaluation PUT /tenants/{tenantId}/evaluations/{evaluationId} Updates an Evaluation for a given tenant
FormComponentsApi get_form_component GET /tenants/{tenantId}/forms/components/{formComponentId} Get a Form Component.
FormComponentsApi search_form_components GET /tenants/{tenantId}/forms/components Search Form Components
FormsApi create_form POST /tenants/{tenantId}/forms Creates a new Form for a given tenant
FormsApi create_full_form POST /tenants/{tenantId}/forms/full Fully creates a new Form for a given tenant (with Sections and Questions).
FormsApi delete_form DELETE /tenants/{tenantId}/forms/{formId} Deletes a Form.
FormsApi duplicate_form POST /tenants/{tenantId}/forms/{formId}/duplicate Duplicates all Form data for a given tenant (with Sections and Questions).
FormsApi get_form GET /tenants/{tenantId}/forms/{formId} Get Form.
FormsApi get_form_access GET /tenants/{tenantId}/forms/{formId}/access Get the Access Type for a Form.
FormsApi import_form POST /tenants/{tenantId}/forms/import Imports all form data for a given tenant.
FormsApi search_forms GET /tenants/{tenantId}/forms Search Forms
FormsApi set_form_access PUT /tenants/{tenantId}/forms/{formId}/access Sets the Access Type for a Form.
FormsApi update_form PUT /tenants/{tenantId}/forms/{formId} Updates a Form.
FormsApi update_full_form PUT /tenants/{tenantId}/forms/{formId}/full Fully updates a Form for a given tenant (with Sections and Questions).
GatewaysApi get_all_analytics_gateways_async GET /tenants/{tenantId}/analytics/gateways Retrieves a list of gateways in Power Bi that the user has access to.
GroupsApi add_users_to_group_async POST /tenants/{tenantId}/analytics/groups/{groupId}/users/bulk Adds users to group.
GroupsApi create_analytics_power_bi_group POST /tenants/{tenantId}/analytics/groups Creates a group.
GroupsApi delete_analytics_power_bi_group DELETE /tenants/{tenantId}/analytics/groups/{groupId} Deletes a group.
GroupsApi get_analytics_power_bi_group_users GET /tenants/{tenantId}/analytics/groups/{groupId}/users Retrieves all users for a specific group.
GroupsApi get_groups_async GET /tenants/{tenantId}/analytics/groups Retrieves a list of groups.
InstanceOnboardingStepsApi create_instance_onboarding_step_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/onboardingsteps Creates an Onboarding Step.
InstanceOnboardingStepsApi update_instance_onboarding_step_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/onboardingsteps/{stepNumber} Updates the status of an Onboarding Step.
InstanceResourcesCountApi get_all_instance_resources_count_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/applications/{applicationId}/apiclients/{apiClientId}/resourcescount Retrieves a paginated list of Instance Resources Count
InstanceResourcesCountApi get_all_instance_resources_count_json GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/applications/{applicationId}/apiclients/{apiClientId}/resourcescount/export Retrieves the JSON representation of Instance Resources Count. Useful for exporting into other systems.
InstancesApi add_related_instances POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/relatedinstances Add related instances to root instance by Id
InstancesApi add_school_year POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years Adds an ODS database to an Instance.
InstancesApi add_school_year_range POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/bulk Adds multiple ODS databases to an instance.
InstancesApi change_instance_database_tier_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/tiers Changes the selected tier of an ODS database.
InstancesApi clone_instance_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/clone Clones an instance.
InstancesApi create_instance POST /tenants/{tenantId}/oneroster/instances Creates a new Instance.
InstancesApi create_instance_async POST /tenants/{tenantId}/edfiadmin/instances Creates a new Instance.
InstancesApi delete_instance DELETE /tenants/{tenantId}/oneroster/instances/{instanceId} Deletes an Instance.
InstancesApi delete_instance_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId} Deletes an Instance.
InstancesApi delete_school_year_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year} Removes an ODS database from an Instance.
InstancesApi get_ed_fi_admin_instance_endpoints GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/endpoints Retrieves the Ed-Fi API endpoint URLs of an Instance.
InstancesApi get_ed_fi_admin_instance_year_endpoints GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/endpoints Retrieves the Ed-Fi API endpoint URLs of an Instance.
InstancesApi get_instance_by_id GET /tenants/{tenantId}/oneroster/instances/{instanceId} Retrieves an Instance by ID.
InstancesApi get_instance_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId} Retrieves an Instance by ID.
InstancesApi get_instance_csv_export GET /tenants/{tenantId}/oneroster/instances/{instanceId}/csv/export Retrieves an Instance by ID.
InstancesApi get_instance_csv_export_v2 GET /v2/tenants/{tenantId}/oneroster/instances/{instanceId}/csv/export Retrieves a ZIP bundle containing OneRoster Instance Database contents in CSV format
InstancesApi get_instance_endpoints GET /tenants/{tenantId}/oneroster/instances/{instanceId}/endpoints Retrieves the One Roster endpoint URLs of an Instance.
InstancesApi get_instances_async GET /tenants/{tenantId}/edfiadmin/instances Retrieves a list of Instances.
InstancesApi get_paged_instances GET /tenants/{tenantId}/oneroster/instances Retrieves a list of Instances.
InstancesApi get_tenant_instances_v2 GET /v2/tenants/{tenantId}/instances Get list of all instances for a tenant - V2
InstancesApi is_instance_custom_id_available GET /tenants/{tenantId}/oneroster/instances/isinstancecustomidavailable/{customId} Validate if instance is available
InstancesApi load_api_metadata POST /tenants/{tenantId}/edfiadmin/api-metadata Loads connection metadata.
InstancesApi reset_instance POST /tenants/{tenantId}/oneroster/instances/{instanceId}/resetinstance Resets an Instance.
InstancesApi reset_instance_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/resetinstance Resets an Instance.
InstancesApi reset_instance_cache_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/resetcache Resets the cache of an Instance and the specified ODS database.
InstancesApi reset_school_year_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/resetods Resets the ODS database with the specified school year.
InstancesApi set_instance_is_default PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/default Updates the isDefault property for an instance
InstancesApi test_connection_details_by_instance_id_async POST /tenants/{tenantId}/oneroster/instances/{instanceId}/test Tests the connection by obtaining the details by Instance ID
InstancesApi test_credentials_connection POST /tenants/{tenantId}/edfiadmin/testconnection Tests availability of provided connection metadata.
InstancesApi test_instance_connection POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/testconnection Tests the connection of the Instance.
InstancesApi test_instance_year_connection POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/testconnection Tests the connection of the Instance.
InstancesApi truncate_instance POST /tenants/{tenantId}/oneroster/instances/{instanceId}/truncate Truncates the Instance's database
InstancesApi update_instance PUT /tenants/{tenantId}/oneroster/instances/{instanceId} Updates an Instance.
InstancesApi update_instance_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId} Updates an Instance.
InstancesApi validate_custom_id_available GET /tenants/{tenantId}/edfiadmin/instances/validatecustomidavailable/{customId} Validate if instance is available
InstancesApplicationsApi create_application_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications Creates an Application.
InstancesApplicationsApi create_application_user_access_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/apiclients/{apiClientId}/access Creates a new application access.
InstancesApplicationsApi delete_application_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId} Deletes an Application.
InstancesApplicationsApi delete_application_user_access_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/apiclients/{apiClientId}/access/{accessId} Deletes an application user access.
InstancesApplicationsApi get_application_access_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/apiclients/{apiClientId}/access Retrieves a list of application accesses.
InstancesApplicationsApi get_application_access_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/apiclients/{apiClientId}/access/{accessId} Retrieves an application access by ID.
InstancesApplicationsApi get_application_api_client_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/apiclients/{apiClientId} Retrieves an API Client of an Application by ID.
InstancesApplicationsApi get_application_api_clients_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/apiclients Retrieves the API Clients of an Application.
InstancesApplicationsApi get_application_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId} Retrieves an Application by ID.
InstancesApplicationsApi get_applications_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications Retrieves a list of Applications.
InstancesApplicationsApi regenerate_api_client_secret_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/apiclients/{apiClientId}/regenerate Regenerates the secret of an API Client.
InstancesApplicationsApi regenerate_application_api_client_credentials PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/apiclients/regenerate Regenerates an application's API Client Credentials
InstancesApplicationsApi sync_application_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/sync Copies an Application from one instance to another/other instance(s)
InstancesApplicationsApi update_application_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId} Updates an Application.
InstancesApplicationsApi update_application_user_access_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/applications/{applicationId}/apiclients/{apiClientId}/access/{accessId} Updates a new application access.
InstancesAuthorizationStrategiesApi get_authorization_strategies_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/authorizationstrategies Retrieves a list of Authorization Strategies.
InstancesClaimSetsApi create_claim_set_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/claimsets Creates a ClaimSet.
InstancesClaimSetsApi delete_claim_set_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/claimsets/{claimSetId} Deletes a ClaimSet.
InstancesClaimSetsApi get_claim_set_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/claimsets/{claimSetId} Retrieves a ClaimSet by ID.
InstancesClaimSetsApi get_claim_sets_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/claimsets Retrieves a list of ClaimSets.
InstancesClaimSetsApi get_resource_claims_grid_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/claimsets/{claimSetId}/resourceclaims Retrieves a grid of Resource Claims.
InstancesClaimSetsApi sync_claim_set_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/claimsets/{claimSetId}/sync Copies a Claim Set from one instance to another/other instance(s)
InstancesClaimSetsApi update_claim_set_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/claimsets/{claimSetId} Updates a ClaimSet.
InstancesClientsApi create_client POST /tenants/{tenantId}/oneroster/instances/{instanceId}/clients Creates a new client
InstancesClientsApi delete_client DELETE /tenants/{tenantId}/oneroster/instances/{instanceId}/clients/{clientId} Deletes a client by Id
InstancesClientsApi get_client_by_id GET /tenants/{tenantId}/oneroster/instances/{instanceId}/clients/{clientId} Retrieves a client by Id
InstancesClientsApi get_paged_clients GET /tenants/{tenantId}/oneroster/instances/{instanceId}/clients Retrieves a list of clients for a given instance
InstancesClientsApi update_client PUT /tenants/{tenantId}/oneroster/instances/{instanceId}/clients/{clientId} Updates a client by Id
InstancesDescriptorMappingsApi create_descriptor_mapping POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptorMappings Creates a Descriptor Mapping.
InstancesDescriptorMappingsApi delete_descriptor_mapping DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptorMappings/{descriptorMappingId} Deletes a Descriptor Mapping.
InstancesDescriptorMappingsApi export_descriptor_mappings GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptorMappings/export Exports all Descriptor Mappings as a JSON file.
InstancesDescriptorMappingsApi get_descriptor_mapping_by_id GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptorMappings/{descriptorMappingId} Retrieves a Descriptor Mapping by ID.
InstancesDescriptorMappingsApi get_descriptor_mappings GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptorMappings Retrieves a list of Descriptors Mappings.
InstancesDescriptorMappingsApi import_descriptor_mappings POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptorMappings/import Imports Descriptor Mappings from a JSON file.
InstancesDescriptorMappingsApi update_descriptor_mapping PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptorMappings/{descriptorMappingId} Updates a Descriptor Mapping.
InstancesDescriptorsApi create_descriptor_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptors Creates a Descriptor.
InstancesDescriptorsApi delete_descriptor_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptors/{descriptorId} Deletes a Descriptor.
InstancesDescriptorsApi get_descriptor_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptors/{descriptorId} Retrieves a Descriptor by ID.
InstancesDescriptorsApi get_descriptor_namespaces_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/namespaces Retrieves a list of Descriptor Namespaces.
InstancesDescriptorsApi get_descriptors_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptors Retrieves a list of Descriptors.
InstancesDescriptorsApi update_descriptor_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/descriptors/{descriptorId} Updates a Descriptor.
InstancesEducationOrganizationsEducationServiceCentersApi create_education_service_center_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/educationservicecenters Creates an EducationServiceCenter.
InstancesEducationOrganizationsEducationServiceCentersApi delete_education_service_center_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/educationservicecenters/{educationServiceCenterId} Deletes an EducationServiceCenter.
InstancesEducationOrganizationsEducationServiceCentersApi get_education_service_center_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/educationservicecenters/{educationServiceCenterId} Retrieves an EducationServiceCenter by ID.
InstancesEducationOrganizationsEducationServiceCentersApi update_education_service_center_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/educationservicecenters/{educationServiceCenterId} Updates an EducationServiceCenter.
InstancesEducationOrganizationsLocalEducationAgenciesApi create_local_education_agency_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/localeducationagencies Creates a LocalEducationAgency.
InstancesEducationOrganizationsLocalEducationAgenciesApi delete_local_education_agency_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/localeducationagencies/{localEducationAgencyId} Deletes a LocalEducationAgency.
InstancesEducationOrganizationsLocalEducationAgenciesApi get_local_education_agency_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/localeducationagencies/{localEducationAgencyId} Retrieves a LocalEducationAgency by ID.
InstancesEducationOrganizationsLocalEducationAgenciesApi getl_local_education_agencies_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/localeducationagencies Retrieves a list of LocalEducationAgencies.
InstancesEducationOrganizationsLocalEducationAgenciesApi sync_local_education_agency_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/localeducationagencies/{localEducationAgencyId}/sync Copies a LocalEducationAgency from one instance to another/other instance(s).
InstancesEducationOrganizationsLocalEducationAgenciesApi update_local_education_agency_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/localeducationagencies/{localEducationAgencyId} Updates a LocalEducationAgency.
InstancesEducationOrganizationsStateEducationAgenciesApi create_state_education_agency_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/stateeducationagencies Creates a StateEducationAgency.
InstancesEducationOrganizationsStateEducationAgenciesApi delete_state_education_agency_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/stateeducationagencies/{stateEducationAgencyId} Deletes a StateEducationAgency.
InstancesEducationOrganizationsStateEducationAgenciesApi get_state_education_agency_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/stateeducationagencies/{stateEducationAgencyId} Retrieves a StateEducationAgency by ID.
InstancesEducationOrganizationsStateEducationAgenciesApi update_state_education_agency_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/stateeducationagencies/{stateEducationAgencyId} Updates a StateEducationAgency.
InstancesInstanceApplicationsApi create_instance_application POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications Creates an Instance Application
InstancesInstanceApplicationsApi delete_instance_application DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications/{applicationId} Deletes an Instance Application
InstancesInstanceApplicationsApi get_instance_application_by_id GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications/{applicationId} Retrieves an Instance Application by ID.
InstancesInstanceApplicationsApi get_instance_applications GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications Retrieves a paginated list of Instance applications
InstancesInstanceApplicationsApi update_instance_application PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications/{applicationId} Updates an Instance Application
InstancesInstanceApplicationsAPIClientsApi create_instance_api_client POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications/{applicationId}/apiclients Creates an Instance ApiClient
InstancesInstanceApplicationsAPIClientsApi delete_instance_api_client DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications/{applicationId}/apiclients/{apiClientId} Deletes an Instance ApiClient
InstancesInstanceApplicationsAPIClientsApi get_instance_api_client_by_id GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications/{applicationId}/apiclients/{apiClientId} Retrieves an Instance ApiClient by ID.
InstancesInstanceApplicationsAPIClientsApi get_instance_api_clients GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications/{applicationId}/apiclients Retrieves a paginated list of Instance ApiClients
InstancesInstanceApplicationsAPIClientsApi update_instance_api_client PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/instanceapplications/{applicationId}/apiclients/{apiClientId} Updates an Instance Application ApiClient
InstancesLogsApi get_instance_http_logs GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/years/{year}/logs/http Retrieves HTTP logs for a given instance
InstancesReportsApi generate_reports_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/reports/generate Queues a job to generate the report views in the ODS Database.
InstancesReportsApi get_reports_status_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/reports/status Retrieves the status of the report views in Instance.
InstancesReportsApi get_schools_by_type_report_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/reports/schoolsbytype/{localEducationAgencyId} Retrieves a "Schools By Type" report.
InstancesReportsApi get_student_economic_situation_report_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/reports/studentseconomicsituation/{localEducationAgencyId} Retrieves a "Students Economic Situation" report.
InstancesReportsApi get_student_enrollment_by_ethnicity_report GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/reports/studentenrollment/ethnicity/{localEducationAgencyId} Retrieves a "Student Enrollment By Ethnicity" report.
InstancesReportsApi get_student_enrollment_by_gender_report_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/reports/studentenrollment/gender/{localEducationAgencyId} Retrieves a "Student Enrollment By Gender" report.
InstancesReportsApi get_student_enrollment_by_race_report_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/reports/studentenrollment/race/{localEducationAgencyId} Retrieves a "Student Enrollment By Race" report.
InstancesReportsApi get_students_by_program_report_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/reports/studentsbyprogram/{localEducationAgencyId} Retrieves a "Students By Program" report.
InstancesReportsApi get_total_enrollments_report_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/reports/totalenrollments/{localEducationAgencyId} Retrieves a "Total Enrollments" report.
InstancesVendorsApi create_vendor_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/vendors Creates a new Vendor.
InstancesVendorsApi delete_vendor_async DELETE /tenants/{tenantId}/edfiadmin/instances/{instanceId}/vendors/{vendorId} Deletes a Vendor.
InstancesVendorsApi get_vendor_by_id_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/vendors/{vendorId} Retrieves a Vendor by ID.
InstancesVendorsApi get_vendors_async GET /tenants/{tenantId}/edfiadmin/instances/{instanceId}/vendors Retrieves a list of Vendors.
InstancesVendorsApi sync_vendor_async POST /tenants/{tenantId}/edfiadmin/instances/{instanceId}/vendors/{vendorId}/sync Copies a Vendor from one instance to another/other instance(s).
InstancesVendorsApi update_vendor_async PUT /tenants/{tenantId}/edfiadmin/instances/{instanceId}/vendors/{vendorId} Updates a Vendor.
IntegrationProductsApi create_integration_product POST /integrations/products Creates an Integration Product.
IntegrationProductsApi delete_integration_product DELETE /integrations/products/{productId} Removes an Integration Product.
IntegrationProductsApi get_integration_product GET /integrations/products/{productId} Gets an Integration Product.
IntegrationProductsApi search_integration_products GET /integrations/products Search Integration Products.
IntegrationProductsApi update_integration_product PUT /integrations/products/{productId} Updates an Integration Product.
IntegrationTypesApi create_integration_type POST /integrations/types Creates an Integration Type.
IntegrationTypesApi delete_integration_type DELETE /integrations/types/{typeId} Removes an Integration Type.
IntegrationTypesApi get_integration_type GET /integrations/types/{typeId} Gets an Integration Type.
IntegrationTypesApi search_integration_types GET /integrations/types Search Integration Types.
IntegrationTypesApi update_integration_type PUT /integrations/types/{typeId} Updates an Integration Type.
IntegrationVendorsApi create_integration_vendor POST /integrations/vendors Creates an Integration Vendor.
IntegrationVendorsApi delete_integration_vendor DELETE /integrations/vendors/{vendorId} Removes an Integration Vendor.
IntegrationVendorsApi get_integration_vendor GET /integrations/vendors/{vendorId} Gets an Integration Vendor.
IntegrationVendorsApi search_integration_vendors GET /integrations/vendors Search Integration Vendors.
IntegrationVendorsApi update_integration_vendor PUT /integrations/vendors/{vendorId} Updates an Integration Vendor.
InvitationsApi delete_tenant_invitation_async DELETE /tenants/{tenantId}/invitations/{invitationId} Deletes an invitation
InvitationsApi get_all_tenant_invitations_async GET /tenants/{tenantId}/invitations Retrieves a list of invitations associated to this tenant
InvitationsApi get_tenant_invitation_by_id_async GET /tenants/{tenantId}/invitations/{invitationId} Retrieves a specific invitation
InvitationsApi send_tenant_invitation_async POST /tenants/{tenantId}/invitations Creates and sends an invitation to a user
JobExecutionLogsApi get_all_tenant_data_sync_job_execution_logs GET /tenants/{tenantId}/datasync/jobs/{jobId}/executions/{jobExecutionId}/logs Retrieves a list of DataSync Job Execution Logs
JobExecutionsApi get_all_tenant_data_sync_job_executions GET /tenants/{tenantId}/datasync/jobs/{jobId}/executions Retrieves a list of DataSync Job Executions
JobExecutionsApi get_tenant_job_executions_by_job_id GET /tenants/{tenantId}/jobs/{jobId}/executions Gets job executions by a given job Id
JobTypesApi get_all_tenant_data_sync_job_types GET /tenants/{tenantId}/datasync/jobtypes Retrieves a list of DataSync job types
JobTypesApi get_tenant_data_sync_job_type_profile_by_id GET /tenants/{tenantId}/datasync/jobtypes/{jobTypeId} Retrieves a specific DataSync job type using its primary key
JobsApi activate_tenant_data_sync_job POST /tenants/{tenantId}/datasync/jobs/{jobId}/activate Activate a DataSync job matching the primary key
JobsApi cancel_job POST /tenants/{tenantId}/validations/jobs/{jobId}/cancel Requests a Job cancellation.
JobsApi cancel_tenant_data_sync_job POST /tenants/{tenantId}/datasync/jobs/{jobId}/cancel Cancel a DataSync job matching the primary key
JobsApi create_job POST /tenants/{tenantId}/validations/jobs Creates a Job.
JobsApi create_tenant_data_sync_job POST /tenants/{tenantId}/datasync/jobs Creates a new DataSync job
JobsApi deactivate_tenant_data_sync_job POST /tenants/{tenantId}/datasync/jobs/{jobId}/deactivate Deactivate a DataSync job matching the primary key
JobsApi delete_job DELETE /tenants/{tenantId}/validations/jobs/{jobId} Deletes a Job.
JobsApi delete_tenant_data_sync_job DELETE /tenants/{tenantId}/datasync/jobs/{jobId} Delete a DataSync job matching the primary key
JobsApi execute_job POST /tenants/{tenantId}/validations/jobs/{jobId}/execute Requests a Job execution.
JobsApi execute_tenant_data_sync_job POST /tenants/{tenantId}/datasync/jobs/{jobId}/execute Execute a DataSync job matching the primary key
JobsApi get_all_tenant_data_sync_jobs GET /tenants/{tenantId}/datasync/jobs Retrieves a list of DataSync Jobs
JobsApi get_job_by_id GET /tenants/{tenantId}/validations/jobs/{jobId} Retrieves a Job by ID.
JobsApi get_jobs GET /tenants/{tenantId}/validations/jobs Retrieves a list of Jobs.
JobsApi get_tenant_data_sync_job_profile_by_id GET /tenants/{tenantId}/datasync/jobs/{jobId} Retrieves a specific DataSync job using its primary key
JobsApi restart_job_schedule POST /tenants/{tenantId}/validations/jobs/{jobId}/restart Requests a Job schedule restart.
JobsApi update_job PUT /tenants/{tenantId}/validations/jobs/{jobId} Updates a Job.
JobsApi update_tenant_data_sync_job PUT /tenants/{tenantId}/datasync/jobs/{jobId} Updates a DataSync job matching the primary key
LogsApi get_logs GET /tenants/{tenantId}/validations/logs Retrieves a list of Logs.
MyExtensionsApi remove_user_extension DELETE /me/extensions/{code} Removes a user's profile extension.
MyExtensionsApi set_user_extension POST /me/extensions Creates or update a user's profile extension.
MyPreferencesApi get_user_preferences GET /me/preferences Retrieves the user's preferences.
MyPreferencesApi preference GET /me/preferences/{code} Retrieves a user's preference by code.
MyPreferencesApi update_user_preference_async POST /me/preferences Creates or update a user's preference.
MyProfileApi get_my_profile GET /v2/me Get the profile of the user that is currently logged in.
MyProfileApi get_my_tenant GET /v2/me/tenants/{tenantId} Get the tenant associated to the user.
MyProfileApi get_user_cache_async GET /me Retrieves the profile of the user that is currently logged in, including the user's preferences and its associated tenants
MyTenantsApi get_user_tenants GET /me/tenants Retrieves the Tenants of the User that is currently logged in.
MyTenantsApi search_my_licenses GET /v2/me/tenants/{tenantId}/licenses Search the user's licenses.
MyTenantsApi search_my_tenants GET /v2/me/tenants Searches tenants associated to the user.
ObservationSettingsApi add_available_persona POST /tenants/{tenantId}/observations/settings/personas Adds a persona for a given Tenant
ObservationSettingsApi get_application_settings GET /tenants/{tenantId}/observations/settings/application Gets the application settings for the tenant
ObservationSettingsApi get_paginated_forms GET /tenants/{tenantId}/observations/forms Get Paginated Forms
ObservationSettingsApi get_paginated_personas GET /tenants/{tenantId}/observations/settings/personas Gets available personas
ObservationSettingsApi get_paginated_staff_classifications GET /tenants/{tenantId}/observations/settings/available-staffclassifications Get Paginated Available StaffClassifications
ObservationSettingsApi get_staff_classifications_settings GET /tenants/{tenantId}/observations/settings/staffclassifications Gets the staffClassification settings for the tenant
ObservationSettingsApi get_tea_tenant_organizations GET /tenants/{tenantId}/observations/tenantorganizations Get TEA tenant organizations
ObservationSettingsApi set_application_settings POST /tenants/{tenantId}/observations/settings/application Sets the Application Settings of an Observation for a given Tenant
ObservationSettingsApi set_role_personas_settings POST /tenants/{tenantId}/observations/settings/rolepersonas Updates personas assigned to a role configuration of the tenants setting
ObservationSettingsApi verify_sys_admin_credentials GET /tenants/{tenantId}/observations/settings/verify-credentials Gets the staffClassification settings for the tenant
ObservationsApi create_observation POST /tenants/{tenantId}/observations Creates a new Observation for a given tenant
ObservationsApi create_observation_submission POST /tenants/{tenantId}/observations/{observationId}/available-forms/{formId}/submit Creates a submission for an available form referencing an existing observation
ObservationsApi delete_observation DELETE /tenants/{tenantId}/observations/{observationId} Deletes an Observation for a given tenant
ObservationsApi get_available_campuses_total_evaluees GET /tenants/{tenantId}/observations/total-evaluees Get the total number of evaluees across all available campuses
ObservationsApi get_dashboard GET /tenants/{tenantId}/observations/dashboards/{dashboardId} Get Observation Dashboard
ObservationsApi get_dashboard_preferences GET /tenants/{tenantId}/observations/dashboards/{dashboardId}/preferences Save user preferences for a given Dashboard
ObservationsApi get_evaluee_sections GET /tenants/{tenantId}/observations/evaluees/{evalueeId}/sections Gets the Sections of an evaluee.
ObservationsApi get_form_questions GET /tenants/{tenantId}/observations/available-forms/{formId}/sections/{sectionId}/questions Search Questions
ObservationsApi get_form_sections GET /tenants/{tenantId}/observations/available-forms/{formId}/sections Search Observation Form Sections
ObservationsApi get_observation_by_id GET /tenants/{tenantId}/observations/{observationId} Get an Observation for a given tenant
ObservationsApi get_observation_draft GET /tenants/{tenantId}/observations/{observationId}/available-forms/{formId}/draft Get an observation form's draft
ObservationsApi get_observation_submission GET /tenants/{tenantId}/observations/{observationId}/available-forms/{formId}/submission Gets a submission for a specific observation
ObservationsApi get_paginated_available_campuses GET /tenants/{tenantId}/observations/campuses Get Available Campuses
ObservationsApi get_paginated_available_forms GET /tenants/{tenantId}/observations/available-forms Get Paginated Available Forms
ObservationsApi get_paginated_campus_sections GET /tenants/{tenantId}/observations/campuses/{campusId}/sections Retrieves a list of Sections for a given available campus.
ObservationsApi get_paginated_campuses_with_evaluees GET /tenants/{tenantId}/observations/campuses-with-evaluees Get a paginated list of the available campuses that have evaluees, each with its complete list of evaluees.
ObservationsApi get_paginated_evaluees GET /tenants/{tenantId}/observations/evaluees Get paginated evaluees
ObservationsApi get_paginated_observations GET /tenants/{tenantId}/observations Get Paginated Observations for a given tenant
ObservationsApi get_submitted_observations_count GET /tenants/{tenantId}/submittedobservations Get submitted Observations count
ObservationsApi save_dashboard_preferences POST /tenants/{tenantId}/observations/dashboards/{dashboardId}/preferences Save user preferences for a given Dashboard
ObservationsApi search_paginated_evaluees GET /tenants/{tenantId}/observations/search/evaluees Search paginated evaluees
ObservationsApi update_observation PUT /tenants/{tenantId}/observations/{observationId} Update an Observation for a given tenant
ObservationsApi upsert_observation_draft POST /tenants/{tenantId}/observations/{observationId}/available-forms/{formId}/draft Creates a draft for an observation forms
ObservationsApi verify_dashboard_access POST /tenants/{tenantId}/observations/dashboards/access Verify user access to dashboards
OnboardingStepsApi create_onboarding_step POST /tenants/{tenantId}/onboardingsteps Creates an Onboarding Step.
OnboardingStepsApi get_onboarding_steps GET /tenants/{tenantId}/onboardingsteps Gets a list of Onboarding Steps.
OnboardingStepsApi update_onboarding_step PUT /tenants/{tenantId}/onboardingsteps/{stepNumber} Updates the status of an Onboarding Step.
OnboardingStepsConnectionsApi create_onboarding_step_connection POST /tenants/{tenantId}/onboardingsteps/{stepNumber}/connections Creates an Onboarding Step connection.
OnboardingStepsConnectionsApi get_onboarding_step_connection_by_id GET /tenants/{tenantId}/onboardingsteps/{stepNumber}/connections/{connectionId} Get an Onboarding Step connection by Id
OnboardingStepsConnectionsApi update_onboarding_step_connection PUT /tenants/{tenantId}/onboardingsteps/{stepNumber}/connections/{connectionId} Update an Onboarding Step connection by Id
OrganizationsApi create_organization_async POST /tenants/{tenantId}/organizations Creates an Organization.
OrganizationsApi delete_organization_async DELETE /tenants/{tenantId}/organizations/{organizationIdentifier} Deletes an Organization.
OrganizationsApi get_organization_by_id_async GET /tenants/{tenantId}/organizations/{organizationIdentifier} Retrieves an Organization by ID.
OrganizationsApi get_organizations_async GET /tenants/{tenantId}/organizations Retrieves a list of Organizations.
OrganizationsApi update_organization_async PUT /tenants/{tenantId}/organizations/{organizationIdentifier} Updates an Organization.
PartnershipsApi get_all_partnerships GET /tenants/{tenantId}/partnerships Retrieves a list of Partnerships.
PartnershipsApi get_partnership_by_id GET /tenants/{tenantId}/partnerships/{partnershipId} Retrieves a Partnership by ID.
ProvidersApi get_all_tenant_data_sync_providers GET /tenants/{tenantId}/datasync/providers Retrieves a list of DataSync providers
ProvidersApi get_tenant_data_sync_provider_profile_by_id GET /tenants/{tenantId}/datasync/providers/{providerId} Retrieves a specific DataSync provider using its primary key
QuestionsApi create_question POST /tenants/{tenantId}/forms/{formId}/sections/{sectionId}/questions Creates a new Question for a given section
QuestionsApi delete_question DELETE /tenants/{tenantId}/forms/{formId}/sections/{sectionId}/questions/{questionId} Deletes a Question.
QuestionsApi get_question GET /tenants/{tenantId}/forms/{formId}/sections/{sectionId}/questions/{questionId} Get Question.
QuestionsApi search_questions GET /tenants/{tenantId}/forms/{formId}/sections/{sectionId}/questions Search Questions
QuestionsApi update_question PUT /tenants/{tenantId}/forms/{formId}/sections/{sectionId}/questions/{questionId} Updates a Question.
RegistrationsApi get_onboarding_applications_async GET /public/applications Gets a list of applications available for registration/onboarding
RegistrationsApi get_registration_approval_status_async GET /registrations/{registrationId} Gets the approval status of a registration
RegistrationsApi submit_tenant_registration_async POST /registrations Submits a tenant's registration request
RegistrationsAzureMarketplaceApi submit_tenant_registration_azure_mona_async POST /registrations/azure/mona Submits a tenant's registration request received through Azure [M]arketplace [On]boarding [A]ccelerator (MONA)
ReportingPeriodsApi add_reporting_period_submission_metrics POST /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/metrics Adds Metrics to a Submission.
ReportingPeriodsApi add_reporting_period_submission_metrics_bulk POST /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/metrics/bulk Adds Metrics to a Submission in bulk.
ReportingPeriodsApi cancel_reporting_period_submission DELETE /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/cancel Cancels a Submission.
ReportingPeriodsApi close_reporting_period_async PUT /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/close Closes the state of a Reporting Period.
ReportingPeriodsApi delete_reporting_period_rules DELETE /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/rules Delete the Reporting Period and Associated Rules
ReportingPeriodsApi get_reporting_period_certification_status GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/certificationstatus Retrieves the Certification Status of a Reporting Period.
ReportingPeriodsApi get_reporting_period_records GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/records Retrieves the Invalid Records of all the Rules within a Reporting Period.
ReportingPeriodsApi get_reporting_period_rule_records GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/rules/{ruleId}/records Retrieves the Invalid Records of a Rule.
ReportingPeriodsApi get_reporting_period_submission GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/submissions/{submissionId} Retrieves the Submission of a Reporting Period.
ReportingPeriodsApi get_reporting_period_submission_latest GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/submissions/latest Retrieves the latest Submission of a Reporting Period.
ReportingPeriodsApi get_reporting_period_submission_logs GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/logs Retrieves a list of Submission Logs of a Reporting Period.
ReportingPeriodsApi get_reporting_period_submission_metrics GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/metrics Retrieves the Metrics of a Submission.
ReportingPeriodsApi get_reporting_period_submissions GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/submissions Retrieves a list of Submissions of a Reporting Period.
ReportingPeriodsApi get_reporting_period_validation_summary GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/validationsummary Retrieves the Validation Summary of a Reporting Period.
ReportingPeriodsApi get_reporting_period_validation_summary_by_category_id GET /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/validationsummary/categories/{categoryId} Retrieves the Validation Summary of a Reporting Period for a Category.
ReportingPeriodsApi get_reporting_periods GET /tenants/{tenantId}/statereporting/reportingperiods Retrieves a list of Reporting Periods.
ReportingPeriodsApi post_reporting_period POST /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/post Post a Reporting Period.
ReportingPeriodsApi run_reporting_period_validations POST /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/run Run Reporting Period Validations.
ReportingPeriodsApi set_reporting_period_rule_record_exclude_from_post_flag_bulk PUT /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/rules/{ruleId}/records/excludefrompost Toggles the "ExcludeFromPost" flag of a Rule's Invalid Records.
ReportingPeriodsApi set_reporting_period_submission_status PUT /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/submissions/{submissionId}/status Sets the Status of a Submission.
ReportingPeriodsApi toggle_reporting_period_selection PUT /tenants/{tenantId}/statereporting/reportingperiods/{reportingPeriodId}/toggle Toggles the Selected state of a Reporting Period.
ReportingPeriodsApi update_reporting_period_bulk PUT /tenants/{tenantId}/statereporting/reportingperiods Updates Reporting Periods in bulk.
ReportsApi create_report_async POST /tenants/{tenantId}/analytics/reports Creates a new report (Does not upload pbix file).
ReportsApi delete_report_async DELETE /tenants/{tenantId}/analytics/reports/{reportId} Removes a report.
ReportsApi download_report_async GET /tenants/{tenantId}/analytics/reports/download/{reportId}/{groupId} Retrieves the PBIX for any report in the list in order to download
ReportsApi get_all_tenant_analytics_workspace_reports_async GET /tenants/{tenantId}/analytics/reports Retrieves all reports.
ReportsApi get_report_by_id_async GET /tenants/{tenantId}/analytics/reports/{reportId} Retrieves a Report by ID.
ReportsApi sync_latest_version POST /tenants/{tenantId}/analytics/reports/synclatestversion Sync latest version
ReportsApi sync_workspaces_async POST /tenants/{tenantId}/analytics/reports/sync Triggers workspace, ODS and DW automation.
ReportsApi update_report_async PUT /tenants/{tenantId}/analytics/reports/{reportId} Updates a report.
RulesApi create_rule POST /tenants/{tenantId}/validations/rules Creates a Rule.
RulesApi delete_rule DELETE /tenants/{tenantId}/validations/rules/{ruleId} Deletes a Rule.
RulesApi get_rule_by_id GET /tenants/{tenantId}/validations/rules/{ruleId} Retrieves a Rule by ID.
RulesApi get_rules GET /tenants/{tenantId}/validations/rules Retrieves a list of Rules.
RulesApi update_rule PUT /tenants/{tenantId}/validations/rules/{ruleId} Updates a Rule.
SectionsApi create_section POST /tenants/{tenantId}/forms/{formId}/sections Creates a new Section for a given form
SectionsApi delete_section DELETE /tenants/{tenantId}/forms/{formId}/sections/{sectionId} Deletes a Section.
SectionsApi get_section GET /tenants/{tenantId}/forms/{formId}/sections/{sectionId} Get Section.
SectionsApi get_section_academic_subjects GET /tenants/{tenantId}/sections/academicSubjects Retrieves a list of Section Academic Subjects.
SectionsApi get_section_by_id GET /tenants/{tenantId}/sections/{sectionId} Retrieves a Section by ID.
SectionsApi get_section_courses GET /tenants/{tenantId}/sections/courses Retrieves a list of Section Courses.
SectionsApi get_section_grade_levels GET /tenants/{tenantId}/sections/gradeLevels Retrieves a list of Section Grade Levels.
SectionsApi get_section_schools GET /tenants/{tenantId}/sections/schools Retrieves a list of Section Schools.
SectionsApi get_section_sessions GET /tenants/{tenantId}/sections/sessions Retrieves a list of Section Sessions.
SectionsApi get_section_terms GET /tenants/{tenantId}/sections/terms Retrieves a list of Section Terms.
SectionsApi get_sections GET /tenants/{tenantId}/sections Retrieves a list of Sections.
SectionsApi search_sections GET /tenants/{tenantId}/forms/{formId}/sections Search Sections
SectionsApi update_section PUT /tenants/{tenantId}/forms/{formId}/sections/{sectionId} Updates a Section.
SettingsApi get_tenant_settings GET /tenants/{tenantId}/settings Retrieves a list of the Tenant's settings.
SettingsApi get_tenant_settings_by_code GET /tenants/{tenantId}/settings/{code} Retrieves a Tenant's settings by code.
SettingsApi set_tenant_settings POST /tenants/{tenantId}/settings/{code} Creates/updates a Tenant's settings.
StaffClassificationsApi create_staff_classification POST /tenants/{tenantId}/staffclassifications Creates a StaffClassification.
StaffClassificationsApi delete_staff_classification DELETE /tenants/{tenantId}/staffclassifications/{staffClassificationId} Deletes a StaffClassification.
StaffClassificationsApi get_staff_classification_by_id GET /tenants/{tenantId}/staffclassifications/{staffClassificationId} Retrieves a StaffClassification by ID.
StaffClassificationsApi get_staff_classifications GET /tenants/{tenantId}/staffclassifications Retrieves a list of StaffClassifications.
StaffClassificationsApi get_staff_classifications_namespaces GET /tenants/{tenantId}/staffclassifications/namespaces Retrieves a list of unique Staff Classification Namespaces.
StaffClassificationsApi update_staff_classification PUT /tenants/{tenantId}/staffclassifications/{staffClassificationId} Updates a StaffClassification.
StateReportingStepsApi get_steps GET /tenants/{tenantId}/statereporting/schoolYear/{schoolYear}/steps Get Steps Status for the tenant.
StateReportingStepsApi update_step POST /tenants/{tenantId}/statereporting/schoolYear/{schoolYear}/steps Update Steps Status for the tenant.
SubmissionsApi create_submission POST /tenants/{tenantId}/forms/{formId}/submissions Creates a new Submission for a given question
SubmissionsApi delete_submission DELETE /tenants/{tenantId}/forms/{formId}/submissions/{submissionId} Deletes a Submission.
SubmissionsApi export_submissions GET /tenants/{tenantId}/forms/{formId}/submissions/export Exports Submission data for a Form for a given tenant. (With JSON and CSV support)
SubmissionsApi get_submission GET /tenants/{tenantId}/forms/{formId}/submissions/{submissionId} Get Submission.
SubmissionsApi search_submissions GET /tenants/{tenantId}/forms/{formId}/submissions Search Submissions
SubmissionsApi update_submission PUT /tenants/{tenantId}/forms/{formId}/submissions/{submissionId} Updates a Submission.
SubscriptionsApi create_tenant_subscription_async POST /tenants/{tenantId}/subscriptions Creates a new subscription
SubscriptionsApi get_all_tenant_subscription_applications GET /tenants/{tenantId}/subscriptions/applications Retrieves a list of applications available for subscription.
SubscriptionsApi get_all_tenant_subscriptions_async GET /tenants/{tenantId}/subscriptions Retrieves a list of subscriptions associated to this tenant
SubscriptionsApi get_tenant_subscription_profile_by_id_async GET /tenants/{tenantId}/subscriptions/{subscriptionId} Retrieves a subscription
SubscriptionsApi update_tenant_subscription_async PUT /tenants/{tenantId}/subscriptions/{subscriptionId} Updates a subscription
TagsApi create_tag POST /tenants/{tenantId}/validations/tags Creates a Tag.
TagsApi delete_tag DELETE /tenants/{tenantId}/validations/tags/{tagId} Deletes a Tag.
TagsApi get_tag_by_id GET /tenants/{tenantId}/validations/tags/{tagId} Retrieves a Tag by ID.
TagsApi get_tags GET /tenants/{tenantId}/validations/tags Retrieves a list of Tags.
TagsApi update_tag PUT /tenants/{tenantId}/validations/tags/{tagId} Updates a Tag.
TenantBrandingApi update_tenant_branding PUT /tenants/{tenantId}/branding Updates the branding of tenant
TenantInstancesApi load_onboarding_step_ed_fi_api_metadata POST /tenants/{tenantId}/onboardingsteps/edfi-api-metadata Loads connection metadata.
TenantInstancesApi test_onboarding_step_connection POST /tenants/{tenantId}/onboardingsteps/testconnection Tests availability of provided connection metadata.
TenantIntegrationsApi add_tenant_integration POST /tenants/{tenantId}/integrations Creates an Integration for a tenant.
TenantIntegrationsApi delete_tenant_integration DELETE /tenants/{tenantId}/integrations/{id} Removes a tenant Integration.
TenantIntegrationsApi get_tenant_integration GET /tenants/{tenantId}/integrations/{id} Gets a tenant Integration.
TenantIntegrationsApi search_integrations GET /tenants/{tenantId}/integrations Search a Tenant's Integrations
TenantIntegrationsApi update_tenant_integration PUT /tenants/{tenantId}/integrations/{id} Updates a tenant Integration.
TenantJobsDSLApi create_dsl_job POST /tenants/{tenantId}/jobs/dsl Creates a DSL Sync Job for a given tenant
TenantJobsDSLApi execute_dsl_job PUT /tenants/{tenantId}/jobs/dsl/{jobId}/execute Executes a DSL Sync Job for a given tenant
TenantJobsDSLApi get_dsl_job GET /tenants/{tenantId}/jobs/dsl/{jobId} Retrieves a DSL jobs profile for a given tenant
TenantJobsDSLApi update_dsl_job PUT /tenants/{tenantId}/jobs/dsl/{jobId} Updates a DSL Sync Job for a given tenant
TenantJobsInstructionalInsightsApi create_instructional_insights_security_sync_job POST /tenants/{tenantId}/jobs/instructionalinsights Creates an Instructional Insights Security Sync Job for a given tenant
TenantJobsInstructionalInsightsApi execute_instructional_insights_security_sync_job POST /tenants/{tenantId}/jobs/instructionalinsights/execute Executes an Instructional Insights Security Sync Job
TenantJobsInstructionalInsightsApi get_instructional_insights_security_sync_job GET /tenants/{tenantId}/jobs/instructionalinsights Retrieves an Instructional Insights Security Sync Job for a given tenant
TenantJobsInstructionalInsightsApi search_instructional_insights_security_sync_job_execution_logs GET /tenants/{tenantId}/jobs/instructionalinsights/executions/{executionId}/logs Searches Instructional Insights Security Sync Job Execution Logs for a given tenant and execution
TenantJobsInstructionalInsightsApi search_instructional_insights_security_sync_job_executions GET /tenants/{tenantId}/jobs/instructionalinsights/executions Searches Instructional Insights Security Sync Job Executions for a given tenant
TenantJobsInstructionalInsightsApi update_instructional_insights_security_sync_job PUT /tenants/{tenantId}/jobs/instructionalinsights Updates an Instructional Insights Security Sync Job for a given tenant
TenantSecurityScoreSyncApi create_security_score_sync_job POST /tenants/{tenantId}/jobs/securityscore Creates an Security Score Sync Job for a given tenant
TenantSecurityScoreSyncApi execute_security_score_sync_job POST /tenants/{tenantId}/jobs/securityscore/execute Executes an Security Score Sync Job
TenantSecurityScoreSyncApi get_security_score_sync_job GET /tenants/{tenantId}/jobs/securityscore Retrieves a Security Score Sync Job for a given tenant
TenantSecurityScoreSyncApi get_security_score_sync_job_execution GET /tenants/{tenantId}/jobs/securityscore/{jobId}/executions/{jobExecutionId} Retrieves a Security Score Sync Job Execution for a given tenant
TenantSecurityScoreSyncApi update_security_score_sync_job PUT /tenants/{tenantId}/jobs/securityscore Updates a Security Score Sync for a given tenant
TenantSettingTypesApi get_all_setting_types GET /tenants/settings Retrieves all setting types
TenantsApi get_tenant_by_id_async GET /tenants/{tenantId} Retrieves the profile of a specific tenant
TenantsApi update_tenant_async PUT /tenants/{tenantId} Updates a tenant's profile
UsersApi activate_tenant_user_async PUT /tenants/{tenantId}/users/{userId}/activate Activates a user
UsersApi create_tenant_local_user_async POST /tenants/{tenantId}/users Creates a user in the local identity provider
UsersApi deactivate_tenant_user_async PUT /tenants/{tenantId}/users/{userId}/deactivate Deactivates a user
UsersApi delete_tenant_user_async DELETE /tenants/{tenantId}/users/{userId} Deletes a user
UsersApi get_all_form_users GET /tenants/{tenantId}/forms/users Get All Users
UsersApi get_all_tenant_users_async GET /tenants/{tenantId}/users Retrieves a list of users associated to this tenant
UsersApi get_all_users GET /tenants/{tenantId}/statereporting/users Get All Users
UsersApi get_tenant_user GET /v2/tenants/{tenantId}/users/{userId} Get User
UsersApi get_tenant_user_profile_by_id_async GET /tenants/{tenantId}/users/{userId} Retrieves a user
UsersApi get_user_tenant GET /v2/tenants/{tenantId}/users/{userId}/tenant Get User Tenant
UsersApi get_user_tenant_status_profile GET /tenants/{tenantId}/users/{email}/status Searches a user by email and retrieves it's minimal information and status.
UsersApi reset_mfa_status_async PUT /tenants/{tenantId}/users/{userId}/resetmfa Reset the MFA Status for the User
UsersApi reset_password_tenant_user_async PUT /tenants/{tenantId}/users/{userId}/resetpassword Resets a user's password
UsersApi search_tenant_users GET /v2/tenants/{tenantId}/users Search Users
UsersApi search_user_licenses GET /v2/tenants/{tenantId}/users/{userId}/licenses Search User Licenses
UsersApi search_user_licenses_bulk GET /v2/tenants/{tenantId}/users/licensesBulk Search user licenses in bulk.
UsersApi update_tenant_user_async PUT /tenants/{tenantId}/users/{userId} Creates or updates a user
UsersEducationOrganizationsApi add_user_education_organization POST /tenants/{tenantId}/users/{userId}/educationorganizations Adds an Education Organization to a user.
UsersEducationOrganizationsApi get_user_education_organizations GET /tenants/{tenantId}/users/{userId}/educationorganizations Gets the Education Organizations of a user.
UsersEducationOrganizationsApi remove_user_education_organization DELETE /tenants/{tenantId}/users/{userId}/educationorganizations/{educationOrganizationId} Removes an Education Organization from a user.
UsersEducationOrganizationsApi update_user_education_organization PUT /tenants/{tenantId}/users/{userId}/educationorganizations/{educationOrganizationId} Updates the Education Organization of a user.
UsersLicensesApi assign_license_tenant_user_async PUT /tenants/{tenantId}/users/{userId}/licenses/assign Assigns a license to a user in the context of a specific tenant
UsersLicensesApi assign_license_tenant_user_bulk_async PUT /tenants/{tenantId}/users/{userId}/licenses/assignbulk Assigns one or more licenses to a user in the context of a specific tenant
UsersLicensesApi get_all_tenant_user_application_licenses_async GET /tenants/{tenantId}/users/{userId}/licenses Retrieves a list of user licenses in the context of a specific tenant
UsersLicensesApi revoke_license_tenant_user_async PUT /tenants/{tenantId}/users/{userId}/licenses/revoke Revokes a license from a user in the context of a specific tenant
UsersLicensesApi revoke_license_tenant_user_bulk_async PUT /tenants/{tenantId}/users/{userId}/licenses/revokebulk Revokes one or more licenses from a user in the context of a specific tenant
UsersSEOAAsApi add_user_seoaa POST /v2/tenants/{tenantId}/users/{userId}/seoaas Add User SEOAAs
UsersSEOAAsApi delete_user_seoaa DELETE /v2/tenants/{tenantId}/users/{userId}/seoaas/{seoaaId} Delete User SEOAAs
UsersSEOAAsApi search_user_seoaa GET /v2/tenants/{tenantId}/users/{userId}/seoaas Search User SEOAAs
UsersSEOAAsApi update_user_seoaa PUT /v2/tenants/{tenantId}/users/{userId}/seoaas/{seoaaId} Update User SEOAAs
UsersSectionsApi add_user_section POST /tenants/{tenantId}/users/{userId}/sections Adds a Section to a user.
UsersSectionsApi add_user_section_bulk POST /tenants/{tenantId}/users/{userId}/sections/bulk Adds Sections to a user in bulk.
UsersSectionsApi get_user_sections GET /tenants/{tenantId}/users/{userId}/sections Gets the Sections of a user.
UsersSectionsApi remove_user_section DELETE /tenants/{tenantId}/users/{userId}/sections/{userSectionId} Removes a Section from a user.
UsersSectionsApi remove_user_section_bulk DELETE /tenants/{tenantId}/users/{userId}/sections/bulk Removes Sections from a user in bulk.
UsersSectionsApi update_user_section PUT /tenants/{tenantId}/users/{userId}/sections/{userSectionId} Updates the Section of a user.
UsersSectionsApi update_user_section_bulk PUT /tenants/{tenantId}/users/{userId}/sections/bulk Updates the Section of a user in bulk.
ValidationResultsAPIApi find_results_api_job_run_records_async GET /tenants/{tenantId}/validations/results-api/jobs/{jobId}/runs/{runId}/records Retrieves a list of Job Run Records from the Validation Results API.
ValidationResultsAPIApi find_results_api_job_run_rule_records_async GET /tenants/{tenantId}/validations/results-api/jobs/{jobId}/runs/{runId}/rules/{ruleId}/records Retrieves a list of Job Run Rule Records from the Validation Results API.
ValidationResultsAPIApi find_results_api_job_run_rules_async GET /tenants/{tenantId}/validations/results-api/jobs/{jobId}/runs/{runId}/rules Retrieves a list of Job Run Rules from the Validation Results API.
ValidationResultsAPIApi find_results_api_job_runs_async GET /tenants/{tenantId}/validations/results-api/jobs/{jobId}/runs Retrieves a list of Job Runs from the Validation Results API.
ValidationResultsAPIApi find_results_api_jobs_async GET /tenants/{tenantId}/validations/results-api/jobs Retrieves a list of Jobs from the Validation Results API.
ValidationResultsAPIApi find_results_api_rule_summaries GET /tenants/{tenantId}/validations/results-api/jobs/{jobId}/runs/{runId}/rules/summary Retrieves a list Rule Summaries from the Validation Results API.
ValidationResultsAPIApi find_results_api_rules_async GET /tenants/{tenantId}/validations/results-api/rules Retrieves a list of Rules from Validation Results API.
ValidationResultsAPIApi get_latest_job_run_async GET /tenants/{tenantId}/validations/results-api/jobs/{jobId}/runs/latest Retrieves the latest Job Run from the Validation Results API.
ValidationResultsAPIApi get_results_api_job_by_id GET /tenants/{tenantId}/validations/results-api/jobs/{jobId} Retrieves a Job by ID from the Validation Results API.
ValidationResultsAPIApi get_results_api_job_run_by_id_async GET /tenants/{tenantId}/validations/results-api/jobs/{jobId}/runs/{runId} Retrieves a Job Run by ID from the Validation Results API.
ValidationResultsAPIApi get_results_api_job_run_rule_by_id_async GET /tenants/{tenantId}/validations/results-api/jobs/{jobId}/runs/{runId}/rules/{ruleId} Retrieves a Job Run Rule by ID from the Validation Results API.
ValidationResultsAPIApi get_results_api_rule_by_id_async GET /tenants/{tenantId}/validations/results-api/rules/{ruleId} Retrieves a Rule by ID from the Validation Results API.
ValidationResultsAPIApi get_results_api_rule_summary GET /tenants/{tenantId}/validations/results-api/jobs/{jobId}/runs/{runId}/rules/{ruleId}/summary Get Rule Summary by ID from the Validation Results API.
WebhooksApi create_webhook_async POST /tenants/{tenantId}/webhooks Creates a new Webhook
WebhooksApi delete_webhook_async DELETE /tenants/{tenantId}/webhooks/{webhookId} Removes a webhook.
WebhooksApi get_all_webhook_subscriptions_async GET /tenants/{tenantId}/webhooks/events
WebhooksApi get_all_webhooks_async GET /tenants/{tenantId}/webhooks Retrieves a list of webhooks.
WebhooksApi get_webhook_by_id_async GET /tenants/{tenantId}/webhooks/{webhookId} Retrieves a webhook by ID.
WebhooksApi request_webhook_re_run POST /tenants/{tenantId}/webhooks/{webhookId}/dispatches/{dispatchId}/rerun
WebhooksApi update_webhook_async PUT /tenants/{tenantId}/webhooks/{webhookId} Updates a webhook
V1Api get_student_profile GET /tenants/{tenantId}/students/{id} Returns the admin profile for a single student.
V1Api get_students GET /tenants/{tenantId}/students Returns a paginated list of students for the given tenant.
V1Api release_user_lockout PUT /tenants/{tenantId}/users/{userId}/releaselockout
V1Api update_student_contacts PUT /tenants/{tenantId}/{studentId}/contacts Updates the contact overrides for a student.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth2

Author

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages