OData dictionary

Overview

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

  1. AimWorkPlacements
  2. ApprenticeshipFinancialRecords
  3. AptemCognitiveAssessments
  4. AwardingBodyQualifications
  5. AwardingBodyQualificationsAssessmentHistory
  6. ComplianceDocuments
  7. ComponentDueDateChanges
  8. CrmActivities
  9. DestinationProgressions
  10. EmployerGroups
  11. EPAErrors
  12. Episodes
  13. Groups
  14. IlrAims
  15. Jobs
  16. LearnerEmployment
  17. LearningPlanComponents
  18. LearningPlanEvidences
  19. LearningPlanEvidenceWithActivityData
  20. MaximumProgrammeDataFields
  21. Messages
  22. Milestones
  23. Notes
  24. OnboardingResponses
  25. OrganizationContacts
  26. Organizations
  27. ReviewResponses
  28. Reviews
  29. Tasks
  30. Trackers
  31. UserGroups
  32. Users
  33. 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 this url format:  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