GraphQL API

Features

• We added the communicationsContact field on a Learner. This is the Contact that will receive all Learner’s communication related to their registration on an Event.

• The trainingTokenIssues.update mutation has a new expiresAt parameter which accepts a date in the format YYYY-MM-DD. Previously only the custom fields of the token issue could be updated with this mutation, now the expiry date can be too. This way of updating the expiry date has fewer limitations than the trainingTokenIssues.extend mutation, which only allows dates to be moved further into the future and additionally requires that the token issue have been created with an expiry date.

• (Preview) Calendar Sync
  • The enabled state of Calendar Maps can now be set through the API.
  • Added mutations to Create, Update & Remove a Calendar Integration.
• (Preview) Scheduler
  • It is now possible to filter Plan type queries by lifecycleState and solveStatus.

Deprecation notices

Being removed this week:

• Two LearningOutcomeMutations, recordDocumentDownload and recordUrlVisit. These Learning Path mutations have been replaced with LearnerMutations.recordResourceDownload and recordExternalContentAccessed.

• URLObjectives and DocumentObjectives and their outcomes. 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). These were used by an older version of the Administrate LMS which is being decommissioned.

• LMSConfiguration.loginViaIDP. All LMS portals should now log in via the Administrate identity service or configure a BrandIdentityProviderConfiguration.

• isContactCredentialsPasswordResetTokenValid, as all password resets should be handled by the identity provider, not the GraphQL API.

Later removals:

• 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 5, 2022.

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

• A validation to prevent archived token types being used in the trainingTokenIssues.create mutation will be introduced on January 17, 2022. If an archived training token type is used, an error will be returned. As this is a change in behavior, we are treating it as a deprecation of functionality.