OData dictionary

Overview

The attached excel workbook lists the common fields found in the Aptem OData feed. The data is stored across 32 tables listed below:

  1. AimWorkPlacements
  2. ApprenticeshipFinancialRecords
  3. AptemCognitiveAssessments
  4. AwardingBodyQualifications
  5. AwardingBodyQualificationsAssessmentHistory
  6. ComplianceDocuments
  7. ComponentDueDateChange
  8. CrmActivities
  9. DestinationProgressions
  10. EmployerGroups
  11. EPAErrors
  12. Episodes
  13. Groups
  14. IlrAims
  15. Jobs
  16. LearnerEmployment
  17. LearningPlanComponents
  18. LearningPlanEvidences
  19. MaximumProgrammeDataFields
  20. Messages
  21. Milestones
  22. Notes
  23. OnboardingResponses
  24. OrganizationContacts
  25. Organizations
  26. ReviewResponses
  27. Reviews
  28. Tasks
  29. Trackers
  30. Users
  31. UserGroups
  32. WithdrawalReasons

The exact list of fields will vary across customer systems depending on the use of bespoke data collection in, for example, reviews and onboarding processes.

To view the list of fields in your account, use the url:  https://your_tenant_name.aptem.co.uk/odata/1.0/$metadata

The attached excel file lists all common fields, and can be filtered by table, fieldname etc.

Example data/descriptions are also provided for some fields.

Was this article helpful?
2 out of 3 found this helpful