GraphQL API

Deprecation notices

• Two LearningOutcomeMutations, recordDocumentDownload and recordUrlVisit, are being removed on October 20, 2022. These Learning Path mutations have been replaced with LearnerMutations.recordResourceDownload and recordExternalContentAccessed.

• URLObjectives and DocumentObjectives and their outcomes are being removed from Learning Paths on October 20, 2022. These are Learning Path Objectives that were supported in an older version of the API, and were never configurable through GraphQL. There is very limited usage of these by Administrate Users.

• ContactCredentialsMutations (resetPassword, requestPasswordResetTokenForUsername, signIn and signInViaSingleSignOn) are being removed on October 21, 2022. These were used by an older version of the Administrate LMS which is being decommissioned.

• LMSConfiguration.loginViaIDP is being removed on October 21, 2022, as all LMS portals should now log in via the Administrate identity service or configure a BrandIdentityProviderConfiguration.

• isContactCredentialsPasswordResetTokenValid is being removed on October 21, 2022, as all password resets should be handled by the identity provider, not the GraphQL API.

• PostalAddress.provinceCode is being removed on November 10, 2022, it has been replaced with a new PostalAddress.province field. This fixes the previous antipattern and introduces the appropriate nested object.

• Deprecated includedInTrainingPasses on CatalogItems (CourseTemplate and LearningPath) in favor of includedInPassTypeIds for better API performance. It will be removed on November 11, 2022

• The fields instructions and description for the createLmsResource mutation and updateLmsResource mutation have been deprecated. These values can now be set using displayName and htmlDescription matching the LmsContent fields. These deprecated fields will be removed on December 12, 2022.

• The WebLinkPortal.updateAccountForExistingContacts field is being removed December 10, 2022. This setting had no effect.