Connect to Ellucian Ethos instance with an Ethos access code in your environment. Ellucian Ethos is a set of REST APIs for interfacing with Ellucian SIS and CRM products.

EthosReader Properties

  • endpoint (Env First): The route to the REST API resource.
  • apiKey (Env First): The API key for your Ethos application.
  • path (Inline Only): The root url of the REST API.
  • dataModelVersion (Inline Only): The Ethos Data Model Version for the API request.
Example with Environment Credentials
-
    name: myConnectorName
    type: EthosReader
    properties:
      path:  https://... 
      dataModelVersion:  8 
    #schemaRef: schemaName # optional from "schemas:"
Example with Inline Credentials
-
    name: myConnectorName
    type: EthosReader
    properties:
      endpoint: /api/courses 
      apiKey: xxxx 
      path: https://... 
      dataModelVersion: 8 
    #schemaRef: schemaName # optional from "schemas:"

EthosWriter Properties

  • endpoint (Env First): The route to the REST API resource.
  • apiKey (Env First): The API key for your Ethos application.
  • path (Inline Only): The root url of the REST API.
  • dataModelVersion (Inline Only): The Ethos Data Model Version for the API request.
Example with Environment Credentials
-
    name: myConnectorName
    type: EthosWriter
    properties:
      path:  https://... 
      dataModelVersion:  8 

Example with Inline Credentials
-
    name: myConnectorName
    type: EthosWriter
    properties:
      endpoint:  /api/courses 
      apiKey:  xxxx 
      path:  https://... 
      dataModelVersion:  8