Rate Limiting Change

From next week, we will be introducing rate limiting in our public GraphQL and v2 REST APIs.

We are introducing this change to:

• improve reliability
• enforce fair usage
• protect against malicious behaviour.

Any requests above the rate limit will be returned with a 429 response, and can be retried once the limit is not exceeded.
The rate limits will be introduced gradually to minimize impact on any clients currently using the APIs, and will be monitored any potential impacts. More details will follow in later release notes.

GraphQL API

Features

• (Preview) We added a new mutation duplicate to Plan, which allows you to create a new copy of any existing Plan.

• We have introduced 3 new portals mutations to create, update and delete Order Point of Sale fields for weblink portals:

  • createOrderPointOfSaleField
  • updateOrderPointOfSaleField
  • deleteOrderPointOfSaleFields

Fixes

• When using opportunities.applyPromotionCode or opportunities.applyGiftVouchers these mutations will now error if the Opportunity is priced in a Token Type.

• We have fixed an issue in the Opportunities update mutation, where updating attributes mapped to an Account or a Contact field would not cause the related Account or Contact to update as well.

Deprecation notices

• The name, description, and instructions fields for LmsContent have been marked deprecated and will be removed on October 5, 2022. These values are available in new fields displayName and htmlDescription mapped according to Content Type.

• 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.